AdminAction 類別參考文件
[Action]

類別AdminAction的繼承圖:

全部成員列表


公開方法(Public Methods)
	AdminAction ($actionInfo, $request)
	setCommonData ($copyFormValues=false)
	notifyEvent ($eventType, $params=Array())
公開屬性
	$_blogInfo
	$_userInfo
	$_session
	$_config
	$_locale
	$_pm
	$_userBlogs
私有方法(Private Methods)
	_getBlogInfo ()
	_getUserInfo ()
&	getLocale ()
	saveSession ()
	mustAuthenticatePage ()

詳細描述

In the same way BlogAction sets some predefined information to be available for every action for the public side of the blog, this one does the same but for the administrative interface. So far it fetches information from the session, such as the UserInfo and the BlogInfo objects so that they are available for every template.

This is the most basic action for the admin interface and it allows all users to see them. If you need to create an action that can only be accessed by users with certain privileges, please use BlogOwnerAdminAction and SiteAdminAction.

參閱:: BlogOwnerAdminAction
SiteAdminAction

定義在 adminaction.class.php 檔案之第 28 行.

建構子與解構子說明文件

AdminAction::AdminAction	(	$	actionInfo,
		$	request
	)

Constructor.

參數:

	actionInfo	An ActionInfo object as provided by the constroller
	request	A valid HTTP request

定義在 adminaction.class.php 檔案之第 45 行.

參考 $request, $session, _getBlogInfo(), _getUserInfo(), Action::Action(), die, Config::getConfig(), HttpVars::getSession(), mustAuthenticatePage(), 及 print.

00046         {
00047             $this->Action( $actionInfo, $request );
00048     
00049             // get information about the session
00050             $session = HttpVars::getSession();
00051             $this->_session = $session["SessionInfo"];
00052 
00053             $this->_config  =& Config::getConfig();
00054 
00055             // get the information about the user and quit if we don't have it...
00056             $this->_getUserInfo();
00057             if( $this->_userInfo == "" ) {
00058                 header( "HTTP/1.0 403 Forbidden" );
00059                 print($this->mustAuthenticatePage());
00060                 die();
00061             }
00062 
00063             // do the same with the information about the blog
00064             $this->_getBlogInfo();
00065             if( $this->_blogInfo == "" ) {
00066                 if( $this->_actionInfo->getActionParamValue() != "blogSelect" ) {
00067                     header( "HTTP/1.0 403 Forbidden" );
00068                     print($this->mustAuthenticatePage());
00069                     die();
00070                 }
00071             }
00072             
00073             // prepare the plugin manager in case we'd like to throw events
00074             $this->_pm =& PluginManager::getPluginManager();            
00075             
00076             // fetch the site locale
00077             $this->_locale =& $this->getLocale();
00078 
00079             $users =& new Users();
00080             $this->_userBlogs = $users->getUsersBlogs( $this->_userInfo->getId(), BLOG_STATUS_ACTIVE );            
00081         }

函式成員說明文件

AdminAction::_getBlogInfo ( ) [private]

Retrieves the blogInfo object from the session

定義在 adminaction.class.php 檔案之第 87 行.

參考 $session, 及 HttpVars::getSession().

被參考於 AdminAction().

00088         {
00089             $session = HttpVars::getSession();
00090             $sessionInfo = $session["SessionInfo"];
00091 
00092             $this->_blogInfo = $sessionInfo->getValue( "blogInfo" );
00093         }

AdminAction::_getUserInfo ( ) [private]

Retrieves the userInfo object from the session

定義在 adminaction.class.php 檔案之第 99 行.

參考 $session, 及 HttpVars::getSession().

被參考於 AdminAction().

00100         {
00101             $session = HttpVars::getSession();
00102             $sessionInfo = $session["SessionInfo"];
00103             $this->_userInfo = $sessionInfo->getValue("userInfo");
00104         }

& AdminAction::getLocale ( ) [private]

sets the default locale, in case we want to send localized messages to the user.

定義在 adminaction.class.php 檔案之第 110 行.

參考 Locales::getLocale().

