Property | Type | Description | |
---|---|---|---|
$container | The container we belong to | ||
$formLookupInOtherSide | Should I look for form files on the other side of the component? | ||
$saveControllerScaffolding | When enabled, FOF will commit controller scaffolding results to disk. | ||
$saveModelScaffolding | When enabled, FOF will commit model scaffolding results to disk. | ||
$saveScaffolding | When enabled, FOF will commit the scaffolding results to disk. | ||
$saveViewScaffolding | When enabled, FOF will commit view scaffolding results to disk. | ||
$scaffolding | Should I enable view scaffolding, i.e. automatic browse, read and add/edit XML form generation when there's no other view template? | ||
$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 |
Method | Description | |
---|---|---|
__construct ( |
Public constructor for the factory object | |
controller ( string $viewName, array $config = [] ) : |
Create a new Controller object | |
dispatcher ( array $config = [] ) : |
Creates a new Dispatcher | |
form ( string $name, string $source, string $viewName, array $options = [], boolean $replace = true, boolean $xpath = false ) : |
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 = [] ) : |
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 = [] ) : |
Creates a new Toolbar | |
transparentAuthentication ( array $config = [] ) : |
Creates a new TransparentAuthentication handler | |
view ( string $viewName, string $viewType = 'html', array $config = [] ) : |
Create a new View object | |
viewFinder ( |
Creates a view template finder object for a specific View |
Method | Description | |
---|---|---|
createController ( string $controllerClass, array $config = [] ) : |
Creates a Controller object | |
createDispatcher ( string $dispatcherClass, array $config = [] ) : |
Creates a Dispatcher object | |
createModel ( string $modelClass, array $config = [] ) : |
Creates a Model object | |
createToolbar ( string $toolbarClass, array $config = [] ) : |
Creates a Toolbar object | |
createTransparentAuthentication ( string $authClass, array $config ) : |
Creates a TransparentAuthentication object | |
createView ( string $viewClass, array $config = [] ) : |
Creates a View object | |
getFormFilename ( string $source, string $viewName = null ) : string | boolean | Tries to find the absolute file path for an abstract form filename. For example, it may convert form.default to home/myuser/mysite/components/com_foobar/View/tmpl/form.default.xml. |
public __construct ( |
||
$container | The container we belong to |
public controller ( string $viewName, array $config = [] ) : |
||
$viewName | string | The name of the view we're getting a Controller for. |
$config | array | Optional MVC configuration values for the Controller object. |
return |
protected createController ( string $controllerClass, array $config = [] ) : |
||
$controllerClass | string | The fully qualified class name for the Controller |
$config | array | Optional MVC configuration values for the Controller object. |
return |
protected createDispatcher ( string $dispatcherClass, array $config = [] ) : |
||
$dispatcherClass | string | The fully qualified class name for the Dispatcher |
$config | array | The configuration values for the Dispatcher object |
return |
protected createModel ( string $modelClass, array $config = [] ) : |
||
$modelClass | string | The fully qualified class name for the Model |
$config | array | Optional MVC configuration values for the Model object. |
return |
protected createToolbar ( string $toolbarClass, array $config = [] ) : |
||
$toolbarClass | string | The fully qualified class name for the Toolbar |
$config | array | The configuration values for the Toolbar object |
return |
protected createTransparentAuthentication ( string $authClass, array $config ) : |
||
$authClass | string | The fully qualified class name for the TransparentAuthentication |
$config | array | The configuration values for the TransparentAuthentication object |
return |
protected createView ( string $viewClass, array $config = [] ) : |
||
$viewClass | string | The fully qualified class name for the View |
$config | array | Optional MVC configuration values for the View object. |
return |
public dispatcher ( array $config = [] ) : |
||
$config | array | The configuration values for the Dispatcher object |
return |
public form ( string $name, string $source, string $viewName, array $options = [], boolean $replace = true, boolean $xpath = false ) : |
||
$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 | The loaded form or null if the form filename doesn't exist |
public isSaveControllerScaffolding ( ) : boolean | ||
return | boolean | $state |
public isSaveModelScaffolding ( ) : boolean | ||
return | boolean | $state |
public isSaveScaffolding ( ) : boolean | ||
return | boolean |
public isSaveViewScaffolding ( ) : boolean | ||
return | boolean | $state |
public isScaffolding ( ) : boolean | ||
return | boolean |
public setSaveControllerScaffolding ( boolean $state ) | ||
$state | boolean |
public setSaveModelScaffolding ( boolean $state ) | ||
$state | boolean |
public setSaveScaffolding ( boolean $saveScaffolding ) | ||
$saveScaffolding | boolean |
public setSaveViewScaffolding ( boolean $state ) | ||
$state | boolean |
public setScaffolding ( boolean $scaffolding ) | ||
$scaffolding | boolean |
public transparentAuthentication ( array $config = [] ) : |
||
$config | array | The configuration values for the TransparentAuthentication object |
return |
public view ( string $viewName, string $viewType = 'html', array $config = [] ) : |
||
$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 |
public viewFinder ( |
||
$view | The view this view template finder will be attached to | |
$config | array | Configuration variables for the object |
return | mixed |
protected $formLookupInOtherSide |
protected $saveControllerScaffolding |
protected $saveModelScaffolding |
protected $saveScaffolding |
protected $saveViewScaffolding |
protected $scaffolding |
protected string $section | ||
return | string |