PHP Класс AdminPageFrameworkLoader_AdminPage_Tool_Generator_Generator

С версии: 3.5.4
Наследование: extends AdminPageFrameworkLoader_AdminPage_Section_Base
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$oFactory Stores the admin page factory object.

Открытые методы

Метод Описание
_replyToModifyFileContents ( $sFileContents, $sPathInArchive ) : string Modifies the file contents of the archive.
_replyToModifyPathInArchive ( string $sPathInArchive ) : string Modifies the path in the archive which include the file name.
_replyToModifyPathName ( $aMatches ) Modifies the regex-matched string.
addFields ( $oFactory, $sSectionID ) : void Adds form fields.
replyToDownloadFramework ( $aSavedData, $sSubmittedFieldID, $sSubmittedInputID, $oAdminPage ) Lets the user download their own version of Admin Page Framework.
replyToFilterFileName ( $sFileName, $sFieldID, $sInputID, $vExportingData, $oAdminPage ) : string Filters the exporting file name.
replyToModifyExportHTTPHeader ( $aHeader, $sFieldID, $sInputID, $mData, $sFileName, $oFactory ) Modifies the HTTP header of the export field.
validate ( $aInput, $aOldInput, $oAdminPage, $aSubmitInfo ) Validates the submitted form data.

Защищенные методы

Метод Описание
construct ( $oFactory ) : void A user constructor.

Приватные методы

Метод Описание
_getCheckedComponents ( ) : array Returns an array holding elements that the user has selected in the form.
_getComponentLabels ( ) : array Returns component labels as an array.
_getDisallowedArchiveDirectoryPaths ( ) : array Returns an array holding allowed paths set to the archive.
_getDownloadFileName ( ) : string Returns the user-set file name.
_getDownloadFrameworkZipFile ( $sFrameworkDirPath, $sDestinationPath ) : string Generates the framework zip data.
_getFormSubmitValueByFieldIDAsString ( $sFieldID ) : string Retrieves the value from the $_POST array by the given field ID.
_isAllowedArchivePath ( $sPath ) : boolean Checks whether the passed archive path is allowed.
_modifyClassName ( $sSubject ) : string Modifies the given class name.
_modifyClassNameByPath ( $sFileContents, $sPathInArchive ) : string Modifies the given file contents.
_modifyClassNameOfInclusionList ( $sFileContents ) : string Modifies the class inclusion list.
_modifyFileDockblock ( $sFileContents ) : string Inserts additional information such as an included component list and a date to the file doc-block (the header comment part).
_modifyTextDomain ( $sFileContents ) : string Modifies the text domain in the given file contents.
_sanitizeFieldValues ( array $aInput, $oAdminPage ) : array Sanitizes user-submitted form field values.

Описание методов

_replyToModifyFileContents() публичный Метод

Modifies the file contents of the archive.
С версии: 3.5.4
public _replyToModifyFileContents ( $sFileContents, $sPathInArchive ) : string
Результат string The modified file contents.

_replyToModifyPathInArchive() публичный Метод

Return an empty string to drop the item.
С версии: 3.5.4
public _replyToModifyPathInArchive ( string $sPathInArchive ) : string
$sPathInArchive string The internal path of the archive including the parsing file name.
Результат string

_replyToModifyPathName() публичный Метод

Modifies the regex-matched string.
С версии: 3.5.4
public _replyToModifyPathName ( $aMatches )

addFields() публичный Метод

Adds form fields.
С версии: 3.5.4
public addFields ( $oFactory, $sSectionID ) : void
Результат void

construct() защищенный Метод

A user constructor.
С версии: 3.5.4
protected construct ( $oFactory ) : void
Результат void

replyToDownloadFramework() публичный Метод

Lets the user download their own version of Admin Page Framework.
С версии: 3.5.4
public replyToDownloadFramework ( $aSavedData, $sSubmittedFieldID, $sSubmittedInputID, $oAdminPage )

replyToFilterFileName() публичный Метод

Filters the exporting file name.
public replyToFilterFileName ( $sFileName, $sFieldID, $sInputID, $vExportingData, $oAdminPage ) : string
Результат string

replyToModifyExportHTTPHeader() публичный Метод

Modifies the HTTP header of the export field.
С версии: 3.5.4 #return array
public replyToModifyExportHTTPHeader ( $aHeader, $sFieldID, $sInputID, $mData, $sFileName, $oFactory )

validate() публичный Метод

Validates the submitted form data.
С версии: 3.5.4
public validate ( $aInput, $aOldInput, $oAdminPage, $aSubmitInfo )

Описание свойств

$oFactory публичное свойство

Stores the admin page factory object.
public $oFactory