PHP Класс OptomPortalConnection

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$client Zend_Http_Client
$config
$required_config_keys array For validating the configuration keys

Открытые методы

Метод Описание
__construct ( CApplication $yii = null ) OptomPortalConnection constructor.
createNewSignatureImage ( $imageData, $fileId ) : ProtectedFile Creates a new ProtectedFile for the new signature image
signatureSearch ( $start_date = null, $uniqueId = null ) : mixed Search the API for signatures.

Защищенные методы

Метод Описание
initClient ( ) : Zend_Http_Client Init HTTP client.
login ( ) Login to the API, set the auth header.
setConfig ( ) Set portal config.

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

__construct() публичный Метод

OptomPortalConnection constructor.
public __construct ( CApplication $yii = null )
$yii CApplication - for dependency injection/testing

createNewSignatureImage() публичный Метод

Creates a new ProtectedFile for the new signature image
public createNewSignatureImage ( $imageData, $fileId ) : ProtectedFile
$imageData
Результат ProtectedFile

initClient() защищенный Метод

Init HTTP client.
protected initClient ( ) : Zend_Http_Client
Результат Zend_Http_Client

login() защищенный Метод

Login to the API, set the auth header.
protected login ( )

setConfig() защищенный Метод

Set portal config.
protected setConfig ( )

signatureSearch() публичный Метод

Search the API for signatures.
public signatureSearch ( $start_date = null, $uniqueId = null ) : mixed
Результат mixed

Описание свойств

$client защищенное свойство

protected Zend_Http_Client $client
Результат Zend_Http_Client

$config защищенное свойство

protected $config

$required_config_keys защищенное статическое свойство

For validating the configuration keys
protected static array $required_config_keys
Результат array