Job

Contains details of a job run.

class Job
Copyright
2016 Appertly
License
Apache-2.0

Constructors / Destructors

Public
ReturnsSignature and Description
void
__construct(string $destination, Mapper $mapper)

Creates a new Job.

Instance Methods

Public
ReturnsSignature and Description
string
getDestination()

Gets the export file path.

Mapper
getMapper()

Gets the Mapper

ConstSet<string>
getNamespaces()

Gets the namespaces of the tokens.

ConstVector<ScannedBase>
getTokens()

Gets the tokens.

ConstMap<string,ScannedBase>
getTokensByName()

Gets the tokens, keyed by name

Method Details

__construct

public function __construct(string $destination, Mapper $mapper)

Creates a new Job.

Parameters
NameTypeDescription
$destinationstring

The file path to contain exported pages

$mapperMapper

The mapper

getDestination

public function getDestination()

Gets the export file path.

Returns
TypeDescription
string

The file path to contain exported pages

getMapper

public function getMapper()

Gets the Mapper

Returns
TypeDescription
Mapper

The mapper

getNamespaces

public function getNamespaces()

Gets the namespaces of the tokens.

Returns
TypeDescription
ConstSet<string>

The token namespaces

getTokens

public function getTokens()

Gets the tokens.

Returns
TypeDescription
ConstVector<ScannedBase>

The scanned tokens

getTokensByName

public function getTokensByName()

Gets the tokens, keyed by name

Returns
TypeDescription
ConstMap<string,ScannedBase>

The scanned tokens, keyed by name