Action 類別參考文件
[Action]

類別Action的繼承圖:

全部成員列表


公開方法(Public Methods)
	Action ($actionInfo, $httpRequest)
	perform ()
	validate ()
	validationErrorProcessing ()
	setValidationErrorView ($view)
	registerFieldValidator ($fieldName, $validator, $onlyIfAvailable=false)
	registerField ($fieldName)
	getView ()
	setCommonData ($copyFormValues=false)
	setForwardAction ($nextActionKey)
	setSuccess ($success)
公開屬性
	$_view
	$_request
	$_actionInfo
	$_fieldValidators
	$_validationErrorView
	$_previousAction
	$_isSuccess
私有方法(Private Methods)
	setPreviousAction ($previousAction)
	getPreviousAction ()
	setForwardActionParameter ($param, $value)

詳細描述

The base most basic action class is Action, which provides some common code and the Action::perform() method which should be implemented by child classes wishing to provide some business logic. At the end of the method, an Action class is expected to generate a valid View object (or a child class of View) that will be used by the Controller to render some contents to be sent to the client.

Action classes are expected to at least provide their own logic in the Action::perform() method. In previous versions of pLog it was also necessary to provide data validation logic in the Action::validate() method, but that is not necessary anymore (albeit possible if needed) since the introduction of the new data validation framework (See the FormValidator class and the Validator and Validator_Rules modules) The Action::validate() method now provides some code of its own that triggers the data validation process if there is any data to be validated.

There is a lot more information about the data validation framework here: http://wiki.plogworld.net/index.php/PLog_1.0/Forms_and_data_validation

The View object that Action classes must create can be set via the private attribute Action::_view or te method Action::setView(), though the first one is the most widely used throughout the core code.

Please keep in mind that it is advisable to call the Action::setCommonData() method at the very end of the Action::perform() method in our custom classes because it needs to perform some extra operations right before the view is sent back to the controller.

定義在 action.class.php 檔案之第 56 行.

建構子與解構子說明文件

Action::Action	(	$	actionInfo,
		$	httpRequest
	)

Constructor.

參數:

	actionInfo	An ActionInfo object contaning information about the action
	httpRequest	the HTTP request.

定義在 action.class.php 檔案之第 74 行.

參考 Object::Object().

被參考於 AdminAction::AdminAction(), AdminDefaultAction::AdminDefaultAction(), AdminLoginAction::AdminLoginAction(), BlogAction::BlogAction(), ResourceServerAction::ResourceServerAction(), SummaryAction::SummaryAction(), UpdateStepThree::UpdateStepThree(), WizardIntro::WizardIntro(), WizardStepFive::WizardStepFive(), WizardStepFour::WizardStepFour(), 及 WizardStepOne::WizardStepOne().

00075         {
00076             $this->Object();
00077 
00078             $this->_request = new Request( $httpRequest );
00079 
00080             $this->_actionInfo = $actionInfo;
00081             
00082             $this->_fieldValidators = Array();
00083             
00084             // initialize the views to empty values
00085             $this->_view = null;
00086             $this->_validationErrorView = null;
00087             
00088             // form object, used for data validation
00089             $this->_form = new FormValidator();
00090             
00091             // no previous action
00092             $this->_previousAction = null;
00093             
00094             // by default, the action is successful
00095             $this->_isSuccess = true;
00096         }

函式成員說明文件

Action::getPreviousAction ( ) [private]

returns the reference to the previous action in the process flow

傳回值:: A valid Action object, or null if there is no previous action

定義在 action.class.php 檔案之第 115 行.

00116         {
00117             return $this->_previousAction;
00118         }

Action::getView

(

)

This function does not need to be reimplemented by the childs of this class. It just returns the resulting view of the operation.

傳回值:: A valid View object

定義在 action.class.php 檔案之第 246 行.

00247         {
00248             return $this->_view;
00249         }

Action::perform

(

)

Receives the HTTP request from the client as parameter, so that we can extract the parameters and perform our business logic.

The result of this will be a view, which will normally be the output of the processing we just did or for example an error view showing an error message. Once we have completed processing, the controller will call the getView() method to get the resulting view and send it back to the customer.

傳回值:: Returns nothing

定義在 action.class.php 檔案之第 131 行.

00132         {   
00133             // to be implemented by child classes...
00134         }

Action::registerField

(

fieldName

)

registers a new field whose value should be available to the view/template in case it needs to be reshown.Those fields that haven't been registered, will *not* be shown when rerunning the view.

