This class contains some helper methods for handling view requests. Be careful
always when outputting raw user data to HTML or when handling POST requests because
insufficient protection will lead to XSS and CSRF vulnerabilities.
|
category
|
System
|
|
package
|
AdminHttpViewControllers
|
Methods
__construct
__construct(\HttpContextReaderInterface $httpContextReader, \HttpResponseProcessorInterface $httpResponseProcessor, \ContentViewInterface $defaultContentView)
inherited
Invokes an action method by the given action name.
_callActionMethod(string $actionName) : \HttpControllerResponseInterface
inherited
| Throws |
- \LogicException
If no action method of the given name exists.
|
Arguments
$actionName
stringName of action method to call, without 'action'-Suffix.
Response
\HttpControllerResponseInterfaceResponse message.
Detects file uploads for file product contents and returns the array for new file post data.
_checkProductContentFileUploads() : array
Creates the content navigation object for the content manager templates.
_createContentNavigation(\LanguageTextManager $languageTextManager, string|null $current = null) : \ContentNavigationCollection
inherited
Arguments
$languageTextManager
\LanguageTextManagerText manager instance to fetch texts.
$current
string|null(Optional) Whether "pages", "elements" or "productContents" to
set nav item active.
Response
\ContentNavigationCollection
Creates a new content group id.
_createNewContentGroupId(\CI_DB_query_builder $queryBuilder) : integer
inherited
Arguments
$queryBuilder
\CI_DB_query_builderQuery builder instance to access the database.
Response
integerNew content manager group id.
Returns the assets for the content manager editing and creation pages.
_getAssets() : \AssetCollection
inherited
_getCkEditorData
_getCkEditorData()
Returns the content type of the given query result.
_getContentType(array $queryResult) : string
inherited
Arguments
$queryResult
arrayData sets of query for content_manager table.
Response
stringWhether "content", "file" or "link".
_getEditData
_getEditData()
Returns the type of a file by its file extension.
_getFileType( $file) : string
Arguments
Response
string
Return the data for the products content overview.
_getOverviewData() : array
Returns the expected $_POST value by the given key name.
_getPostData(string $keyName) : string|null
inherited
This method is the object oriented layer for $_POST[$keyName].
Arguments
$keyName
stringExpected key of post parameter.
Response
string|nullEither the expected value or null, of not found.
Creates and returns a key value collection which represent the global $_POST array.
_getPostDataCollection() : \KeyValueCollection
inherited
_getProductContentCustomerGroups
_getProductContentCustomerGroups()
_getProductContentEditData
_getProductContentEditData()
_getProductContentProducts
_getProductContentProducts()
Returns an array with allowed script files for content data.
_getProductsContentFiles() : array
inherited
Response
arrayList with allowed script files.
Returns the expected $_GET value by the given key name.
_getQueryParameter(string $keyName) : mixed|null
inherited
This method is the object oriented layer for $_GET[$keyName].
Arguments
$keyName
stringExpected key of query parameter.
Response
mixed|nullEither the expected value or null, of not found.
Creates and returns a key value collection which represent the global $_GET array.
_getQueryParametersCollection() : \KeyValueCollection
inherited
Returns an array with allowed script files for content data.
_getScriptPageFiles() : array
inherited
Response
arrayList with allowed script files.
Returns the expected $_SERVER value by the given key name.
_getServerData(string $keyName) : string|null
inherited
This method is the object oriented layer for $_SERVER[$keyName].
Arguments
$keyName
stringExpected key of server parameter.
Response
string|nullEither the expected value or null, of not found.
Returns an existing file object with the path to a content manager template file.
_getTemplate(string $type, string $name) : \ExistingFile
inherited
Take a look on the template files which are located in html/content/content_manager/$type directory
to know possible values for the $name argument.
Arguments
$type
stringContent manager type, whether "pages", "elements" or "product_contents".
$name
stringName of template file.
Response
\ExistingFile
Whether redirects to the last overview or update pages.
_getUpdateResponse(string $contentManagerType, integer $contentGroupId, $editMethod = 'edit') : \RedirectHttpControllerResponse
inherited
Arguments
$contentManagerType
stringName of content manager controller class.
$contentGroupId
integerContent id of last edited content.
Response
\RedirectHttpControllerResponse
Inserts the given content data in the database.
_insertContentData(\CI_DB_query_builder $queryBuilder, array $contentData) : $this|\ContentManagerPagesController
inherited
Arguments
$queryBuilder
\CI_DB_query_builderQuery builder instance to access the database.
$contentData
arrayContent data array.
Response
$this|\ContentManagerPagesControllerSame instance for chained method calls.
_insertIntoProductContentDescriptionsAndResources
_insertIntoProductContentDescriptionsAndResources(array $productContentDescriptionData, array $productContentResourceData, $type)
Arguments
$productContentDescriptionData
array
$productContentResourceData
array
_insertIntoProductContentProducts
_insertIntoProductContentProducts( $productContentId, $type)
_insertIntoProductContentsAndReturnInsertId
_insertIntoProductContentsAndReturnInsertId( $type)
_insertProductContentPostData
_insertProductContentPostData( $type)
Returns true if the "Responsive File Manager" is installed an false otherwise.
_isFilemanagerAvailable() : boolean
inherited
Prepares $_POST data for the content_manager's 'group_ids' column.
_prepareContentManagerGroupCheckData() : string
inherited
_prepareProductContentDescriptionData
_prepareProductContentDescriptionData( $productContentId, $type)
_prepareProductContentResourceData
_prepareProductContentResourceData( $type)
Renders and returns a template file.
_render(string $templateFile, array $contentArray) : string
inherited
Arguments
$templateFile
stringTemplate file to render.
$contentArray
arrayContent array which represent the variables of the template.
Response
stringRendered template.
Sets the expert mode, if the query parameter has been passed.
_setExpertMode()
inherited
Updates the given content data in the database.
_updateContentData(\CI_DB_query_builder $queryBuilder, array $contentData, integer $contentGroupId) : $this|\ContentManagerPagesController
inherited
Arguments
$queryBuilder
\CI_DB_query_builderQuery builder instance to access the database.
$contentData
arrayContent data array.
$contentGroupId
integerContent group id.
Response
$this|\ContentManagerPagesControllerSame instance for chained method calls.
_updateIntoProductContentDescriptionsAndResources
_updateIntoProductContentDescriptionsAndResources(array $productContentDescriptionData, array $productContentResourceData)
Arguments
$productContentDescriptionData
array
$productContentResourceData
array
_updateIntoProductContentProducts
_updateIntoProductContentProducts( $productContentId, $type)
_updateIntoProductContentsAndReturnInsertId
_updateIntoProductContentsAndReturnInsertId( $type)
Check if the $_POST['pageToken'] or $_GET['pageToken'] variable is provided and if it's valid.
_validatePageToken(string $customExceptionMessage = null)
inherited
Example:
public function proceed(HttpContextInterface $httpContext)
{
parent::proceed($httpContext); // proceed http context from parent class
if($_SERVER['REQUEST_METHOD'] === 'POST')
{
$this->_validatePageToken(); // CSRF Protection
}
}
|
|
|
| Throws |
- \Exception
If the validation fails.
|
Arguments
$customExceptionMessage
string(optional) You can specify a custom exception message.
Default action method.
actionDefault() : \HttpControllerResponseInterface
inherited
Every controller child class requires at least the default action method, which is invoked when
the ::_getQueryParameterData('do') value is not separated by a trailing slash.
Every action method have to return an instance which implements the http controller response interface.
Response
\HttpControllerResponseInterface
Returns the form to edit the product file content
actionEditFile() : \AdminLayoutHttpControllerResponse|boolean
Returns the form to edit the product link content
actionEditLink() : \AdminLayoutHttpControllerResponse|boolean
Return the form for creating a new product content.
actionNew() : \AdminLayoutHttpControllerResponse|boolean
Saves product content file data.
actionSaveFile() : \RedirectHttpControllerResponse
Saves product content link data.
actionSaveLink() : \RedirectHttpControllerResponse
Saves product content text data.
actionSaveText() : \RedirectHttpControllerResponse
actionUpdate
actionUpdate()
Searches the GXModules directory and admin/html directory for a template file,
wich can be useed inside the AdminLayoutHttpControllerResponse object for the template parameter.
getTemplateFile(string $templateFile) : \ExistingFile
inherited
| Throws |
- \Exception
if the path or file is not found
|
Arguments
$templateFile
stringThe relative path and filename to search for
Response
\ExistingFilecontaining absolute file path to the given template file
Initialize Controller
init()
Processes a http response object which is get by invoking an action method.
proceed(\HttpContextInterface $httpContext)
inherited
The action method is determined by the http context reader instance and the current request context.
Re-implement this method in child classes to enable XSS and CSRF protection on demand.
|
see
|
\HttpContextReaderInterface::getActionName
\HttpResponseProcessorInterface::proceed
|
|
|
|
| Throws |
- \LogicException
When no action method is found by the http context reader.
|
Arguments
Makes sure that the admin status is currently given in session
validateCurrentAdminStatus()
inherited
Properties
userConfigurationService
userConfigurationService : \UserConfigurationService
languageTextManager
languageTextManager : \LanguageTextManager
Type(s)
\LanguageTextManager
languageProvider
languageProvider : \LanguageProvider
queryBuilder
queryBuilder : \CI_DB_query_builder
Type(s)
\CI_DB_query_builder
title
title : \NonEmptyStringType
descriptionFields
descriptionFields : array
resourceFields
resourceFields : array
contentTypeFileFlagMap
contentTypeFileFlagMap : array
inherited
fileTypMap
fileTypMap : array
inherited
isExpertMode
isExpertMode : boolean
inherited
httpContextReader
httpContextReader : \HttpContextReaderInterface
inherited
httpResponseProcessor
httpResponseProcessor : \HttpResponseProcessorInterface
inherited
contentView
contentView : \ContentViewInterface
inherited
queryParametersArray
queryParametersArray : array
inherited
postDataArray
postDataArray : array
inherited
Contain the assets needed to be included in the view HTML.
assets : \AssetCollectionInterface
inherited
Server data.
serverDataArray : array
inherited