Source for file jControllerDaoCrud.class.php

Documentation is available at jControllerDaoCrud.class.php

<?php
/**
* @package jelix
* @subpackage controllers
* @author Laurent Jouanneau
* @contributor Bastien Jaillot
* @contributor Thibault Piront (nuKs)
* @contributor Mickael Fradin, Brunto
* @link http://www.jelix.org
* @licence http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public Licence, see LICENCE file
*
*/
/**
* a base class for crud controllers
* @package jelix
* @subpackage controllers
* @since 1.0b3
*/
class jControllerDaoCrud extends jController {
/**
* selector of the dao to use for the crud.
* It should be filled by child controller.
* @var string
*/
protected $dao = '';
/**
* selector of the form to use to edit and display a record
* It should be filled by child controller.
* @var string
*/
protected $form ='';
/**
* list of properties to show in the list page
* if empty list (default), it shows all properties.
* this property is only usefull when you use the default "list" template
* @var array
*/
protected $propertiesForList = array();
/**
* list of properties which serve to order the record list.
* if empty list (default), the list is in a natural order.
* keys are properties name, and values are "asc" or "desc".
* @var array
*/
protected $propertiesForRecordsOrder = array();
/**
* template to display the list of records
* @var string
*/
protected $listTemplate = 'jelix~crud_list';
/**
* template to display the form
* @var string
*/
protected $editTemplate = 'jelix~crud_edit';
/**
* template to display a record
* @var string
*/
protected $viewTemplate = 'jelix~crud_view';
/**
* number of record to display in the list page
* @var integer
*/
protected $listPageSize = 20;
/**
* the template variable name to display a CRUD content in the main template
* of the html response
* @var string
*/
protected $templateAssign = 'MAIN';
/**
* name of the parameter which contains the page offset, for the index action
* @var string
*/
protected $offsetParameterName = 'offset';
/**
* id for the "pseudo" form used to show a record. You can change it if the default one corresponds to
* a possible id in your dao.
* @var string
*/
protected $pseudoFormId = 'jelix_crud_roxor';
/**
* full path to the directory where uploaded files will be stored
* automatically by jForms.
* Set it to false if you want to handle yourself the uploaded files.
* Set it with an empty string if you want to stored files in the default
* var/uploads directory.
* @var string|false
*/
protected $uploadsDirectory ='';
/**
* the jDb profile to use with the dao
*/
protected $dbProfile = '';
/**
* Returned a simple html response to display CRUD contents. You can redefine this
* method to return a personnalized response
* @return jResponseHtml the response
*/
protected function _getResponse(){
return $this->getResponse('html');
}
/**
* create the form. You can redefine this method to modify dynamically the form
* Typically, you call jForms::create and then you can call addControl or whatever.
* Don't do a jForms::get or jForms::fill in this method !
* called in methods: index, precreate, create, preupdate, view
* @return jFormsBase the form
* @since 1.1
*/
protected function _createForm($formId = null) {
return jForms::create($this->form, $formId);
}
/**
* get an existing form. You can redefine this method to modify dynamically the form
* Typically, you call jForms::get and then you can call addControl or whatever.
* Don't do a jForms::create or jForms::fill in this method !
* called in methods: create, savecreate, editupdate, saveupdate
* @return jFormsBase the form
* @since 1.1
*/
protected function _getForm($formId = null) {
return jForms::get($this->form, $formId);
}
/**
* returned the selector of the action corresponding of the given method of the current controller.
* @param string $method name of one of method of this controller
* @return string an action selector
*/
protected function _getAction($method){
global $gJCoord;
return $gJCoord->action->module.'~'.$gJCoord->action->controller.':'.$method;
}
/**
* you can do your own data check of a form by redefining this method.
* You can also do some other things. It is called only if the $form->check() is ok.
* and before the save of the data.
* @param jFormsBase $form the current form
* @param boolean $calltype true for an update, false for a create
* @return boolean true if it is ok.
*/
protected function _checkData($form, $calltype){
return $this->_checkDatas($form, $calltype); // for compatibility
}
/**
* DEPRECATED, use _checkData instead
* @deprecated since 1.1
*/
protected function _checkDatas($form, $calltype){
return true;
}
/**
* list all records
*/
function index(){
$offset = $this->intParam($this->offsetParameterName,0,true);
$rep = $this->_getResponse();
$dao = jDao::get($this->dao, $this->dbProfile);
$cond = jDao::createConditions();
$this->_indexSetConditions($cond);
$results = $dao->findBy($cond,$offset,$this->listPageSize);
$pk = $dao->getPrimaryKeyNames();
// we're using a form to have the portunity to have
// labels for each columns.
$form = $this->_createForm($this->pseudoFormId);
$tpl = new jTpl();
$tpl->assign('list',$results);
$tpl->assign('primarykey', $pk[0]);
if(count($this->propertiesForList)) {
$prop = $this->propertiesForList;
}else{
$prop = array_keys($dao->getProperties());
}
$tpl->assign('properties', $prop);
$tpl->assign('controls',$form->getControls());
$tpl->assign('editAction' , $this->_getAction('preupdate'));
$tpl->assign('createAction' , $this->_getAction('precreate'));
$tpl->assign('deleteAction' , $this->_getAction('delete'));
$tpl->assign('viewAction' , $this->_getAction('view'));
$tpl->assign('listAction' , $this->_getAction('index'));
$tpl->assign('listPageSize', $this->listPageSize);
$tpl->assign('page',$offset>0?$offset:null);
$tpl->assign('recordCount',$dao->countBy($cond));
$tpl->assign('offsetParameterName',$this->offsetParameterName);
$this->_index($rep, $tpl);
$rep->body->assign($this->templateAssign, $tpl->fetch($this->listTemplate));
jForms::destroy($this->form, $this->pseudoFormId);
return $rep;
}
/**
* redefine this method if you wan to do additionnal things on the response and on the list template
* during the index action.
* @param jResponseHtml $resp the response
* @param jtpl $tpl the template to display the record list
*/
protected function _index($resp, $tpl) {
}
/**
* redefine this method if you wan to do additionnal conditions to the index's select
* during the index action.
* @param jDaoConditions $cond the conditions
*/
protected function _indexSetConditions($cond) {
foreach ($this->propertiesForRecordsOrder as $p=>$order) {
$cond->addItemOrder($p, $order);
}
}
/**
* prepare a form to create a record.
*/
function precreate() {
// we cannot create the form directly in the create action
// because if the forms already exists, we wouldn't show
// errors or already filled field. see ticket #292
$form = $this->_createForm();
$this->_preCreate($form);
$rep = $this->getResponse('redirect');
$rep->action = $this->_getAction('create');
return $rep;
}
/**
* redefine this method if you want to do additionnal during the precreate action
* @param jFormsBase $form the form
* @since 1.1
*/
protected function _preCreate($form) {
}
/**
* display a form to create a record
*/
function create(){
$form = $this->_getForm();
if($form == null){
$form = $this->_createForm();
}
$rep = $this->_getResponse();
$tpl = new jTpl();
$tpl->assign('id', null);
$tpl->assign('page' , null);
$tpl->assign('offsetParameterName' , null);
$tpl->assign('form',$form);
$tpl->assign('submitAction', $this->_getAction('savecreate'));
$tpl->assign('listAction' , $this->_getAction('index'));
$this->_create($form, $rep, $tpl);
$rep->body->assign($this->templateAssign, $tpl->fetch($this->editTemplate));
return $rep;
}
/**
* redefine this method if you want to do additionnal things on the response and on the edit template
* during the create action.
* @param jFormsBase $form the form
* @param jResponseHtml $resp the response
* @param jtpl $tpl the template to display the edit form
*/
protected function _create($form, $resp, $tpl) {
}
/**
* redefine this method if you wan to do additionnal things on the dao generated by the
* jFormsBase::prepareDaoFromControls method
* @param jFormsBase $form the form
* @param jDaoRecordBase $form_daorec
* @since 1.1
*/
protected function _beforeSaveCreate($form, $form_daorec) {
}
/**
* save data of a form in a new record
*/
function savecreate(){
$form = $this->_getForm();
$rep = $this->getResponse('redirect');
if($form == null){
$rep->action = $this->_getAction('index');
return $rep;
}
$form->initFromRequest();
if($form->check() && $this->_checkData($form, false)){
$results = $form->prepareDaoFromControls($this->dao,null,$this->dbProfile);
extract($results, EXTR_PREFIX_ALL, "form");//use a temp variable to avoid notices
$this->_beforeSaveCreate($form, $form_daorec);
$form_dao->insert($form_daorec);
$id = $form_daorec->getPk();
$rep->action = $this->_getAction('view');
$rep->params['id'] = $id;
$this->_afterCreate($form, $id, $rep);
if ($this->uploadsDirectory !== false)
$form->saveAllFiles($this->uploadsDirectory);
jForms::destroy($this->form);
return $rep;
} else {
$rep->action = $this->_getAction('create');
return $rep;
}
}
/**
* redefine this method if you wan to do additionnal things after the creation of
* a record. For example, you can handle here the uploaded files. If you do
* such handling, set the uploadsDirectory property to false, to prevent
* the default behavior on uploaded files in the controller.
* @param jFormsBase $form the form object
* @param mixed $id the new id of the inserted record
* @param jResponseHtml $resp the response
*/
protected function _afterCreate($form, $id, $resp) {
}
/**
* prepare a form in order to edit an existing record, and redirect to the editupdate action
*/
function preupdate(){
$id = $this->param('id');
$page = $this->param($this->offsetParameterName);
$rep = $this->getResponse('redirect');
if( $id === null ){
$rep->action = $this->_getAction('index');
return $rep;
}
$form = $this->_createForm($id);
try {
$rec = $form->initFromDao($this->dao, null, $this->dbProfile);
foreach($rec->getPrimaryKeyNames() as $pkn) {
$c = $form->getControl($pkn);
if($c !==null) {
$c->setReadOnly(true);
}
}
}catch(Exception $e){
$rep->action = $this->_getAction('index');
return $rep;
}
$this->_preUpdate($form);
$rep->action = $this->_getAction('editupdate');
$rep->params['id'] = $id;
$rep->params[$this->offsetParameterName] = $page;
return $rep;
}
/**
* redefine this method if you want to do additionnal things during preupdate action
* @param jFormsBase $form the form object
* @since 1.1
*/
protected function _preUpdate($form) {
}
/**
* displays a forms to edit an existing record. The form should be
* prepared with the preupdate before, so a refresh of the page
* won't cause a reset of the form
*/
function editupdate(){
$id = $this->param('id');
$page = $this->param($this->offsetParameterName);
$form = $this->_getForm($id);
if( $form === null || $id === null){
$rep = $this->getResponse('redirect');
$rep->action = $this->_getAction('index');
return $rep;
}
$rep = $this->_getResponse();
$tpl = new jTpl();
$tpl->assign('id', $id);
$tpl->assign('form',$form);
$tpl->assign('page',$page);
$tpl->assign('offsetParameterName',$this->offsetParameterName);
$tpl->assign('submitAction', $this->_getAction('saveupdate'));
$tpl->assign('listAction' , $this->_getAction('index'));
$tpl->assign('viewAction' , $this->_getAction('view'));
$this->_editUpdate($form, $rep, $tpl);
$rep->body->assign($this->templateAssign, $tpl->fetch($this->editTemplate));
return $rep;
}
/**
* redefine this method if you wan to do additionnal things on the response and on the edit template
* during the editupdate action.
* @param jFormsBase $form the form
* @param jResponseHtml $resp the response
* @param jtpl $tpl the template to display the edit form
*/
protected function _editUpdate($form, $resp, $tpl) {
}
/**
* redefine this method if you wan to do additionnal things on the dao generated by the
* jFormsBase::prepareDaoFromControls method
* @param jFormsBase $form the form
* @param jDaoRecordBase $form_daorec
* @param mixed $id the new id of the updated record
* @since 1.1
*/
protected function _beforeSaveUpdate($form, $form_daorec, $id) {
}
/**
* save data of a form in a new record
*/
function saveupdate(){
$rep = $this->getResponse('redirect');
$id = $this->param('id');
$page = $this->param($this->offsetParameterName);
$form = $this->_getForm($id);
if( $form === null || $id === null){
$rep->action = $this->_getAction('index');
return $rep;
}
$form->initFromRequest();
$rep->params[$this->offsetParameterName] = $page;
if($form->check() && $this->_checkData($form, true)){
$results = $form->prepareDaoFromControls($this->dao,$id,$this->dbProfile);
extract($results, EXTR_PREFIX_ALL, "form");//use a temp variable to avoid notices
$this->_beforeSaveUpdate($form, $form_daorec, $id);
$form_dao->update($form_daorec);
$rep->action = $this->_getAction('view');
$rep->params['id'] = $id;
$this->_afterUpdate($form, $id, $rep);
if ($this->uploadsDirectory !== false)
$form->saveAllFiles($this->uploadsDirectory);
jForms::destroy($this->form, $id);
} else {
$rep->action = $this->_getAction('editupdate');
$rep->params['id'] = $id;
}
return $rep;
}
/**
* redefine this method if you wan to do additionnal things after the update of
* a record. For example, you can handle here the uploaded files. If you do
* such handling, set the uploadsDirectory property to false, to prevent
* the default behavior on uploaded files in the controller.
* @param jFormsBase $form the form object
* @param mixed $id the new id of the updated record
* @param jResponseHtml $resp the response
*/
protected function _afterUpdate($form, $id, $resp) {
}
/**
* displays a record
*/
function view(){
$id = $this->param('id');
$page = $this->param($this->offsetParameterName);
if( $id === null ){
$rep = $this->getResponse('redirect');
$rep->action = $this->_getAction('index');
return $rep;
}
$rep = $this->_getResponse();
// we're using a form to display a record, to have the portunity to have
// labels with each values. We need also him to load easily values of some
// of controls with initControlFromDao (to use in _view method).
$form = $this->_createForm($id);
$form->initFromDao($this->dao, $id, $this->dbProfile);
$tpl = new jTpl();
$tpl->assign('id', $id);
$tpl->assign('form',$form);
$tpl->assign('page',$page);
$tpl->assign('offsetParameterName',$this->offsetParameterName);
$tpl->assign('editAction' , $this->_getAction('preupdate'));
$tpl->assign('deleteAction' , $this->_getAction('delete'));
$tpl->assign('listAction' , $this->_getAction('index'));
$this->_view($form, $rep, $tpl);
$rep->body->assign($this->templateAssign, $tpl->fetch($this->viewTemplate));
return $rep;
}
/**
* redefine this method if you want to do additionnal things on the response and on the view template
* during the view action.
* @param jFormsBase $form the form
* @param jResponseHtml $resp the response
* @param jtpl $tpl the template to display the form content
*/
protected function _view($form, $resp, $tpl) {
}
/**
* delete a record
*/
function delete(){
$id = $this->param('id');
$page = $this->param($this->offsetParameterName);
$rep = $this->getResponse('redirect');
$rep->params = array($this->offsetParameterName=>$page);
$rep->action = $this->_getAction('index');
if( $id !== null && $this->_delete($id, $rep) ){
$dao = jDao::get($this->dao, $this->dbProfile);
$dao->delete($id);
}
return $rep;
}
/**
* redefine this method if you want to do additionnal things before the deletion of a record
* @param mixed $id the id of the record to delete
* @return boolean true if the record can be deleted
* @param jResponseHtml $resp the response
*/
protected function _delete($id, $resp) {
return true;
}
}

Documentation generated on Mon, 19 Sep 2011 14:12:05 +0200 by phpDocumentor 1.4.3