參數:

fieldName

The name of the field from the form that we're going to register

參閱:: FormValidator

定義在 action.class.php 檔案之第 232 行.

被參考於 AdminAddBlogUserAction::AdminAddBlogUserAction(), AdminAddPostAction::AdminAddPostAction(), AdminAddUserAction::AdminAddUserAction(), AdminEditPostAction::AdminEditPostAction(), AdminUpdateBlogSettingsAction::AdminUpdateBlogSettingsAction(), AdminUpdateEditBlogAction::AdminUpdateEditBlogAction(), AdminUpdatePostAction::AdminUpdatePostAction(), AdminUpdateResourceAction::AdminUpdateResourceAction(), AdminUpdateResourceAlbumAction::AdminUpdateResourceAlbumAction(), AdminUpdateUserProfileAction::AdminUpdateUserProfileAction(), AdminUpdateUserSettingsAction::AdminUpdateUserSettingsAction(), 及 WizardStepFour::WizardStepFour().

00233         {
00234             $this->_form->registerField( $fieldName );
00235             
00236             return true;
00237         }

Action::registerFieldValidator	(	$	fieldName,
		$	validator,
		$	onlyIfAvailable = `false`
	)

registers a new validator, for validating data coming from fields

參數:

	fieldName	The name of the field from the form that we're going to validate
	validator	A valid class inheriting from the Validator base class and that implements the validate() method, that will be used for validating fields.
	onlyIfAvailable	validate this field only if its value is not emtpy

傳回值:: Always true

參閱:: FormValidator
Validator

定義在 action.class.php 檔案之第 217 行.

00218         {
00219             $this->_form->registerFieldValidator( $fieldName, $validator, $onlyIfAvailable );
00220             
00221             return true;
00222         }

Action::setCommonData ( $ copyFormValues = false )

we can do things here that are common to all the views. This method must be called just before the Action::perform() method has finished its processing since most of the child Action classes use it to do some kind of post-processing.

參數:

copyFormValues

Whether the values from fields that were registered via Action::registerFieldValidator() and Action::registerField() should be passed back to the view as variables or not. It defaults to 'false' but this parameter is useful in those cases when we would like to force an error to happen (not a validation error) and still keep the form values.

傳回值:: Always true

在AdminAction, BlogAction, 及 SummaryAction重新實作.

定義在 action.class.php 檔案之第 263 行.

被參考於 UpdateStepThree::perform(), UpdateStepOne::perform(), WizardStepFive::perform(), WizardStepFour::perform(), WizardStepThree::perform(), WizardStepTwo::perform(), WizardStepOne::perform(), WizardIntro::perform(), AdminLoginAction::perform(), 及 validationErrorProcessing().

00264         {
00265             $this->_view->setValue( "form", $this->_form );
00266             
00267             if( $copyFormValues ) {
00268                 // in case we'd like to copy the values from the form
00269                 $fieldValues = $this->_form->getFieldValues();
00270                 foreach( $fieldValues as $fieldName => $fieldValue ) {
00271                     $this->_view->setValue( "$fieldName", $fieldValue );
00272                 }
00273             }
00274             
00275             return true;
00276         }

Action::setForwardAction

(

nextActionKey

)

after executing the current action we will not show the results but transfer the execution flow to another action. In other words, the Controller will detect that the processing is being passed to another Action class and instead of calling Action::getView() right after Action::perform() it will call the perform() method of the next action in the flow. It is only possible to specify one action to forward to at a time, but this feature can be used as many times as needed.

參數:

actionKey

The key of the action to which we're forwarding the process flow. This is not the class name of the action but the key name to which the action class has been assigned.

傳回值:: Always true

定義在 action.class.php 檔案之第 292 行.

參考 Controller::setForwardAction().

00293          {       
00294             Controller::setForwardAction( $nextActionKey, $this );
00295             
00296             return true;
00297          }

Action::setForwardActionParameter	(	$	param,
		$	value
	)	`[private]`

sets a parameter in the session... or in other words, make it available for the next coming action.

參數:

	param
	value

傳回值:: Always true

定義在 action.class.php 檔案之第 308 行.

00309          {
00310             return true;
00311          }

Action::setPreviousAction ( $ previousAction ) [private]

參數:

previousAction

a valid Action object

傳回值:: Always true

定義在 action.class.php 檔案之第 104 行.

00105         {
00106             $this->_previousAction = $previousAction;
00107         }

Action::setSuccess

(

success

)

