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

See link: https://github.com/appserver-io/appserver

Author: Tim Wagner ([email protected])

Inheritance: extends AppserverIo\Description\Api\Node\AbstractNode, implements AppserverIo\Appserver\Core\Api\Node\ScannerNodeInterface, use trait ParamsNodeTrait, use trait AppserverIo\Appserver\Core\Api\Node\DirectoriesNodeTrait

Show file Open project: appserver-io/appserver Class Usage Examples

Protected Properties

Property	Type	Description
$factory	string	The scanner factory class name.
$name	string	The scanner name.
$type	string	The scanner type.

Public Methods

Method	Description
__construct ( string $name = '', string $type = '', string $factory = '', array $params = [], array $directories = [] )	Initializes the scanner node with the necessary data.
getFactory ( ) : string	Returns the scanner factory class.
getName ( ) : string	Returns the provisioner name.
getPrimaryKey ( ) : string	Returns the nodes primary key, the name by default.
getType ( ) : string	Returns the scanner type.

Method Details

__construct() public method

Initializes the scanner node with the necessary data.

public __construct ( string $name = '', string $type = '', string $factory = '', array $params = [], array $directories = [] )
$name	string	The scanner name
$type	string	The scanner type
$factory	string	The scanner type
$params	array	The scanner params
$directories	array	The scanner directories

getFactory() public method

Returns the scanner factory class.

public getFactory ( ) : string
return	string	The scanner factory class

getName() public method

Returns the provisioner name.

public getName ( ) : string
return	string	The provisioner 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 scanner type.

public getType ( ) : string
return	string	The scanner type

Property Details

$factory protected property

The scanner factory class name.

protected string $factory
return	string

$name protected property

The scanner name.

protected string $name
return	string

$type protected property

The scanner type.

protected string $type
return	string