• Home
  • Controller_Addon

PHP Class Controller_Addon, atk4

Inheritance: extends AbstractController
Show file Open project: atk4/atk4 Class Usage Examples

Public Properties

Property Type Description
$addon_base_path string | object | array
$addon_name string
$addon_obj object with information from json file
$addon_private_locations array
$addon_public_locations array
$api_var
$atk_version string
$base_path ???
$has_assets boolean
$location PathFinder_Location
$namespace string
$with_pages boolean

Public Methods

Method Description
addAddonLocations ( $base_path )
addLocation ( $contents, $public_contents = null ) This defines the location data for the add-on. Call this method explicitly from init() if necessary.
checkConfiguration ( )
init ( ) ???
installAssets ( ) This method will rely on location data to link.
installDatabase ( )
licenseCheck ( $type, $software = 'atk', $pubkey = null, $pubkey_md5 = null ) Addon may requrie user to have license for ATK or some other piece of software to function properly. This is will be called during installation and then later on ocassionally, but not on production environment.
routePages ( $page_prefix ) This routes certain prefixes to an add-on. Call this method explicitly from init() if necessary.

Method Details

addAddonLocations() public method

public addAddonLocations ( $base_path )

addLocation() public method

This defines the location data for the add-on. Call this method explicitly from init() if necessary.
public addLocation ( $contents, $public_contents = null )

checkConfiguration() public method

public checkConfiguration ( )

init() public method

???
public init ( )

installAssets() public method

This method will rely on location data to link.
public installAssets ( )

installDatabase() public method

public installDatabase ( )

licenseCheck() public method

Agile Toolkit provides universal way for checking licenses. If you are building commercial product with Agile Toolkit, then you need to use unique identifier for $software. Provide the name of your public key certificate and also supply md5sum of that certificate as last parameter, to make sure developer wouldn't simply substitute public key with another one. Public key must be bundled along with the release of your software This method will return true / false. If you have multiple public keys (expired ones), you can call this method several times. The information about the private key specifically issued to the user will be stored in configuration file.
public licenseCheck ( $type, $software = 'atk', $pubkey = null, $pubkey_md5 = null )

routePages() public method

This routes certain prefixes to an add-on. Call this method explicitly from init() if necessary.
public routePages ( $page_prefix )

Property Details

$addon_base_path public property

public string|object|array $addon_base_path
return string | object | array

$addon_name public property

public string $addon_name
return string

$addon_obj public property

object with information from json file
public $addon_obj

$addon_private_locations public property

public array $addon_private_locations
return array

$addon_public_locations public property

public array $addon_public_locations
return array

$api_var public property

public $api_var

$atk_version public property

public string $atk_version
return string

$base_path public property

???
public $base_path

$has_assets public property

public bool $has_assets
return boolean

$location public property

public PathFinder_Location $location
return PathFinder_Location

$namespace public property

public string $namespace
return string

$with_pages public property

public bool $with_pages
return boolean