PHP Class AppserverIo\Appserver\Core\Api\Node\ExtractorNode

See link: https://github.com/appserver-io/appserver
See link: http://www.appserver.io
Author: Tim Wagner ([email protected])
Inheritance: extends AppserverIo\Description\Api\Node\AbstractNode, implements AppserverIo\Appserver\Core\Api\Node\ExtractorNodeInterface
Show file Open project: appserver-io/appserver Class Usage Examples

Protected Properties

Property Type Description
$createBackups string The flag to create backups before deleting the application folder.
$factory string The extractors factory class name.
$name string The extractors name.
$restoreBackups string The flag to restore backups after extracting the archive to the application folder.
$type string The extractors type.

Public Methods

Method Description
__construct ( string $name = '', string $type = '', string $factory = '', boolean $createBackups = false, boolean $restoreBackups = false ) Initializes the extractor node with the necessary data.
getFactory ( ) : string Returns the extractor's factory class name.
getName ( ) : string Returns the extractor's name.
getPrimaryKey ( ) : string Returns the nodes primary key, the name by default.
getType ( ) : string Returns the extractor's type.
isCreateBackups ( ) : boolean Returns the flag that backups should be created.
isRestoreBackups ( ) : boolean Returns the flag that backups should be restored.

Method Details

__construct() public method

Initializes the extractor node with the necessary data.
public __construct ( string $name = '', string $type = '', string $factory = '', boolean $createBackups = false, boolean $restoreBackups = false )
$name string The extractor's name
$type string The extractor's type
$factory string The extractor's factory class name
$createBackups boolean The flag to create backups
$restoreBackups boolean The flag to restore backups

getFactory() public method

Returns the extractor's factory class name.
public getFactory ( ) : string
return string The extractor's factory class name

getName() public method

Returns the extractor's name.
public getName ( ) : string
return string The extractor's name

getPrimaryKey() public method

Returns the nodes primary key, the name by default.
See also: AppserverIo\Appserver\Core\Api\Node\AbstractNode::getPrimaryKey()
public getPrimaryKey ( ) : string
return string The nodes primary key

getType() public method

Returns the extractor's type.
public getType ( ) : string
return string The extractor's type

isCreateBackups() public method

Returns the flag that backups should be created.
public isCreateBackups ( ) : boolean
return boolean The flag to create backups

isRestoreBackups() public method

Returns the flag that backups should be restored.
public isRestoreBackups ( ) : boolean
return boolean The flag to restore backups

Property Details

$createBackups protected property

The flag to create backups before deleting the application folder.
protected string $createBackups
return string

$factory protected property

The extractors factory class name.
protected string $factory
return string

$name protected property

The extractors name.
protected string $name
return string

$restoreBackups protected property

The flag to restore backups after extracting the archive to the application folder.
protected string $restoreBackups
return string

$type protected property

The extractors type.
protected string $type
return string