CMSimple_XH 開発者ドキュメント
XH\Controller クラス

公開メンバ関数

 initTemplatePaths ()
 
 handleSearch ()
 
 makeSearch ()
 
 handleMailform ()
 
 makeMailform ()
 
 handleSitemap ()
 
 handlePasswordForgotten ()
 
 makePasswordForgotten ()
 
 handleLoginAndLogout ()
 
 handleLogin ()
 
 handleLogout ()
 
 handleKeepAlive ()
 
 setFrontendF ()
 
 setBackendF ()
 
 wantsSavePageData ()
 
 handleSavePageData ()
 
 handlePagedataEditor ()
 
 makePageDataEditor ()
 
 handleFileView ()
 
 handleFileBackup ()
 
 handleFileEdit ()
 
 outputAdminScripts ()
 
 setFunctionsAsPermitted ()
 
 handleSaveRequest ()
 
 wantsEditContents ()
 
 outputEditContents ()
 
 isFilebrowserMissing ()
 
 isPagemanagerMissing ()
 
 reportMissingExternal ($name)
 
 verifyAdm ()
 
 renderErrorMessages ()
 
 sendStandardHeaders ()
 

限定公開メンバ関数

 makeFileEditor ($class)
 

詳解

Controller.php29 行目に定義があります。

関数詳解

◆ handleFileBackup()

XH\Controller::handleFileBackup ( )

Handles file backup requests.

戻り値
void

string The name of a special file to be handled. CSRFProtection The CRSF protector.

Controller.php481 行目に定義があります。

◆ handleFileEdit()

XH\Controller::handleFileEdit ( )

Handles file edit requests.

戻り値
void

string The name of a special file to be handled. string The requested action. string The HTML for the contents area.

Controller.php503 行目に定義があります。

◆ handleFileView()

XH\Controller::handleFileView ( )

Handles file view requests.

戻り値
void

array The paths of system files and folders. string The name of a special file to be handled. string The HTML for the contents area.

Controller.php460 行目に定義があります。

◆ handleKeepAlive()

XH\Controller::handleKeepAlive ( )

Handles Ajax request to keep the admin session alive.

戻り値
void

Controller.php274 行目に定義があります。

◆ handleLogin()

XH\Controller::handleLogin ( )

Handles login requests.

戻り値
void

string The requested function. array The paths of system files and folders. string The admin password. string Whether login is requested. array The configuration of the core.

Controller.php219 行目に定義があります。

◆ handleLoginAndLogout()

XH\Controller::handleLoginAndLogout ( )

Handles login and logout.

戻り値
void

string Whether admin mode is active. string Whether login is requested. string Whether logout is requested. string The admin password. string The requested function.

Controller.php190 行目に定義があります。

◆ handleLogout()

XH\Controller::handleLogout ( )

Handles logout requests.

戻り値
void

string Whether admin mode is active. string The requested function. string Whether logout is requested. array The localization of the core. string The HTML for the contents area.

Controller.php253 行目に定義があります。

◆ handleMailform()

XH\Controller::handleMailform ( )

Handles mailform requests.

戻り値
void

array The configuration of the core. array The localization of the core. string The content of the title element. string The HTML of the contents area.

Controller.php104 行目に定義があります。

◆ handlePagedataEditor()

XH\Controller::handlePagedataEditor ( )

Handles page data editor requests.

戻り値
void

string The HTML for the contents area.

todo:
Unused?

Controller.php433 行目に定義があります。

◆ handlePasswordForgotten()

XH\Controller::handlePasswordForgotten ( )

Handles password forgotten requests.

戻り値
void

Controller.php163 行目に定義があります。

◆ handleSavePageData()

XH\Controller::handleSavePageData ( )

Handles save page data requests.

戻り値
void

array The paths of system files and folders. int The index of the currently selected page. PageDataRouter The page data router. array The localization of the core. CSRFProtection The CSRF protector.

Controller.php400 行目に定義があります。

◆ handleSaveRequest()

XH\Controller::handleSaveRequest ( )

Handles save requests.

戻り値
void

string The text of the editor on save. CSRFProtection The CSRF protector.

Controller.php609 行目に定義があります。

◆ handleSearch()

XH\Controller::handleSearch ( )

Handles search requests.

戻り値
void

array The paths of system files and folders. array The localization of the core. string The content of the title element. string The HTML of the contents area.

Controller.php66 行目に定義があります。

◆ handleSitemap()

XH\Controller::handleSitemap ( )

Handles sitemap requests.

戻り値
void

int The number of pages. array The configuration of the core. array The localization of the core. string The content of the title element. string The HTML of the content area.

todo:
Declare visibility.

Controller.php143 行目に定義があります。

◆ initTemplatePaths()

XH\Controller::initTemplatePaths ( )

Initializes the paths related to the template.

戻り値
void

array The paths of system files and folders. array The configuration of the core. array The localization of the core.

Controller.php40 行目に定義があります。

◆ isFilebrowserMissing()

XH\Controller::isFilebrowserMissing ( )

