Download the PHP package zorn-v/urfa-client without Composer

On this page you can find all versions of the php package zorn-v/urfa-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of zorn-v/urfa-client

Informations about the package urfa-client

URFAClient

Универсальный PHP клиент для биллинговой системы NetUp UTM5 на основе api.xml

Установка

composer require zorn-v/urfa-client

Зависимости

Описание параметров

option default описание
login* — логин администратора или пользователя
password* — пароль администратора или пользователя соответственно
host* — адрес ядра UTM5
port 11758 порт ядра UTM5
timeout 30 время ожидания ответа от сервера
protocol auto ssl или tls (доступно с версии UTM-5.3-002-update16) или auto (доступно с версии UTM-5.3-005-update2, работает с OpenSSL 1.1)
admin TRUE указываем какой пользователь подключается, если TRUE предоставляет сертификат admin.crt для соединения, используется только для протокола ssl
api api_53-005.xml путь до файла api.xml
log FALSE сборщик логов, если TRUE, перехватывает исключения UrfaClientException
debug FALSE логирование отсылаемых и принимаемых пакетов

Пример

Рассмотрим пример использования библиотеки на примере функции rpcf_add_user_new, у нас есть XML описание:

И так, нам нужно описать входные параметры (элемент input) в ассоциативный массив. Если в элементе присутствует атрибут default, параметр считается необязательным.

Получаем полное описание параметров функции rpcf_add_user_new из api.xml:

На основе данного описания оставляем необходимые нам параметры, порядок параметров неважен.

Как было замечено, разработчики UTM5 не пришли к единому формату описания функций. Отсюда возник вопрос, какое имя давать параметру for для элементов массива? Поэтому было принято решение, в качестве имени использовать имя предыдущего атрибута из api.xml (в некоторых случаях с этим будут проблемы). В нашем случае будет так:

Если попадется элемент error будет выброшено исключение XML Described error:, а далее атрибуты ошибки.

C условиями if все просто, если истина, то заходим внутрь. И содержание обрабатывается, как описано выше.

В итоге, получаем минимальный набор параметров для создания пользователя:

В переменную $result попадут данные которые описаны в элементе output.

debug опция

Если хотите видеть что конкретно (в байтах) отсылается/принимается, можно поступить например так

Возможные проблемы

История изменений

CHANGELOG.md

All versions of urfa-client with dependencies

PHP Build Version
Package Version
Requires php Version >=7.1
ext-openssl Version *
ext-simplexml Version *
ext-filter Version *
ext-hash Version *
psr/log Version ^1.1
psr/cache Version ^1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package zorn-v/urfa-client contains the following files

Loading the files please wait ....