• Home
• CrudComponent

PHP Class CrudComponent, Platform-Crud-Plugin

Scaffolding on steroids! :) Copyright 2010-2012, Nodes ApS. (http://www.nodesagency.com/) Licensed under The MIT License Redistributions of files must retain the above copyright notice. Show file Open project: nodesagency/Platform-Crud-Plugin Class Usage Examples

Public Properties

Property	Type	Description
$components	array	Reference to a Session component
$settings	array	validateId ID Argument validation - by default it will inspect your model's primary key and based on it's data type either use integer or uuid validation. Can be disabled by setting it to "false". Supports "integer" and "uuid" configuration By default it's configuration is NULL, which means "auto detect" eventPrefix All emitted events will be prefixed with this property value secureDelete delete() can only be called with the HTTP DELETE verb, not POST when true. If set to false HTTP POST is also acceptable actions contains an array of controller methods this component should offer implementation for. The actions is used for actionMap, viewMap and findMethodMap to change behavior of CrudComponent By default no actions are enabled translations is the settings for the translations Event, responsible for the text used in flash messages see TranslationsEvent::$_defaults the full list of options relatedList is a map of the controller action and the whether it should fetch associations lists to be used in select boxes. An array as value means it is enabled and represent the list of model associations to be fetched saveAllOptions Raw array passed as 2nd argument to saveAll() in add and edit method If you configure a key with your action name, it will override the default settings. This is useful for adding fieldList to enhance security in saveAll. actionMap A map of the controller action and what CRUD action we should call. By default it supports non-prefix and admin_ prefixed routes viewMap A map of the controller action and the view to render By default it supports non-prefix and admin_ prefixed routes findMethodMap The default find method for reading data listenerClassMap List of internal-name => ${plugin}.${class} listeners that will be bound automatically in Crud. By default translations and related model events are bound. Events will always assume to be in the Controller/Event folder

Protected Properties

Property	Type	Description
$_action	string	The current controller action
$_controller	Controller	Reference to the current controller
$_eventManager	CakeEventManager	Reference to the current event manager
$_listeners	array	List of listener objects attached to Crud
$_model	Model	Cached property for the current Controller::modelClass instance
$_modelName	string	Cached property for Controller::modelClass
$_request	CakeRequest	Reference to the current request

Public Methods

Method	Description
__construct ( ComponentCollection $collection, array $settings = [] )	Constructor
config ( mixed $key = null, mixed $value = null ) : TranslationsEvent	Generic config method
disableAction ( string $action ) : void	Disable a CRUD action
enableAction ( string $action ) : void	Enable a CRUD action
executeAction ( string $controllerAction = null, $args = [] ) : mixed	Execute a Crud action
getIdFromRequest ( ) : string	Helper method to get the passed ID to an action
getListener ( string $name, $create = true ) : CrudBaseEvent	Get a single event class
initialize ( Controller $controller ) : void	Make sure to update the list of known controller methods before startup is called
isActionMapped ( string | null $action = null ) : boolean	Check if a CRUD action has been mapped (aka should be handled by CRUD component)
mapAction ( string $action, string $type, boolean $enable = true ) : void	Map action to a internal request type
mapActionView ( string | array $action, string $view = null ) : void	Map the view file to use for a controller action
mapFindMethod ( string $action, strign $method ) : void	Map a controller action to a Model::find($method)
on ( string | array $events, callback $callback ) : void	Attaches an event listener function to the controller for Crud Events
trigger ( string $eventName, array $data = [] ) : CrudSubject	Triggers a Crud event by creating a new subject and filling it with $data if $data is an instance of CrudSubject it will be reused as the subject object for this event.

Protected Methods

Method	Description
_addAction ( ) : void	Generic add action
_deleteAction ( string $id = null ) : void	Generic delete action
_detectPrimaryKeyFieldType ( ) : string	Automatically detect primary key data type for _validateId()
_editAction ( string $id = null ) : void	Generic edit action
_getFindMethod ( string | null $action = null, string | null $default = null ) : string	Get the model find method for a current controller action
_getResourceName ( ) : string	Return the human name of the model
_getSaveAllOptions ( string | null $action = null ) : array	Build options for saveAll
_getSubject ( array $additional = [] ) : CrudSubject	Create a CakeEvent subject with the required properties
_indexAction ( ) : void	Generic index action
_loadListener ( string $name ) : void	Load a single event class attached to Crud
_loadListeners ( ) : void	Load all event classes attached to Crud
_redirect ( CrudSubject $subject, array | null $url = null ) : void	Called for all redirects inside CRUD
_setFlash ( string $type ) : void	Wrapper for Session::setFlash
_setModelProperties ( ) : void	Set internal model properties from the controller
_validateId ( mixed $id ) : boolean	Is the passed ID valid ?
_viewAction ( string $id = null ) : void	Generic view action

Method Details

Property Details