PHP Class OptomPortalConnection

显示文件 Open project: openeyes/openeyes Class Usage Examples

Protected Properties

Property Type Description
$client Zend_Http_Client
$config
$required_config_keys array For validating the configuration keys

Public Methods

Method Description
__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.

Protected Methods

Method Description
initClient ( ) : Zend_Http_Client Init HTTP client.
login ( ) Login to the API, set the auth header.
setConfig ( ) Set portal config.

Method Details

__construct() public method

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

createNewSignatureImage() public method

Creates a new ProtectedFile for the new signature image
public createNewSignatureImage ( $imageData, $fileId ) : ProtectedFile
$imageData
return ProtectedFile

initClient() protected method

Init HTTP client.
protected initClient ( ) : Zend_Http_Client
return Zend_Http_Client

login() protected method

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

setConfig() protected method

Set portal config.
protected setConfig ( )

signatureSearch() public method

Search the API for signatures.
public signatureSearch ( $start_date = null, $uniqueId = null ) : mixed
return mixed

Property Details

$client protected_oe property

protected Zend_Http_Client $client
return Zend_Http_Client

$config protected_oe property

protected $config

$required_config_keys protected_oe static_oe property

For validating the configuration keys
protected static array $required_config_keys
return array