This method can be used to trigger validation errors even if they did not really happen, or to disable errors if they happened.

參數:

success

Whether to force or unforce an error

定義在 action.class.php 檔案之第 319 行.

00320          {
00321              $this->_isSuccess = $success;
00322              $this->_form->setFormIsValid( $success );   
00323          }

Action::setValidationErrorView

(

view

)

sets the view that will be shown in case there is an error during the validation process... It makes things a bit easier for us when it comes to validate data. This view will only be used if validate() generates a validation error or if we force the action to generate an error via Action::setSuccess()

參數:

view

A valid View object

傳回值:: Always true

參閱:: View

定義在 action.class.php 檔案之第 199 行.

00200         {
00201             $this->_view = $view;
00202             
00203             return true;
00204         }

Action::validate

(

)

This method can be used for data validation and is always executed before perform(). If it returns 'true', execution will continue as normal. If it returns 'false', the process will be stopped and the current contents of the view will be returned. If the view is empty, an exception will be thrown.

As of pLog 1.0, it is not necessary to implement data validation code here and it is recommended to use the data validation framework (see methods Action::registerFieldValidator() and related) There is more information about the data validation framework in the wiki: http://wiki.plogworld.net/index.php/PLog_1.0/Forms_and_data_validation.

With the default code provided in the Action::validate() method, the callback method Action::validationErrorProcessing() will be called and after that, the view set via the Action::setValidationErrorView() will be used to generate the contents of the error message.

傳回值:: Returns true if data is correct or false otherwise. See above for more details.

在AddCommentAction, AdminAddBlogTemplateAction, AdminAddLocaleAction, AdminMainAction, AdminNewResourceAction, AdminPostStatsAction, AdminSendTrackbacksAction, AdminUpdateGlobalSettingsAction, AdminUpdateResourceAction, AdminUpdateUserSettingsAction, AdminUserPictureSelectAction, AdminXmlSaveDraftAction, DefaultAction, ResourceServerAction, ViewAlbumAction, ViewArticleAction, ViewArticleTrackbacksAction, ViewResourceAction, SummaryRssAction, SummarySearchAction, SummarySetNewPassword, UpdateStepTwo, 及 UpdateStepFour重新實作.

定義在 action.class.php 檔案之第 152 行.

參考 validationErrorProcessing().

被參考於 SummaryCustomPageAction::perform().

00153         {
00154             // use the FormValidator object to validate the data
00155             $validationOk =  $this->_form->validate( $this->_request );
00156             
00157             // if something went wrong... let's do somethinga about it :)
00158             if( !$validationOk ) {
00159                 $this->validationErrorProcessing();
00160             }
00161             
00162             return $validationOk;
00163         }

Action::validationErrorProcessing

(

)

This method will be called when a validation error happens. Child classes are free to extend or reimplement this one and can be used as some sort of a trigger in order to do some cleanup if needed.

�

傳回值:: nothing

在AddCommentAction, 及 RegisterAction重新實作.

定義在 action.class.php 檔案之第 172 行.

參考 setCommonData().

被參考於 validate().

00173         {
00174             // if there was a validaton error, then inform the view
00175             $this->_view->setError( true );
00176                 
00177             // and  export all the data to the view so that it can be reused in the error view
00178             $fieldValues = $this->_form->getFieldValues();
00179             foreach( $fieldValues as $fieldName => $fieldValue ) {
00180                 $this->_view->setValue( "$fieldName", $fieldValue );
00181             }
00182                 
00183             $this->_form->setFormIsValid( false );
00184             $this->setCommonData();
00185     
00186             return true;
00187         }

資料成員說明文件

Action::$_actionInfo

定義在 action.class.php 檔案之第 62 行.

Action::$_fieldValidators

定義在 action.class.php 檔案之第 63 行.

Action::$_isSuccess

定義在 action.class.php 檔案之第 66 行.

Action::$_previousAction

定義在 action.class.php 檔案之第 65 行.

Action::$_request

定義在 action.class.php 檔案之第 61 行.

Action::$_validationErrorView

定義在 action.class.php 檔案之第 64 行.

Action::$_view

定義在 action.class.php 檔案之第 60 行.

此類別(class) 文件是由下列檔案中產生:

class/action/action.class.php

Action 類別 參考文件 [Action]

公開方法(Public Methods)

公開屬性

私有方法(Private Methods)

詳細描述

建構子與解構子說明文件

函式成員說明文件

資料成員說明文件

Action 類別參考文件
[Action]