Скачать broadworks ocip - Скачать исходный код broadworks ocip

broadworks ocip

Другие категории

1.0.0

Скачать

Broadworks OCI-P PHP Framework

BTC: BC1Q9N0V6L3CH2PJFHLD4RJ9Y2P3M9WL9XPMZNLX

Функции

Мыло или TCP -потоковой транспорт

Теперь можно выбрать между SOAP через HTTPS или TCP -потоком (по умолчанию) для взаимодействия с API Broadworks. Основные тесты предлагают 15/запросы/секунд с SOAP и 150/запросами/второй для потока TCP. UserGetRequest17sp4 был использован для теста.

Управление сеансом

Сеансы могут быть экспортированы из и в клиент, это было добавлено, чтобы позволить Broadworks OCI-P сценариям, запускаемым методами, такими как Cronjobs для выполнения с использованием данных внешнего сеанса. Сессии порта - это безопасный способ выполнения команд, поскольку пользователь, который запросил его, по мере того, как пароль не хранится, файлы cookie/sessionID используются для аутентификации.

IDE Автозаполнение

Все элементы структуры были построены с учетом автоматического заполнения IDE, поэтому нет необходимости запоминать детали типа данных, ниже приведен пример отключения CallForwardingalways для всех пользователей в группе.

Интерактивная консоль

Встроенный взаимодействующий CLI, который требует нулевых знаний о программировании. Пользователь перемещается по схеме так же, как и каталоги и файлы в файловой системе Linux. Команды могут быть выполнены в CLI с результатами, напечатанными на экране. Tab AutoCompletion Works - (в последнем выпуске разбито)

Экспорт данных

Объекты поддерживают сериализацию, чтобы разрешить сохранение сообщений в формате простого текста, которые могут быть неразрешены обратно в типы данных.

Дружелюбная альтернатива написанию XML напрямую
Классы PHP, сгенерированные из файлов схемы XSD
Поддержка транспорта мыла, хорошая для ненадежных соединений
Транспортная поддержка TCP обеспечивает минимальные накладные расходы и максимальная пропускная способность
Простыетипы могут содержать ограничения объектов для проверки ввода, таких как максимальная длина MinLength
Автоматическое отображение типов данных (usergetResponse17sp4 -> userAddRequest17sp4)
Кровь, пот и слезы из бесчисленных часов моего времени, когда я должен был быть в пабе

Установка

Используйте это для главной ветви

 $ composer require lukebeer/broadworks-ocip

Используйте это для филиала разработки с непроверенными исправлениями

 $ composer require lukebeer/broadworks-ocip:development

Основное использование

 <?php
require_once ' vendor/autoload.php ' ;

// Use the ComplexType required for this example.
use Broadworks_OCIP  api  Rel_17_sp4_1_197_OCISchemaAS  OCISchemaUser  UserServiceGetAssignmentListRequest ;

// Create a Client and login. CoreFactory also has getSOAPClient()
$ client = BroadworksOCIP Factory:: getTCPClient ( ' ocip.example.com ' );
$ client -> login ( ' user ' , ' pass ' );

// Generate a request, send and assign the response to $response
$ request  = new UserServiceGetAssignmentListRequest ( ' [email protected] ' );
$ response = $ request -> get ( $ client );

// This response type returns a TableType object, getValue() renders a table.
echo $ response -> getServicePacksAssignmentTable ()-> getValue ();
?>

/* Spits out:
+--------------------------------------------------+----------+
| Service Name                                     | Assigned |
+--------------------------------------------------+----------+
| Anonymous Call Rejection                         | true     |
| Authentication                                   | true     |
| Call Forwarding Always                           | true     |
| Call Forwarding Busy                             | true     |
| Call Forwarding No Answer                        | true     |
| Call Notify                                      | false    |
| Calling Line ID Delivery Blocking                | true     |
| CommPilot Express                                | true     |
| CommPilot Call Manager                           | true     |
| Do Not Disturb                                   | true     |
| Intercept User                                   | true     |
| Last Number Redial                               | true     |
| Sequential Ring                                  | true     |
+--------------------------------------------------+----------+
*/

Основные типы ответов

Комплекстип

ComplexTypes, такие как userGetRequest17sp4, являются типами, которые могут содержать смесь типов элементов, включая комплексные типы. Думайте о них как о XML с вложенными детьми.

Если один из элементов, который должен быть установлен, является сложнымтипом, комплексный тип нуждается в создании, прежде чем быть установленным в родительском объекте. Например, StreetAddress - это комплексный тип:

 <?php

$ address = new StreetAddress ();
$ address -> setAddressLine1 ( ' 1337 Street ' );
$ address -> setCountry ( ' England ' );

