PHP Class schmunk42\giiant\generators\crud\Generator

Since: 1.0
Author: Tobais Munk ([email protected])
Inheritance: extends yii\gii\generators\crud\Generator
Show file Open project: schmunk42/yii2-giiant Class Usage Examples

Public Properties

Property Type Description
$accessFilter whether to add an access filter to controllers
$actionButtonClass string
$baseTraits
$controllerNs controller base namespace
$fixOutput whether to use php-cs-fixer to generate PSR compatible output
$formLayout Bootstrap CSS-class for form-layout
$generateAccessFilterMigrations
$gridMaxColumns maximum number of columns to show in grid
$gridRelationMaxColumns maximum number of columns to show in grid
$indexGridClass
$messageCategory translation catalogue
$migrationClass
$modelMessageCategory translation catalogue for model related translations
$moduleNs
$overwriteControllerClass whether to overwrite extended controller classes
$overwriteRestControllerClass whether to overwrite rest/api controller classes
$overwriteSearchModelClass whether to overwrite search classes
$pathPrefix prefix for controller route, eg. when generating controllers into subfolders
$providerList comma separated list of provider classes
$requires array of composer packages (only to show information to the developer in the web UI)
$savedForm form field for selecting and loading saved gii forms
$singularEntities whether to convert controller name to singular
$skipRelations relations to be excluded in UI rendering
$tablePrefix table prefix to be removed from class names when auto-detecting model names, eg. app_ converts table app_foo into Foo
$tidyOutput whether to use phptidy on renderer files before saving
$viewPath default view path

Public Methods

Method Description
formAttributes ( ) : array all form fields for saving in saved forms.
generate ( )
getControllerID ( ) : string
getDescription ( )
getModuleId ( ) : string
getName ( )
getViewPath ( ) : string
hints ( )
init ( )
render ( $template, $params = [] )
rules ( )
stickyAttributes ( )
successMessage ( )
validateClass ( $attribute, $params )
var_export54 ( $var, $indent = '' ) TODO: replace with VarDumper::export

Method Details

formAttributes() public method

all form fields for saving in saved forms.
public formAttributes ( ) : array
return array

generate() public method

public generate ( )

getControllerID() public method

public getControllerID ( ) : string
return string the controller ID (without the module ID prefix)

getDescription() public method

public getDescription ( )

getModuleId() public method

public getModuleId ( ) : string
return string the controller ID (without the module ID prefix)

getName() public method

public getName ( )

getViewPath() public method

public getViewPath ( ) : string
return string the action view file path

hints() public method

public hints ( )

init() public method

public init ( )

render() public method

public render ( $template, $params = [] )

rules() public method

public rules ( )

stickyAttributes() public method

public stickyAttributes ( )

successMessage() public method

public successMessage ( )

validateClass() public method

public validateClass ( $attribute, $params )

var_export54() public method

TODO: replace with VarDumper::export
public var_export54 ( $var, $indent = '' )

Property Details

$accessFilter public property

whether to add an access filter to controllers
public $accessFilter

$actionButtonClass public property

public string $actionButtonClass
return string

$baseTraits public property

public $baseTraits

$controllerNs public property

controller base namespace
public $controllerNs

$fixOutput public property

whether to use php-cs-fixer to generate PSR compatible output
public $fixOutput

$formLayout public property

Bootstrap CSS-class for form-layout
public $formLayout

$generateAccessFilterMigrations public property

public $generateAccessFilterMigrations

$gridMaxColumns public property

maximum number of columns to show in grid
public $gridMaxColumns

$gridRelationMaxColumns public property

maximum number of columns to show in grid
public $gridRelationMaxColumns

$indexGridClass public property

public $indexGridClass

$messageCategory public property

translation catalogue
public $messageCategory

$migrationClass public property

public $migrationClass

$modelMessageCategory public property

translation catalogue for model related translations
public $modelMessageCategory

$moduleNs public property

public $moduleNs

$overwriteControllerClass public property

whether to overwrite extended controller classes
public $overwriteControllerClass

$overwriteRestControllerClass public property

whether to overwrite rest/api controller classes
public $overwriteRestControllerClass

$overwriteSearchModelClass public property

whether to overwrite search classes
public $overwriteSearchModelClass

$pathPrefix public property

prefix for controller route, eg. when generating controllers into subfolders
public $pathPrefix

$providerList public property

comma separated list of provider classes
public $providerList

$requires public property

array of composer packages (only to show information to the developer in the web UI)
public $requires

$savedForm public property

form field for selecting and loading saved gii forms
public $savedForm

$singularEntities public property

whether to convert controller name to singular
public $singularEntities

$skipRelations public property

relations to be excluded in UI rendering
public $skipRelations

$tablePrefix public property

table prefix to be removed from class names when auto-detecting model names, eg. app_ converts table app_foo into Foo
public $tablePrefix

$tidyOutput public property

whether to use phptidy on renderer files before saving
public $tidyOutput

$viewPath public property

default view path
public $viewPath