Blame | Letzte Änderung | Log anzeigen | RSS feed
<?php/* SVN FILE: $Id: scaffold.php 7945 2008-12-19 02:16:01Z gwoo $ *//*** Scaffold.** Automatic forms and actions generation for rapid web application development.** PHP versions 4 and 5** CakePHP(tm) : Rapid Development Framework (http://www.cakephp.org)* Copyright 2005-2008, Cake Software Foundation, Inc. (http://www.cakefoundation.org)** Licensed under The MIT License* Redistributions of files must retain the above copyright notice.** @filesource* @copyright Copyright 2005-2008, Cake Software Foundation, Inc. (http://www.cakefoundation.org)* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP(tm) Project* @package cake* @subpackage cake.cake.libs.controller* @since Cake v 0.10.0.1076* @version $Revision: 7945 $* @modifiedby $LastChangedBy: gwoo $* @lastmodified $Date: 2008-12-18 18:16:01 -0800 (Thu, 18 Dec 2008) $* @license http://www.opensource.org/licenses/mit-license.php The MIT License*//*** Scaffolding is a set of automatic views, forms and controllers for starting web development work faster.** Scaffold inspects your database tables, and making educated guesses, sets up a* number of pages for each of your Models. These pages have data forms that work,* and afford the web developer an early look at the data, and the possibility to over-ride* scaffolded actions with custom-made ones.** @package cake* @subpackage cake.cake.libs.controller*/class Scaffold extends Object {/*** Controller object** @var object* @access public*/var $controller = null;/*** Name of the controller to scaffold** @var string* @access public*/var $name = null;/*** Action to be performed.** @var string* @access public*/var $action = null;/*** Name of current model this view context is attached to** @var string* @access public*/var $model = null;/*** Path to View.** @var string* @access public*/var $viewPath;/*** Path parts for creating links in views.** @var string Base URL* @access public*/var $base = null;/*** Name of layout to use with this View.** @var string* @access public*/var $layout = 'default';/*** Array of parameter data** @var array* @access public*/var $params;/*** File extension. Defaults to Cake's template ".ctp".** @var array* @access public*/var $ext = '.ctp';/*** Sub-directory for this view file.** @var string* @access public*/var $subDir = null;/*** Plugin name.** @var string* @access public*/var $plugin = null;/*** List of variables to collect from the associated controller** @var array* @access private*/var $__passedVars = array('action', 'base', 'webroot', 'layout', 'name', 'viewPath', 'ext', 'params', 'data', 'plugin', 'cacheAction');/*** Title HTML element for current scaffolded view** @var string* @access public*/var $scaffoldTitle = null;/*** Construct and set up given controller with given parameters.** @param string $controller_class Name of controller* @param array $params Parameters for scaffolding*/function __construct(&$controller, $params) {$this->controller =& $controller;$count = count($this->__passedVars);for ($j = 0; $j < $count; $j++) {$var = $this->__passedVars[$j];$this->{$var} = $controller->{$var};}$this->redirect = array('action'=> 'index');$this->modelClass = $controller->modelClass;$this->modelKey = $controller->modelKey;if (!is_object($this->controller->{$this->modelClass})) {return $this->cakeError('missingModel', array(array('className' => $this->modelClass, 'webroot' => '', 'base' => $controller->base)));}$this->ScaffoldModel =& $this->controller->{$this->modelClass};$this->scaffoldTitle = Inflector::humanize($this->viewPath);$this->scaffoldActions = $controller->scaffold;$this->controller->pageTitle = __('Scaffold :: ', true) . Inflector::humanize($this->action) . ' :: ' . $this->scaffoldTitle;$modelClass = $this->controller->modelClass;$primaryKey = $this->ScaffoldModel->primaryKey;$displayField = $this->ScaffoldModel->displayField;$singularVar = Inflector::variable($modelClass);$pluralVar = Inflector::variable($this->controller->name);$singularHumanName = Inflector::humanize($modelClass);$pluralHumanName = Inflector::humanize($this->controller->name);$scaffoldFields = array_keys($this->ScaffoldModel->schema());$associations = $this->__associations();$this->controller->set(compact('modelClass', 'primaryKey', 'displayField', 'singularVar', 'pluralVar','singularHumanName', 'pluralHumanName', 'scaffoldFields', 'associations'));if ($this->controller->view && $this->controller->view !== 'Theme') {$this->controller->view = 'scaffold';}$this->__scaffold($params);}/*** Outputs the content of a scaffold method passing it through the Controller::afterFilter()** @return void* @access protected*/function _output() {$this->controller->afterFilter();echo($this->controller->output);}/*** Renders a view action of scaffolded model.** @param array $params Parameters for scaffolding* @return mixed A rendered view of a row from Models database table* @access private*/function __scaffoldView($params) {if ($this->controller->_beforeScaffold('view')) {if (isset($params['pass'][0])) {$this->ScaffoldModel->id = $params['pass'][0];} elseif (isset($this->controller->Session) && $this->controller->Session->valid() != false) {$this->controller->Session->setFlash(sprintf(__("No id set for %s::view()", true), Inflector::humanize($this->modelKey)));$this->controller->redirect($this->redirect);} else {return $this->controller->flash(sprintf(__("No id set for %s::view()", true), Inflector::humanize($this->modelKey)),'/' . Inflector::underscore($this->controller->viewPath));}$this->ScaffoldModel->recursive = 1;$this->controller->data = $this->ScaffoldModel->read();$this->controller->set(Inflector::variable($this->controller->modelClass), $this->controller->data);$this->controller->render($this->action, $this->layout);$this->_output();} elseif ($this->controller->_scaffoldError('view') === false) {return $this->__scaffoldError();}}/*** Renders index action of scaffolded model.** @param array $params Parameters for scaffolding* @return mixed A rendered view listing rows from Models database table* @access private*/function __scaffoldIndex($params) {if ($this->controller->_beforeScaffold('index')) {$this->ScaffoldModel->recursive = 0;$this->controller->set(Inflector::variable($this->controller->name), $this->controller->paginate());$this->controller->render($this->action, $this->layout);$this->_output();} elseif ($this->controller->_scaffoldError('index') === false) {return $this->__scaffoldError();}}/*** Renders an add or edit action for scaffolded model.** @param string $action Action (add or edit)* @return mixed A rendered view with a form to edit or add a record in the Models database table* @access private*/function __scaffoldForm($action = 'edit') {$this->controller->render($action, $this->layout);$this->_output();}/*** Saves or updates the scaffolded model.** @param array $params Parameters for scaffolding* @param string $action add or edt* @return mixed Success on save/update, add/edit form if data is empty or error if save or update fails* @access private*/function __scaffoldSave($params = array(), $action = 'edit') {$formAction = 'edit';$success = __('updated', true);if ($action === 'add') {$formAction = 'add';$success = __('saved', true);}if ($this->controller->_beforeScaffold($action)) {if ($action == 'edit') {if (isset($params['pass'][0])) {$this->ScaffoldModel->id = $params['pass'][0];}if (!$this->ScaffoldModel->exists()) {if (isset($this->controller->Session) && $this->controller->Session->valid() != false) {$this->controller->Session->setFlash(sprintf(__("Invalid id for %s::edit()", true), Inflector::humanize($this->modelKey)));$this->controller->redirect($this->redirect);} else {return $this->controller->flash(sprintf(__("Invalid id for %s::edit()", true), Inflector::humanize($this->modelKey)), $this->redirect);}}}if (!empty($this->controller->data)) {if ($action == 'create') {$this->ScaffoldModel->create();}if ($this->ScaffoldModel->save($this->controller->data)) {if ($this->controller->_afterScaffoldSave($action)) {if (isset($this->controller->Session) && $this->controller->Session->valid() != false) {$this->controller->Session->setFlash(sprintf(__('The %1$s has been %2$s', true), Inflector::humanize($this->modelClass), $success));$this->controller->redirect($this->redirect);} else {return $this->controller->flash(sprintf(__('The %1$s has been %2$s', true), Inflector::humanize($this->modelClass), $success), $this->redirect);}} else {return $this->controller->_afterScaffoldSaveError($action);}} else {if (isset($this->controller->Session) && $this->controller->Session->valid() != false) {$this->controller->Session->setFlash(__('Please correct errors below.', true));}}}if (empty($this->controller->data)) {if ($this->ScaffoldModel->id) {$this->controller->data = $this->ScaffoldModel->read();} else {$this->controller->data = $this->ScaffoldModel->create();}}foreach ($this->ScaffoldModel->belongsTo as $assocName => $assocData) {$varName = Inflector::variable(Inflector::pluralize(preg_replace('/(?:_id)$/', '', $assocData['foreignKey'])));$this->controller->set($varName, $this->ScaffoldModel->{$assocName}->find('list'));}foreach ($this->ScaffoldModel->hasAndBelongsToMany as $assocName => $assocData) {$varName = Inflector::variable(Inflector::pluralize($assocName));$this->controller->set($varName, $this->ScaffoldModel->{$assocName}->find('list'));}return $this->__scaffoldForm($formAction);} elseif ($this->controller->_scaffoldError($action) === false) {return $this->__scaffoldError();}}/*** Performs a delete on given scaffolded Model.** @param array $params Parameters for scaffolding* @return mixed Success on delete, error if delete fails* @access private*/function __scaffoldDelete($params = array()) {if ($this->controller->_beforeScaffold('delete')) {if (isset($params['pass'][0])) {$id = $params['pass'][0];} elseif (isset($this->controller->Session) && $this->controller->Session->valid() != false) {$this->controller->Session->setFlash(sprintf(__("No id set for %s::delete()", true), Inflector::humanize($this->modelKey)));$this->controller->redirect($this->redirect);} else {return $this->controller->flash(sprintf(__("No id set for %s::delete()", true), Inflector::humanize($this->modelKey)),'/' . Inflector::underscore($this->controller->viewPath));}if ($this->ScaffoldModel->del($id)) {if (isset($this->controller->Session) && $this->controller->Session->valid() != false) {$this->controller->Session->setFlash(sprintf(__('The %1$s with id: %2$d has been deleted.', true), Inflector::humanize($this->modelClass), $id));$this->controller->redirect($this->redirect);} else {return $this->controller->flash(sprintf(__('The %1$s with id: %2$d has been deleted.', true), Inflector::humanize($this->modelClass), $id), '/' . $this->viewPath);}} else {if (isset($this->controller->Session) && $this->controller->Session->valid() != false) {$this->controller->Session->setFlash(sprintf(__('There was an error deleting the %1$s with id: %2$d', true), Inflector::humanize($this->modelClass), $id));$this->controller->redirect($this->redirect);} else {return $this->controller->flash(sprintf(__('There was an error deleting the %1$s with id: %2$d', true), Inflector::humanize($this->modelClass), $id), '/' . $this->viewPath);}}} elseif ($this->controller->_scaffoldError('delete') === false) {return $this->__scaffoldError();}}/*** Show a scaffold error** @return mixed A rendered view showing the error* @access private*/function __scaffoldError() {return $this->controller->render('error', $this->layout);$this->_output();}/*** When methods are now present in a controller* scaffoldView is used to call default Scaffold methods if:* <code>* var $scaffold;* </code>* is placed in the controller's class definition.** @param array $params Parameters for scaffolding* @return mixed A rendered view of scaffold action, or showing the error* @access private*/function __scaffold($params) {$db = &ConnectionManager::getDataSource($this->ScaffoldModel->useDbConfig);$admin = Configure::read('Routing.admin');if (isset($db)) {if (empty($this->scaffoldActions)) {$this->scaffoldActions = array('index', 'list', 'view', 'add', 'create', 'edit', 'update', 'delete');} elseif (!empty($admin) && $this->scaffoldActions === $admin) {$this->scaffoldActions = array($admin .'_index', $admin .'_list', $admin .'_view', $admin .'_add', $admin .'_create', $admin .'_edit', $admin .'_update', $admin .'_delete');}if (in_array($params['action'], $this->scaffoldActions)) {if (!empty($admin)) {$params['action'] = str_replace($admin . '_', '', $params['action']);}switch ($params['action']) {case 'index':$this->__scaffoldIndex($params);break;case 'view':$this->__scaffoldView($params);break;case 'list':$this->__scaffoldIndex($params);break;case 'add':$this->__scaffoldSave($params, 'add');break;case 'edit':$this->__scaffoldSave($params, 'edit');break;case 'create':$this->__scaffoldSave($params, 'add');break;case 'update':$this->__scaffoldSave($params, 'edit');break;case 'delete':$this->__scaffoldDelete($params);break;}} else {return $this->cakeError('missingAction', array(array('className' => $this->controller->name . "Controller",'base' => $this->controller->base,'action' => $this->action,'webroot' => $this->controller->webroot)));}} else {return $this->cakeError('missingDatabase', array(array('webroot' => $this->controller->webroot)));}}/*** Returns associations for controllers models.** @return array Associations for model* @access private*/function __associations() {$keys = array('belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany');$associations = array();foreach ($keys as $key => $type) {foreach ($this->ScaffoldModel->{$type} as $assocKey => $assocData) {$associations[$type][$assocKey]['primaryKey'] = $this->ScaffoldModel->{$assocKey}->primaryKey;$associations[$type][$assocKey]['displayField'] = $this->ScaffoldModel->{$assocKey}->displayField;$associations[$type][$assocKey]['foreignKey'] = $assocData['foreignKey'];$associations[$type][$assocKey]['controller'] = Inflector::pluralize(Inflector::underscore($assocData['className']));}}return $associations;}}/*** Scaffold View.** @package cake* @subpackage cake.cake.libs.controller*/if (!class_exists('ThemeView')) {App::import('View', 'Theme');}class ScaffoldView extends ThemeView {/*** Override _getViewFileName** @return string action* @access protected*/function _getViewFileName($name = null) {if ($name === null) {$name = $this->action;}$name = Inflector::underscore($name);$admin = Configure::read('Routing.admin');if (!empty($admin) && strpos($name, $admin . '_') !== false) {$name = substr($name, strlen($admin) + 1);}if ($name === 'add') {$name = 'edit';}$scaffoldAction = 'scaffold.' . $name;if (!is_null($this->subDir)) {$subDir = strtolower($this->subDir) . DS;} else {$subDir = null;}$names[] = $this->viewPath . DS . $subDir . $scaffoldAction;$names[] = 'scaffolds' . DS . $subDir . $name;$paths = $this->_paths($this->plugin);$exts = array($this->ext, '.ctp', '.thtml');foreach ($paths as $path) {foreach ($names as $name) {foreach ($exts as $ext) {if (file_exists($path . $name . $ext)) {return $path . $name . $ext;}}}}if ($name === 'scaffolds' . DS . $subDir . 'error') {return LIBS . 'view' . DS . 'errors' . DS . 'scaffold_error.ctp';}return $this->_missingView($paths[0] . $name . $this->ext, 'missingView');}}?>