PHP Interface FOF30\Factory\FactoryInterface

Exibir arquivo Open project: akeeba/fof

Public Methods

Method Description
__construct ( Container $container ) Public constructor for the factory object
controller ( string $viewName, array $config = [] ) : Controller Create a new Controller object
dispatcher ( array $config = [] ) : Dispatcher Creates a new Dispatcher
form ( string $name, string $source, string $viewName, array $options = [], boolean $replace = true, boolean $xpath = false ) : Form | null Creates a new Form object
getSection ( ) : string
isSaveControllerScaffolding ( ) : boolean Should we save controller scaffolding to disk?
isSaveModelScaffolding ( ) : boolean Should we save model scaffolding to disk?
isSaveScaffolding ( ) : boolean Is saving the scaffolding result to disk enabled?
isSaveViewScaffolding ( ) : boolean Should we save view scaffolding to disk?
isScaffolding ( ) : boolean Is scaffolding enabled?
model ( string $viewName, array $config = [] ) : Model Create a new Model object
setSaveControllerScaffolding ( boolean $state ) Should we save controller to disk?
setSaveModelScaffolding ( boolean $state ) Should we save model to disk?
setSaveScaffolding ( boolean $saveScaffolding ) Set the status of saving the scaffolding result to disk.
setSaveViewScaffolding ( boolean $state ) Should we save view to disk?
setScaffolding ( boolean $scaffolding ) Set the scaffolding status
setSection ( string $section )
toolbar ( array $config = [] ) : Toolbar Creates a new Toolbar
transparentAuthentication ( array $config = [] ) : TransparentAuthentication Creates a new TransparentAuthentication handler
view ( string $viewName, string $viewType = 'html', array $config = [] ) : View Create a new View object
viewFinder ( View $view, array $config = [] ) : mixed Creates a view template finder object for a specific View

Method Details

__construct() public method

Public constructor for the factory object
public __construct ( Container $container )
$container FOF30\Container\Container The container we belong to

controller() public method

Create a new Controller object
public controller ( string $viewName, array $config = [] ) : Controller
$viewName string The name of the view we're getting a Controller for.
$config array Optional MVC configuration values for the Controller object.
return FOF30\Controller\Controller

dispatcher() public method

Creates a new Dispatcher
public dispatcher ( array $config = [] ) : Dispatcher
$config array The configuration values for the Dispatcher object
return FOF30\Dispatcher\Dispatcher

form() public method

Creates a new Form object
public form ( string $name, string $source, string $viewName, array $options = [], boolean $replace = true, boolean $xpath = false ) : Form | null
$name string The name of the form.
$source string The form source filename without path and .xml extension e.g. "form.default" OR raw XML data
$viewName string The name of the view you're getting the form for.
$options array Options to the Form object
$replace boolean Should form fields be replaced if a field already exists with the same group/name?
$xpath boolean An optional xpath to search for the fields.
return FOF30\Form\Form | null The loaded form or null if the form filename doesn't exist

getSection() public method

public getSection ( ) : string
return string

isSaveControllerScaffolding() public method

Should we save controller scaffolding to disk?
public isSaveControllerScaffolding ( ) : boolean
return boolean $state

isSaveModelScaffolding() public method

Should we save model scaffolding to disk?
public isSaveModelScaffolding ( ) : boolean
return boolean $state

isSaveScaffolding() public method

Is saving the scaffolding result to disk enabled?
public isSaveScaffolding ( ) : boolean
return boolean

isSaveViewScaffolding() public method

Should we save view scaffolding to disk?
public isSaveViewScaffolding ( ) : boolean
return boolean $state

isScaffolding() public method

Is scaffolding enabled?
public isScaffolding ( ) : boolean
return boolean

model() public method

Create a new Model object
public model ( string $viewName, array $config = [] ) : Model
$viewName string The name of the view we're getting a Model for.
$config array Optional MVC configuration values for the Model object.
return FOF30\Model\Model

setSaveControllerScaffolding() public method

Should we save controller to disk?
public setSaveControllerScaffolding ( boolean $state )
$state boolean

setSaveModelScaffolding() public method

Should we save model to disk?
public setSaveModelScaffolding ( boolean $state )
$state boolean

setSaveScaffolding() public method

Set the status of saving the scaffolding result to disk.
public setSaveScaffolding ( boolean $saveScaffolding )
$saveScaffolding boolean

setSaveViewScaffolding() public method

Should we save view to disk?
public setSaveViewScaffolding ( boolean $state )
$state boolean

setScaffolding() public method

Set the scaffolding status
public setScaffolding ( boolean $scaffolding )
$scaffolding boolean

setSection() public method

public setSection ( string $section )
$section string

toolbar() public method

Creates a new Toolbar
public toolbar ( array $config = [] ) : Toolbar
$config array The configuration values for the Toolbar object
return FOF30\Toolbar\Toolbar

transparentAuthentication() public method

Creates a new TransparentAuthentication handler
public transparentAuthentication ( array $config = [] ) : TransparentAuthentication
$config array The configuration values for the TransparentAuthentication object
return FOF30\TransparentAuthentication\TransparentAuthentication

view() public method

Create a new View object
public view ( string $viewName, string $viewType = 'html', array $config = [] ) : View
$viewName string The name of the view we're getting a View object for.
$viewType string The type of the View object. By default it's "html".
$config array Optional MVC configuration values for the View object.
return FOF30\View\View

viewFinder() public method

Creates a view template finder object for a specific View
public viewFinder ( View $view, array $config = [] ) : mixed
$view FOF30\View\View The view this view template finder will be attached to
$config array Configuration variables for the object
return mixed