Service - Amiro_UserSourceAppDriver - Amiro.CMS API Reference [beta]

• Introduction

Amiro server driver.

Amiro_UserSourceAppDriver extends AMI_UserSourceAppDriver {

/* Properties */

// Driver id numeric (unique).

public void $driverId = 4;

// Driver name.

public void $driverName = 'ami_amiro';

/* Inherited Properties */

// Entry point URL.

public AMI_UserSourceAppDriver::$entryPoint = 'ami_service.php';

// Driver's settings array.

protected AMI_UserSourceAppDriver::$aConfig;

// User Source application object.

protected AMI_UserSourceAppDriver::$oService;

/* Inherited Methods */

// Constructior.

public AMI_UserSourceAppDriver::__construct ( AMI_iUserSourceAppService $oService, [ $aConfig = array() ] ) returns AMI_UserSourceAppDriver;

// Dispatch verify login action.

public AMI_UserSourceAppDriver::dispatchVerify ( [ $aData = array() ] ) returns bool;

// Return HTML button.

public AMI_UserSourceAppDriver::getButton ( [ $aScope = array() ] ) returns string;

// Returns current driver ID.

public AMI_UserSourceAppDriver::getDriverId ( ) returns string;

// Return driver name.

public AMI_UserSourceAppDriver::getDriverName ( ) returns string;

// Return entry point script name.

public AMI_UserSourceAppDriver::getEntryPoint ( ) returns string;

// Returns driver icon.

public AMI_UserSourceAppDriver::getIcon ( [ $aScope = array() ] ) returns string;

// Returns short string hash.

public AMI_UserSourceAppDriver::getShortHash ( string $string ) returns string;

}