From 4c86659bc90d9134b0f901572c5417aa7d9cec18 Mon Sep 17 00:00:00 2001 From: wei <> Date: Tue, 27 Feb 2007 23:27:14 +0000 Subject: Add comments for scaffold, minor changes to TActiveRecord --- .../ActiveRecord/Scaffold/TScaffoldListView.php | 21 +++++- .../Data/ActiveRecord/Scaffold/TScaffoldSearch.php | 75 +++++++++++++++++++--- .../Data/ActiveRecord/Scaffold/TScaffoldView.php | 62 ++++++++++++++++++ 3 files changed, 148 insertions(+), 10 deletions(-) (limited to 'framework/Data/ActiveRecord/Scaffold') diff --git a/framework/Data/ActiveRecord/Scaffold/TScaffoldListView.php b/framework/Data/ActiveRecord/Scaffold/TScaffoldListView.php index 62bf351b..6cb490e3 100644 --- a/framework/Data/ActiveRecord/Scaffold/TScaffoldListView.php +++ b/framework/Data/ActiveRecord/Scaffold/TScaffoldListView.php @@ -21,10 +21,27 @@ Prado::using('System.Data.ActiveRecord.Scaffold.TScaffoldBase'); * The {@link getHeader Header} property is a TRepeater displaying the * Active Record property/field names. The {@link getSort Sort} property * is a drop down list displaying the combination of properties and its possible - * ordering. The {@link getPager Pager} property is a TPager control that - * determines the number of records display in one page (e.g. Page.. + * ordering. The {@link getPager Pager} property is a TPager control displaying + * the links and/or buttons that navigate to different pages in the Active Record data. + * The {@link getList List} property is a TRepeater that renders a row of + * Active Record data. * + * Custom rendering of the each Active Record can be achieved by specifying + * the ItemTemplate or AlternatingItemTemplate property of the main {@linnk getList List} + * repeater. * + * The TScaffoldListView will listen for two command events named "delete" and + * "edit". A "delete" command will delete a the record for the row where the + * "delete" command is originates. An "edit" command will push + * the record data to be edited by a TScaffoldEditView with ID specified by the + * {@link setEditViewID EditViewID}. + * + * Additional {@link setSearchCondition SearchCondition} and + * {@link setSearchParameters SearchParameters} (takes array values) can be + * specified to customize the records to be shown. The {@link setSearchCondition SearchCondition} + * will be used as the Condition property of TActiveRecordCriteria, and similarly + * the {@link setSearchParameters SearchParameters} will be the corresponding + * Parameters property of TActiveRecordCriteria. * * @author Wei Zhuo * @version $Id$ diff --git a/framework/Data/ActiveRecord/Scaffold/TScaffoldSearch.php b/framework/Data/ActiveRecord/Scaffold/TScaffoldSearch.php index a47a1a47..fdfddd4f 100644 --- a/framework/Data/ActiveRecord/Scaffold/TScaffoldSearch.php +++ b/framework/Data/ActiveRecord/Scaffold/TScaffoldSearch.php @@ -1,12 +1,49 @@ - + * @link http://www.pradosoft.com/ + * @copyright Copyright © 2005 PradoSoft + * @license http://www.pradosoft.com/license/ + * @version $Id$ + * @package System.Data.ActiveRecord.Scaffold + */ +/** + * Import the scaffold base. + */ Prado::using('System.Data.ActiveRecord.Scaffold.TScaffoldBase'); +/** + * TScaffoldSearch provide a simple textbox and a button that is used + * to perform search on a TScaffoldListView with ID given by {@link setListViewID ListViewID}. + * + * The {@link getSearchText SearchText} property is a TTextBox and the + * {@link getSearchButton SearchButton} property is a TButton with label value "Search". + * + * Searchable fields of the Active Record can be restricted by specifying + * a comma delimited string of allowable fields in the + * {@link setSearchableFields SearchableFields} property. The default is null, + * meaning that most text type fields are searched (the default searchable fields + * are database dependent). + * + * @author Wei Zhuo + * @version $Id$ + * @package System.Data.ActiveRecord.Scaffold + * @since 3.1 + */ class TScaffoldSearch extends TScaffoldBase { + /** + * @var TScaffoldListView the scaffold list view. + */ private $_list; - public function getListView() + /** + * @return TScaffoldListView the scaffold list view this search box belongs to. + */ + protected function getListView() { if($this->_list===null && ($id = $this->getListViewID()) !== null) { @@ -17,21 +54,26 @@ class TScaffoldSearch extends TScaffoldBase return $this->_list; } - public function setListView($value) - { - $this->_list = $value; - } - + /** + * @param string ID of the TScaffoldListView this search control belongs to. + */ public function setListViewID($value) { $this->setViewState('ListViewID', $value); } + /** + * @return string ID of the TScaffoldListView this search control belongs to. + */ public function getListViewID() { return $this->getViewState('ListViewID'); } + /** + * Sets the SearchCondition of the TScaffoldListView as the search terms + * given by the text of the search text box. + */ public function bubbleEvent($sender, $param) { if(strtolower($param->getCommandName())==='search') @@ -39,7 +81,6 @@ class TScaffoldSearch extends TScaffoldBase if(($list = $this->getListView()) !== null) { $list->setSearchCondition($this->createSearchCondition()); - $list->setSearchParameters(array()); return false; } } @@ -47,6 +88,9 @@ class TScaffoldSearch extends TScaffoldBase return true; } + /** + * @return string the search criteria for the search terms in the search text box. + */ protected function createSearchCondition() { $table = $this->getTableMetaData(); @@ -54,6 +98,9 @@ class TScaffoldSearch extends TScaffoldBase return $table->getSearchRegExpCriteria($this->getFields(), $str); } + /** + * @return array list of fields to be searched. + */ protected function getFields() { if(strlen(trim($str=$this->getSearchableFields()))>0) @@ -63,22 +110,34 @@ class TScaffoldSearch extends TScaffoldBase return $fields; } + /** + * @return string comma delimited list of fields that may be searched. + */ public function getSearchableFields() { return $this->getViewState('SearchableFields',''); } + /** + * @param string comma delimited list of fields that may be searched. + */ public function setSearchableFields($value) { $this->setViewState('SearchableFields', $value, ''); } + /** + * @return TButton button with default label "Search". + */ public function getSearchButton() { $this->ensureChildControls(); return $this->getRegisteredObject('_search'); } + /** + * @return TTextBox search text box. + */ public function getSearchText() { $this->ensureChildControls(); diff --git a/framework/Data/ActiveRecord/Scaffold/TScaffoldView.php b/framework/Data/ActiveRecord/Scaffold/TScaffoldView.php index 5401c764..c144fe37 100644 --- a/framework/Data/ActiveRecord/Scaffold/TScaffoldView.php +++ b/framework/Data/ActiveRecord/Scaffold/TScaffoldView.php @@ -1,12 +1,49 @@ + * @link http://www.pradosoft.com/ + * @copyright Copyright © 2005 PradoSoft + * @license http://www.pradosoft.com/license/ + * @version $Id$ + * @package System.Data.ActiveRecord.Scaffold + */ +/** + * Import scaffold base, list, edit and search controls. + */ Prado::using('System.Data.ActiveRecord.Scaffold.TScaffoldBase'); Prado::using('System.Data.ActiveRecord.Scaffold.TScaffoldListView'); Prado::using('System.Data.ActiveRecord.Scaffold.TScaffoldEditView'); Prado::using('System.Data.ActiveRecord.Scaffold.TScaffoldSearch'); +/** + * TScaffoldView is a composite control consisting of TScaffoldListView + * with a TScaffoldSearch. In addition, it will display a TScaffoldEditView + * when an "edit" command is raised from the TScaffoldListView (when the + * edit button is clicked). Futher more, the "add" button can be clicked + * that shows an empty data TScaffoldListView for creating new records. + * + * The {@link getListView ListView} property gives a TScaffoldListView for + * display the record data. The {@link getEditView EditView} is the + * TScaffoldEditView that renders the + * inputs for editing and adding records. The {@link getSearchControl SearchControl} + * is a TScaffoldSearch responsible to the search user interface. + * + * Set the {@link setRecordClass RecordClass} property to the name of + * the Active Record class to be displayed/edited/added. + * + * @author Wei Zhuo + * @version $Id$ + * @package System.Data.ActiveRecord.Scaffold + * @since 3.0 + */ class TScaffoldView extends TScaffoldBase { + /** + * Copy basic record details to the list/edit/search controls. + */ public function onLoad($param) { parent::onLoad($param); @@ -15,30 +52,46 @@ class TScaffoldView extends TScaffoldBase $this->getSearchControl()->copyFrom($this); } + /** + * @return TScaffoldListView scaffold list view. + */ public function getListView() { $this->ensureChildControls(); return $this->getRegisteredObject('_listView'); } + /** + * @return TScaffoldEditView scaffold edit view. + */ public function getEditView() { $this->ensureChildControls(); return $this->getRegisteredObject('_editView'); } + /** + * @return TScaffoldSearch scaffold search textbox and button. + */ public function getSearchControl() { $this->ensureChildControls(); return $this->getRegisteredObject('_search'); } + /** + * @return TButton "Add new record" button. + */ public function getAddButton() { $this->ensureChildControls(); return $this->getRegisteredObject('_newButton'); } + /** + * Handle the "edit" and "new" commands by displaying the edit view. + * Default command shows the list view. + */ public function bubbleEvent($sender,$param) { switch(strtolower($param->getCommandName())) @@ -53,6 +106,9 @@ class TScaffoldView extends TScaffoldBase return false; } + /** + * Shows the edit record view. + */ protected function showEditView($sender, $param) { $this->getListView()->setVisible(false); @@ -63,6 +119,9 @@ class TScaffoldView extends TScaffoldBase $this->getEditView()->getClearButton()->setVisible(false); } + /** + * Shows the view for listing the records. + */ protected function showListView($sender, $param) { $this->getListView()->setVisible(true); @@ -71,6 +130,9 @@ class TScaffoldView extends TScaffoldBase $this->getSearchControl()->setVisible(true); } + /** + * Shows the add record view. + */ protected function showAddView($sender, $param) { $this->getEditView()->setRecordPk(null); -- cgit v1.2.3