PHP Class Browscap\Generator\AbstractBuildGenerator

Author: James Titcumb ([email protected])

Author: Thomas Müller ([email protected])

Show file Open project: browscap/browscap Class Usage Examples

Protected Properties

Property	Type	Description
$buildFolder	string
$collectionCreator	Browscap\Helper\CollectionCreator
$logger	Psr\Log\LoggerInterface
$resourceFolder	string
$writerCollection	Browscap\Writer\WriterCollection

Public Methods

Method	Description
__construct ( string $resourceFolder, string $buildFolder )
getCollectionCreator ( ) : CollectionCreator
getLogger ( ) : Psr\Log\LoggerInterface
getWriterCollection ( ) : WriterCollection
run ( string $version ) : AbstractBuildGenerator	Entry point for generating builds for a specified version
setCollectionCreator ( CollectionCreator $collectionCreator ) : AbstractBuildGenerator
setLogger ( Psr\Log\LoggerInterface $logger ) : AbstractBuildGenerator
setWriterCollection ( WriterCollection $writerCollection ) : AbstractBuildGenerator

Protected Methods

Method	Description
build ( string $version ) : AbstractBuildGenerator	runs the build
checkDirectoryExists ( string $directory, string $type ) : string
postBuild ( ) : AbstractBuildGenerator	runs after the build
preBuild ( ) : AbstractBuildGenerator	runs before the build

Method Details

__construct() public method

public __construct ( string $resourceFolder, string $buildFolder )
$resourceFolder	string
$buildFolder	string

build() protected method

runs the build

protected build ( string $version ) : AbstractBuildGenerator
$version	string
return	AbstractBuildGenerator

checkDirectoryExists() protected method

protected checkDirectoryExists ( string $directory, string $type ) : string
$directory	string
$type	string
return	string

getCollectionCreator() public method

public getCollectionCreator ( ) : CollectionCreator
return	Browscap\Helper\CollectionCreator

getLogger() public method

public getLogger ( ) : Psr\Log\LoggerInterface
return	Psr\Log\LoggerInterface

getWriterCollection() public method

public getWriterCollection ( ) : WriterCollection
return	Browscap\Writer\WriterCollection

postBuild() protected method

runs after the build

protected postBuild ( ) : AbstractBuildGenerator
return	AbstractBuildGenerator

preBuild() protected method

runs before the build

protected preBuild ( ) : AbstractBuildGenerator
return	AbstractBuildGenerator

run() public method

Entry point for generating builds for a specified version

public run ( string $version ) : AbstractBuildGenerator
$version	string
return	AbstractBuildGenerator

setCollectionCreator() public method

public setCollectionCreator ( CollectionCreator $collectionCreator ) : AbstractBuildGenerator
$collectionCreator	Browscap\Helper\CollectionCreator
return	AbstractBuildGenerator

setLogger() public method

public setLogger ( Psr\Log\LoggerInterface $logger ) : AbstractBuildGenerator
$logger	Psr\Log\LoggerInterface
return	AbstractBuildGenerator

setWriterCollection() public method

public setWriterCollection ( WriterCollection $writerCollection ) : AbstractBuildGenerator
$writerCollection	Browscap\Writer\WriterCollection
return	AbstractBuildGenerator

Property Details

$buildFolder protected property

protected string $buildFolder
return	string

$collectionCreator protected property

protected CollectionCreator,Browscap\Helper $collectionCreator
return	Browscap\Helper\CollectionCreator

$logger protected property

protected LoggerInterface,Psr\Log $logger
return	Psr\Log\LoggerInterface

$resourceFolder protected property

protected string $resourceFolder
return	string

$writerCollection protected property

protected WriterCollection,Browscap\Writer $writerCollection
return	Browscap\Writer\WriterCollection