Amiro.CMS API Reference
Amiro.Ru / Manual
Loading search...

The Twitter_UserSourceAppDriver class

AMI_UserSourceAppDriver
   |
   --Twitter_UserSourceAppDriver

• Introduction

Twitter driver.

• Class synopsis

Twitter_UserSourceAppDriver extends AMI_UserSourceAppDriver {
/* Properties */
// Driver id numeric (unique).
public void $driverId = 1;
// Driver name.
public void $driverName = 'ami_twitter';
// Icon set.
protected string $iconSet = 'twitter_icon';
// Login button set.
protected string $loginButtonSet = 'twitter_login_button';
/* Inherited Properties */
// Entry point URL.
public AMI_UserSourceAppDriver::$entryPoint = 'ami_service.php';
// Driver's settings array.
// User Source application object.
/* Methods */
// Process Redirect action.
public dispatchRedirect ( [ $aData = array() ] ) returns void;
// Process Request action.
public dispatchRequest ( [ $aData = array() ] ) returns void;
// Process Verify action.
public dispatchVerify ( [ $aData = array() ] ) returns bool;
// Returns driver button HTML.
public getButton ( ) returns string;
/* 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 int;
// 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;
}

• Class Details

Config parameters:
[ami_twitter]
enabled = yes; app_id = '...'; consumer_secret = '...';
Tags:
since 5.12.0

• Class Properies

public void $driverId

Driver id numeric (unique).

public void $driverName

Driver name.

protected string $iconSet

Icon set.

protected string $loginButtonSet

Login button set.

• Class Methods

// Process Redirect action.
public dispatchRedirect ( [ $aData = array() ] ) returns void;
  • array $aData
    Data array
// Process Request action.
public dispatchRequest ( [ $aData = array() ] ) returns void;
  • array $aData
    Data array
// Process Verify action.
public dispatchVerify ( [ $aData = array() ] ) returns bool;
  • array $aData
    Array. Required keys: 'login'.
// Returns driver button HTML.
public getButton ( ) returns string;