Fork me on GitHub
Heads up!
These docs are for Crud v3 - that only works with CakePHP 2.x. For CRUD v4 docs please go to the new documentation site
The CRUD v4 documentation has been completely rewritten, and since CRUD v3 and CRUD v4 API is ~95% identical, it may be worth a look for CRUD v3 users as well until v4 docs are backported for v3.
...toc....

View CrudAction

The view CrudAction will read a record from the database based on the ID that is part of the request.

Relevant links: PHP source code | API documentation

Events

This is a list of events emitted from the CrudAction

In addition to the subject properties listed below, there is also a long list of objects that are always available in all events.
Please see the events documentation for a full list of subject properties and how to use the event system correctly.

Event Subject modifiers Description
Crud.startup None Called after the Controller::beforeFilter() and before the Crud action
Crud.initialize None Triggered when a CrudAction is going to handle a CakePHP.
Crud.beforeFind findMethod
query
findMethod maps to the 1st argument of Model::find(). The default value is all.
query maps to the 2nd argument of Model::find(). e.g. fields, conditions, contain etc.
Crud.afterFind id
item
id is the ID that was originally passed to the action and are usually the primary key of your model.
item is the record that was found in the database.
Crud.recordNotFound id If beforeFind could not find a record this event is emitted
Crud.beforeRender None Invoked right before the view will be rendered.
This is also before the controllers own beforeRender callback

Configuration

This is the configuration options for the Crud action class

Please see the configuration documentation on how to change these settings

Key Default value Description
enabled true If this action is enabled or not.
findMethod all (index)
first (edit, view)
count (delete)
The 1st parameter to Model::find or Model::paginate().
view NULL The view file to render. If the value is NULL the normal CakePHP behavior will be used
viewVar NULL For Index Crud Action the default is plural version of the model name.
Having a model named Post would mean that the viewVar would be posts by default.

For View Crud Action the default is singular version of the model name.
Having a model named Post would mean that the viewVar would be post by default.
serialize array() View vars to serialize if you use the Crud API.
This property maps to _serialize in CakePHP

Methods

This is a list of the most relevant public methods in the Crud action class.

For a full list please see the full API documentation

Method Description
findMethod($method = NULL) Get or set the findMethod configuration setting.
If $method is NULL the current findMethod will be returned.
If $method is a string, the setting will be changed.
view($view = NULL) Get or set the view configuration setting.
If $view is NULL the current view will be returned.
If $view is a string, the setting will be changed.
viewVar($viewVar = NULL) Get or set the viewVar configuration setting.
If $viewVar is NULL the current viewVar will be returned.
If $viewVar is a string, the setting will be changed.



comments powered by Disqus