Skip to content
Permalink
Browse files

Adding omitted documentation information.

  • Loading branch information...
markstory committed Jun 10, 2010
1 parent ec5ad93 commit e5df32e9d9cc372c79b5db6adbba97d82d7adf1e
Showing with 34 additions and 12 deletions.
  1. +7 −1 cake/libs/controller/scaffold.php
  2. +24 −9 cake/libs/model/behaviors/translate.php
  3. +3 −2 cake/libs/view/theme.php
@@ -544,11 +544,17 @@ function __associations() {
App::import('View', 'Theme');
}
/**
* ScaffoldView provides specific view file loading features for scaffolded views.
*
* @package cake.libs.view
*/
class ScaffoldView extends ThemeView {
/**
* Override _getViewFileName
* Override _getViewFileName Appends special scaffolding views in.
*
* @param string $name name of the view file to get.
* @return string action
* @access protected
*/
@@ -29,6 +29,8 @@ class TranslateBehavior extends ModelBehavior {
/**
* Used for runtime configuration of model
*
* @var array
*/
var $runtime = array();
@@ -45,7 +47,8 @@ class TranslateBehavior extends ModelBehavior {
* $config could be empty - and translations configured dynamically by
* bindTranslation() method
*
* @param array $config
* @param Model $model Model the behavior is being attached to.
* @param array $config Array of configuration information.
* @return mixed
* @access public
*/
@@ -66,8 +69,9 @@ function setup(&$model, $config = array()) {
}
/**
* Callback
* Cleanup Callback unbinds bound translations and deletes setting information.
*
* @param Model $model Model being detached.
* @return void
* @access public
*/
@@ -80,7 +84,8 @@ function cleanup(&$model) {
/**
* beforeFind Callback
*
* @param array $query
* @param Model $model Model find is being run on.
* @param array $query Array of Query parameters.
* @return array Modified query
* @access public
*/
@@ -205,8 +210,9 @@ function beforeFind(&$model, $query) {
/**
* afterFind Callback
*
* @param array $results
* @param boolean $primary
* @param Model $model Model find was run on
* @param array $results Array of model results.
* @param boolean $primary Did the find originate on $model.
* @return array Modified results
* @access public
*/
@@ -250,6 +256,7 @@ function afterFind(&$model, $results, $primary) {
/**
* beforeValidate Callback
*
* @param Model $model Model invalidFields was called on.
* @return boolean
* @access public
*/
@@ -283,7 +290,8 @@ function beforeValidate(&$model) {
/**
* afterSave Callback
*
* @param boolean $created
* @param Model $model Model the callback is called on
* @param boolean $created Whether or not the save created a record.
* @return void
* @access public
*/
@@ -327,6 +335,7 @@ function afterSave(&$model, $created) {
/**
* afterDelete Callback
*
* @param Model $model Model the callback was run on.
* @return void
* @access public
*/
@@ -339,6 +348,7 @@ function afterDelete(&$model) {
/**
* Get selected locale for model
*
* @param Model $model Model the locale needs to be set/get on.
* @return mixed string or false
* @access protected
*/
@@ -356,8 +366,12 @@ function _getLocale(&$model) {
}
/**
* Get instance of model for translations
* Get instance of model for translations.
*
* If the model has a translateModel property set, this will be used as the class
* name to find/use. If no translateModel property is found 'I18nModel' will be used.
*
* @param Model $model Model to get a translatemodel for.
* @return object
* @access public
*/
@@ -461,8 +475,9 @@ function bindTranslation(&$model, $fields, $reset = true) {
* Unbind translation for fields, optionally unbinds hasMany association for
* fake field
*
* @param object instance of model
* @param mixed string with field, or array(field1, field2=>AssocName, field3), or null for unbind all original translations
* @param object $model instance of model
* @param mixed $fields string with field, or array(field1, field2=>AssocName, field3), or null for
* unbind all original translations
* @return bool
*/
function unbindTranslation(&$model, $fields = null) {
@@ -35,7 +35,8 @@ class ThemeView extends View {
/**
* Constructor for ThemeView sets $this->theme.
*
* @param Controller $controller
* @param Controller $controller Controller object to be rendered.
* @param boolean $register Should the view be registered in the registry.
*/
function __construct(&$controller, $register = true) {
parent::__construct($controller, $register);
@@ -45,7 +46,7 @@ function __construct(&$controller, $register = true) {
/**
* Return all possible paths to find view files in order
*
* @param string $plugin
* @param string $plugin The name of the plugin views are being found for.
* @param boolean $cached Set to true to force dir scan.
* @return array paths
* @access protected

0 comments on commit e5df32e

Please sign in to comment.
You can’t perform that action at this time.