PHP Class FOF30\Factory\Scaffolding\View\Builder

Show file Open project: akeeba/fof Class Usage Examples

Protected Properties

Property	Type	Description
$container		The container we belong to
$section	string	Section used to build the namespace prefix. We have to pass it since in CLI scaffolding we need to force the section we're in (ie Site or Admin). {@see \FOF30\Container\Container::getNamespacePrefix() } for valid values

Public Methods

Method	Description
__construct ( Container $c )	Create the scaffolding builder instance
getContainer ( ) : Container	Gets the container this builder belongs to
getSection ( ) : string
make ( string $requestedClass, string $viewName, string $viewType ) : boolean	Make a new scaffolding document
setSection ( string $section )

Method Details

__construct() public method

Create the scaffolding builder instance

public __construct ( Container $c )
$c	FOF30\Container\Container

getContainer() public method

Gets the container this builder belongs to

public getContainer ( ) : Container
return	FOF30\Container\Container

getSection() public method

public getSection ( ) : string
return	string

make() public method

Make a new scaffolding document

public make ( string $requestedClass, string $viewName, string $viewType ) : boolean
$requestedClass	string	The requested class, with full qualifier ie Myapp\Site\Controller\Foobar
$viewName	string	The name of the view linked to this controller
$viewType	string	The type of the view linked to this controller
return	boolean	True on success, false otherwise

setSection() public method

public setSection ( string $section )
$section	string

Property Details

$container protected property

The container we belong to

protected $container

$section protected property

Section used to build the namespace prefix. We have to pass it since in CLI scaffolding we need to force the section we're in (ie Site or Admin). {@see \FOF30\Container\Container::getNamespacePrefix() } for valid values

protected string $section
return	string