00111         {
00112             // don't like this so much...
00113             if( $this->_blogInfo != "" ) {
00114                 $this->_blogSettings = $this->_blogInfo->getSettings();
00115                 //$locale =& Locales::getLocale( $this->_blogSettings->getValue("locale"));
00116                 $locale =& $this->_blogInfo->getLocale();
00117             }
00118             else {
00119                 $locale =& Locales::getLocale( $this->_config->getValue("default_locale"));
00120             }
00121             
00122             return $locale;
00123         }

AdminAction::mustAuthenticatePage ( ) [private]

Generates a page which shows an "access forbidden" message, prompting the user to authenticate first using the login page.

定義在 adminaction.class.php 檔案之第 170 行.

被參考於 AdminAction().

00171         {
00172             $view = new AdminDefaultView();
00173             $locale = $this->getLocale();
00174             $view->setErrorMessage( $locale->tr("error_access_forbidden" ));
00175             return $view->render();
00176         }

AdminAction::notifyEvent	(	$	eventType,
		$	params = `Array()`
	)

centralized way of throwing events, it also adds some useful information so that child classes do not have to do it

參數:

	eventType
	params

參閱:: PluginManager::notifyEvent()

定義在 adminaction.class.php 檔案之第 187 行.

參考 $params.

00188         {
00189             $params[ "from" ] = $this->_actionInfo->getActionParamValue();
00190             $params[ "request" ] = $this->_request;
00191             
00192             return $this->_pm->notifyEvent( $eventType, $params );
00193         }

AdminAction::saveSession ( ) [private]

Saves the session data

定義在 adminaction.class.php 檔案之第 155 行.

參考 $session, HttpVars::getSession(), 及 HttpVars::setSession().

被參考於 AdminUpdateUserSettingsAction::perform(), AdminUpdateEditBlogAction::perform(), 及 AdminUpdateBlogSettingsAction::perform().

00156         {
00157             $this->_session->setValue( "blogInfo", $this->_blogInfo );
00158             $this->_session->setValue( "userInfo", $this->_userInfo );
00159             //$_SESSION["SessionInfo"] = $this->_session;
00160             $session = HttpVars::getSession();
00161             $session["SessionInfo"] = $this->_session;
00162             HttpVars::setSession( $session );
00163         }

AdminAction::setCommonData ( $ copyFormValues = false )

Adds some common data to the view. this function must be manually called once we've set up a view.

參數:

copyFormValues

參閱:: Action::setCommonData()

依據Action重新實作.

定義在 adminaction.class.php 檔案之第 132 行.

00133         {   
00134             parent::setCommonData( $copyFormValues );
00135 
00136             // initialiaze plugins
00137             $this->_pm->setBlogInfo( $this->_blogInfo );
00138             $this->_pm->setUserInfo( $this->_userInfo );
00139             $this->_pm->getPlugins();           
00140             
00141             $this->_view->setValue( "user", $this->_userInfo );
00142             $this->_view->setValue( "userBlogs", $this->_userBlogs);
00143             $this->_view->setUserInfo( $this->_userInfo );
00144             $this->_view->setValue( "blog", $this->_blogInfo );
00145             $this->_view->setValue( "blogsettings", $this->_blogInfo->getSettings());
00146             $this->_view->setValue( "op", $this->_actionInfo->_actionParamValue );
00147             $this->_view->setValue( "locale", $this->_locale );
00148             $this->_view->setValue( "config", $this->_config );
00149         }

資料成員說明文件

AdminAction::$_blogInfo

定義在 adminaction.class.php 檔案之第 31 行.

AdminAction::$_config

定義在 adminaction.class.php 檔案之第 34 行.

AdminAction::$_locale

在AdminSendTrackbacksAction重新實作.

定義在 adminaction.class.php 檔案之第 35 行.

AdminAction::$_pm

定義在 adminaction.class.php 檔案之第 36 行.

AdminAction::$_session

定義在 adminaction.class.php 檔案之第 33 行.

AdminAction::$_userBlogs

定義在 adminaction.class.php 檔案之第 37 行.

AdminAction::$_userInfo

定義在 adminaction.class.php 檔案之第 32 行.

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

class/action/admin/adminaction.class.php

AdminAction 類別 參考文件 [Action]

公開方法(Public Methods)

公開屬性

私有方法(Private Methods)

詳細描述

建構子與解構子說明文件

函式成員說明文件

資料成員說明文件

AdminAction 類別參考文件
[Action]