$ request = new UserAddRequest17sp4 ();
$ request -> setStreetAddress ( $ address );

ComplexType StreetAddress структура

Таблетка

Таблетки используются для обработки окутанных данных. Один размерный массив передается для заголовков столбцов, а данные устанавливаются с помощью AddRow или AddRows с отдельными или многометровыми массивами.

Можно отобразить симпатичную таблицу ASCII с echo $table->getValue() с данными, а также поиск с $table->findRow('something')

Если требуется только один столбец, метод $table->getColumn($id) вернет конкретный столбец данных из всех строк в наборе данных. Одно значение можно использовать для ключей, а другое для значений.

 <?php
$ data = $ table -> getColummn ( 0 , 3 );
$ newTable = new TableType ([ ' User Id ' , ' Phone Number ' );
$ newTable -> addRows ( $ data );
echo $ newTable -> getValue ();

Возвращает:

 +------------------------+---------------+
| User Id                | Phone Number  |
+------------------------+---------------+
| [email protected]     | 01234123456   |
| [email protected]     | 01234123456   |
| [email protected]     | 01234123456   |
| [email protected]     | 01234123456   |
| [email protected]     | 01234123456   |
| [email protected]     | 01234123456   |
+------------------------+---------------+

Внося

Отчеты об ошибках и запросы функций

Пожалуйста, используйте трекер выпуска, чтобы сообщить о любых ошибках или запросах функций файла.

Развитие

PRS приветствуются. Чтобы начать развиваться, сделайте это:

$ curl -X POST -u " GITHUB_USERNAME:GITHUB_PASSWORD "  https://api.github.com/repos/lukebeer/broadworks-ocip/forks && history -c
$ git clone github:GITHUB_USERNAME/broadworks-ocip &&
$ cd broadworks-ocip

Планировка проекта

 Builder
  Builder.php                # Takes a ComplexType and converts to XML or XML string then wraps it in an envelope ready for shipping.
  Restrictions
   Enumeration.php           # Defines a list of acceptable values.
   Length.php                # Specifies the exact number of characters or list items allowed. Must be equal to or greater than zero.
   MaxExclusive.php          # Specifies the upper bounds for numeric values (the value must be less than this value).
   MaxInclusive.php          # Specifies the upper bounds for numeric values (the value must be less than or equal to this value).
   MaxLength.php             # Specifies the maximum number of characters or list items allowed. Must be equal to or greater than zero.
   MinExclusive.php          # Specifies the lower bounds for numeric values (the value must be greater than this value).
   MinInclusive.php          # Specifies the lower bounds for numeric values (the value must be greater than or equal to this value).
   MinLength.php             # Specifies the minimum number of characters or list items allowed. Must be equal to or greater than zero.
   Pattern.php               # Defines the exact sequence of characters that are acceptable.
   Restriction.php           # Abstract base class all restrictions must extend.
   RestrictionInterface.php  # Interface all Restrictins must implement.
  Types
   ComplexInterface.php      # Interface all ComplexTypes must implement.
   ComplexType.php           # Defines a complex type element.
   PrimitiveType.php         # Primitive type such as bool/int/string.
   SimpleContent.php         # Contains extensions or restrictions on a text-only complex type or on a simple type as content and contains no elements.
   SimpleInterface.php       # Interface all SimpleTypes must implement.
   SimpleType.php            # Defines a simple type and specifies the constraints and information about the values of attributes or text-only elements.
   TableType.php             # Used for OCITable responses only, never in requests.
   TypeCheck.php             # Not implemented yet.
   TypeMap.php               # Converts xs types to PHP types.
   TypeTrait.php             # Common trait all types have.
 Client
  Client.php                 # Main controller for the whole framework exposing methods for requests and responses.
  Transport
   SOAPTransport.php         # Communicates with Broadworks via http(s), this is the slowest but most robust transport type.
   TCPTransport.php          # Communicates with Broadworks via a TCPStream on port 2208, this is the fastest transport type.
   TransportInterface.php    # Interface all Transport types must implement.
 Console
  Console.php                # Generates an array of commands for the interactive console.
 Logging
  ErrorControl.php           # Crappy logging object, needs nuking and starting again.
 Output
  ConsoleOutput.php          # Output type for the interactive console.
  JSONOutput.php             # Generates and echos JSON.
  OutputInterface.php        # Output interface all Outputs must implement.
 Response
  Response.php               # Takes XML input and returns response object specified or false if error.
  ResponseOutput.php         # Convenience class for selecting response output format.
 Serializer
  SerializerInterface.php    # Interface all Serializers must implement.
  XMLSerializer.php          # Converts XML into the requested object type automatically, very much the brain of this.
 Session
  Session.php                # Portable Session object used to store details of the current authenticated session.

Расширять

Дополнительная информация