Returns whether the filebrowser is missing.

戻り値
bool

Controller.php661 行目に定義があります。

◆ isPagemanagerMissing()

XH\Controller::isPagemanagerMissing ( )

Returns whether the page manager is missing.

戻り値
bool

string The requested function.

Controller.php674 行目に定義があります。

◆ makeFileEditor()

XH\Controller::makeFileEditor (   $class)
protected

Makes and returns a file edit object.

引数
string$classA class name.
戻り値
FileEdit

Controller.php531 行目に定義があります。

◆ makeMailform()

XH\Controller::makeMailform ( )

Makes and returns a mailform object.

戻り値
Mailform

Controller.php125 行目に定義があります。

◆ makePageDataEditor()

XH\Controller::makePageDataEditor ( )

Makes and returns a new page data editor object.

戻り値
PageDataEditor

Controller.php446 行目に定義があります。

◆ makePasswordForgotten()

XH\Controller::makePasswordForgotten ( )

Makes and returns a password forgotten object.

戻り値
PasswordForgotten

Controller.php174 行目に定義があります。

◆ makeSearch()

XH\Controller::makeSearch ( )

Makes and returns a search object.

戻り値
Search

string The search string.

Controller.php87 行目に定義があります。

◆ outputAdminScripts()

XH\Controller::outputAdminScripts ( )

Outputs administration script elements.

戻り値
void

array The localization of the core. string The HTML for the contents area.

Controller.php544 行目に定義があります。

◆ outputEditContents()

XH\Controller::outputEditContents ( )

Outputs the edit contents (either editor or cntlocateheading).

戻り値
void

int The index of the currently selected page. array The localization of the core. string The HTML for the contents area.

Controller.php645 行目に定義があります。

◆ renderErrorMessages()

XH\Controller::renderErrorMessages ( )

Renders the error messages stored in $e.

戻り値
string HTML

string The HTML for the s holding error messages.

Controller.php782 行目に定義があります。

◆ reportMissingExternal()

XH\Controller::reportMissingExternal (   $name)

Reports a missing external plugin.

引数
string$nameA plugin name ("filebrowser" or "pagemanger").
戻り値
bool

array The configuration of the core. array The localization of the core. string The HTML for the s holding error messages.

Controller.php737 行目に定義があります。

◆ sendStandardHeaders()

XH\Controller::sendStandardHeaders ( )

Sends the standard HTTP headers to the client.

If that's not possible, a respective error message is send and the script is aborted.

戻り値
void

string The ISO 659-1 code of the current language. array The configuration of the core. array The localization of the core.

todo:
Emit error message only in admin mode?

Controller.php808 行目に定義があります。

◆ setBackendF()

XH\Controller::setBackendF ( )

Sets backend $f.

戻り値
void

string The requested function. string Whether the link check is requested. string Whether the actual link check is requested. string Whether the settings page is requested. string Whether the backup page is requested. string Whether the pagedata editor is requested. string Whether the system info is requested. string Whether the PHP info is requested. string The name of a special file to be handled. string Whether the file browser is requested to show the userfiles folder. string Whether the file browser is requested to show the image folder. string Whether the file browser is requested to show the download folder. string The requested function.

todo:
Handling of userfiles, images and downloads is probably not necessary, as this should already be handled by the filebrowser. Otherwise media had to be handled also.

Controller.php338 行目に定義があります。

◆ setFrontendF()

XH\Controller::setFrontendF ( )

Sets frontend $f.

戻り値
void

string The requested function. string The URL of the current page. string Whether the mailform is requested. string Whether the sitemap is requested. string Whether the page manager is requested. string The requested function.

Controller.php293 行目に定義があります。

◆ setFunctionsAsPermitted()

XH\Controller::setFunctionsAsPermitted ( )

Sets functions as permitted.

戻り値
void

string Whether edit mode is requested. string Whether normal mode is requested.

todo:
Rename!

Controller.php577 行目に定義があります。

◆ verifyAdm()

XH\Controller::verifyAdm ( )

Verifies that $adm has not be manipulated.

Otherwise we present the login form. Redirecting would be cleaner, but may result in an infinite loop, so we do it this way.

戻り値
void

bool Whether we're logged in as administrator. bool Whether we're in edit mode. array The localization of the core. int The current page. string The HTML fragment for insertion in the contents area. string The current special function. string The title of the page.

Controller.php761 行目に定義があります。

◆ wantsEditContents()

XH\Controller::wantsEditContents ( )

Whether edit mode is requested and the edit contents shall be displayed.

戻り値
bool

string Whether edit mode is requested. string The requested function. string The filename requested for download.

todo:
Do we need $f == 'save' && !$download? IOW: isn't the script already exited in these cases?

Controller.php629 行目に定義があります。

◆ wantsSavePageData()

XH\Controller::wantsSavePageData ( )

Returns whether page data have to be saved.

戻り値
bool

int The number of the current page.

Controller.php382 行目に定義があります。


このクラス詳解は次のファイルから抽出されました: