ContentManagerProductContentsController
extends AdminHttpViewController
in package
Uses
ContentManagerContentNavigationTrait
Class ContentManagerProductContentsController
Tags
Table of Contents
- $assets : AssetCollectionInterface
- $contentTypeFileFlagMap : array<string|int, mixed>
- $contentView : ContentViewInterface
- $descriptionFields : array<string|int, mixed>
- $fileTypMap : array<string|int, mixed>
- Order of this array is important as it will update the file flag in the database on updating
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $isExpertMode : bool
- $languageProvider : LanguageProvider
- $languageTextManager : LanguageTextManager
- $postDataArray : array<string|int, mixed>
- $queryBuilder : CI_DB_query_builder
- $queryParametersArray : array<string|int, mixed>
- $resourceFields : array<string|int, mixed>
- $serverDataArray : array<string|int, mixed>
- $title : NonEmptyStringType
- $userConfigurationService : UserConfigurationService
- __construct() : mixed
- actionDefault() : AdminLayoutHttpControllerResponse
- Default actions, renders the content manager product contents overview.
- actionEdit() : mixed
- actionEditFile() : AdminLayoutHttpControllerResponse|bool
- Returns the form to edit the product file content
- actionEditLink() : AdminLayoutHttpControllerResponse|bool
- Returns the form to edit the product link content
- actionNew() : AdminLayoutHttpControllerResponse|bool
- Return the form for creating a new product content.
- actionSaveFile() : RedirectHttpControllerResponse
- Saves product content file data.
- actionSaveLink() : RedirectHttpControllerResponse
- Saves product content link data.
- actionSaveText() : RedirectHttpControllerResponse
- Saves product content text data.
- actionUpdate() : mixed
- init() : mixed
- Initialize Controller
- proceed() : mixed
- Processes a http response object which is get by invoking an action method.
- validateCurrentAdminStatus() : mixed
- Makes sure that the admin status is currently given in session
- _callActionMethod() : HttpControllerResponseInterface
- Invokes an action method by the given action name.
- _checkProductContentFileUploads() : array<string|int, mixed>
- Detects file uploads for file product contents and returns the array for new file post data.
- _createContentNavigation() : ContentNavigationCollection
- Creates the content navigation object for the content manager templates.
- _createNewContentGroupId() : int
- Creates a new content group id.
- _getAssets() : AssetCollection
- Returns the assets for the content manager editing and creation pages.
- _getCkEditorData() : mixed
- _getContentType() : string
- Returns the content type of the given query result.
- _getEditData() : mixed
- _getFileType() : string
- Returns the type of a file by its file extension.
- _getOverviewData() : array<string|int, mixed>
- Return the data for the products content overview.
- _getPostData() : string|null
- Returns the expected $_POST value by the given key name.
- _getPostDataCollection() : KeyValueCollection
- Creates and returns a key value collection which represent the global $_POST array.
- _getProductContentCustomerGroups() : mixed
- _getProductContentEditData() : mixed
- _getProductContentProducts() : mixed
- _getProductsContentFiles() : array<string|int, mixed>
- Returns an array with allowed script files for content data.
- _getQueryParameter() : mixed|null
- Returns the expected $_GET value by the given key name.
- _getQueryParametersCollection() : KeyValueCollection
- Creates and returns a key value collection which represent the global $_GET array.
- _getScriptPageFiles() : array<string|int, mixed>
- Returns an array with allowed script files for content data.
- _getServerData() : string|null
- Returns the expected $_SERVER value by the given key name.
- _getTemplate() : ExistingFile
- Returns an existing file object with the path to a content manager template file.
- _getUpdateResponse() : RedirectHttpControllerResponse
- Whether redirects to the last overview or update pages.
- _insertContentData() : $this|ContentManagerPagesController
- Inserts the given content data in the database.
- _insertIntoProductContentDescriptionsAndResources() : mixed
- _insertIntoProductContentProducts() : mixed
- _insertIntoProductContentsAndReturnInsertId() : mixed
- _insertProductContentPostData() : mixed
- _isFilemanagerAvailable() : bool
- Returns true if the "Responsive File Manager" is installed an false otherwise.
- _prepareContentManagerGroupCheckData() : string
- Prepares $_POST data for the content_manager's 'group_ids' column.
- _prepareProductContentDescriptionData() : mixed
- _prepareProductContentResourceData() : mixed
- _render() : string
- Renders and returns a template file.
- _setExpertMode() : mixed
- Sets the expert mode, if the query parameter has been passed.
- _updateContentData() : $this|ContentManagerPagesController
- Updates the given content data in the database.
- _updateIntoProductContentDescriptionsAndResources() : mixed
- _updateIntoProductContentProducts() : mixed
- _updateIntoProductContentsAndReturnInsertId() : mixed
- _validatePageToken() : mixed
- Check if the $_POST['pageToken'] or $_GET['pageToken'] variable is provided and if it's valid.
- _verifyPageToken() : mixed
- Verifies the page token and stops script if the token is invalid.
- getTemplateFile() : ExistingFile
- Searches the GXModules directory and admin/html directory for a template file, wich can be useed inside the AdminLayoutHttpControllerResponse object for the template parameter.
- isValidJson() : bool
- isValidRequestMethod() : bool
- prepareJsonInput() : array<string|int, mixed>
Properties
$assets
protected
AssetCollectionInterface
$assets
$contentTypeFileFlagMap
protected
array<string|int, mixed>
$contentTypeFileFlagMap
= ['pages_main' => 'topmenu', 'pages_secondary' => 'topmenu_corner', 'pages_info' => 'content', 'pages_info_box' => 'information', 'pages_additional' => 'additional', 'elements_start' => 'extraboxes', 'elements_header' => 'extraboxes', 'elements_styleedit' => 'information', 'elements_footer' => 'extraboxes', 'elements_boxes' => 'extraboxes', 'elements_others' => 'extraboxes', 'elements_withdrawal' => 'withdrawal']
$contentView
protected
ContentViewInterface
$contentView
$descriptionFields
protected
array<string|int, mixed>
$descriptionFields
= ['title', 'content']
$fileTypMap
Order of this array is important as it will update the file flag in the database on updating
protected
array<string|int, mixed>
$fileTypMap
= [0 => 'information', 1 => 'content', 2 => 'topmenu_corner', 3 => 'topmenu', 4 => 'extraboxes', 5 => 'withdrawal', 6 => 'additional']
$httpContextReader
protected
HttpContextReaderInterface
$httpContextReader
$httpResponseProcessor
protected
HttpResponseProcessorInterface
$httpResponseProcessor
$isExpertMode
protected
bool
$isExpertMode
= alse
$languageProvider
protected
LanguageProvider
$languageProvider
$languageTextManager
protected
LanguageTextManager
$languageTextManager
$postDataArray
protected
array<string|int, mixed>
$postDataArray
$queryBuilder
protected
CI_DB_query_builder
$queryBuilder
$queryParametersArray
protected
array<string|int, mixed>
$queryParametersArray
$resourceFields
protected
array<string|int, mixed>
$resourceFields
= ['file', 'link', 'text']
$serverDataArray
protected
array<string|int, mixed>
$serverDataArray
$title
protected
NonEmptyStringType
$title
$userConfigurationService
protected
UserConfigurationService
$userConfigurationService
Methods
__construct()
public
__construct(HttpContextReaderInterface $httpContextReader, HttpResponseProcessorInterface $httpResponseProcessor, ContentViewInterface $defaultContentView) : mixed
Parameters
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $defaultContentView : ContentViewInterface
Return values
mixed —actionDefault()
Default actions, renders the content manager product contents overview.
public
actionDefault() : AdminLayoutHttpControllerResponse
Return values
AdminLayoutHttpControllerResponse —actionEdit()
public
actionEdit() : mixed
Return values
mixed —actionEditFile()
Returns the form to edit the product file content
public
actionEditFile() : AdminLayoutHttpControllerResponse|bool
Return values
AdminLayoutHttpControllerResponse|bool —actionEditLink()
Returns the form to edit the product link content
public
actionEditLink() : AdminLayoutHttpControllerResponse|bool
Return values
AdminLayoutHttpControllerResponse|bool —actionNew()
Return the form for creating a new product content.
public
actionNew() : AdminLayoutHttpControllerResponse|bool
Return values
AdminLayoutHttpControllerResponse|bool —actionSaveFile()
Saves product content file data.
public
actionSaveFile() : RedirectHttpControllerResponse
Return values
RedirectHttpControllerResponse —actionSaveLink()
Saves product content link data.
public
actionSaveLink() : RedirectHttpControllerResponse
Return values
RedirectHttpControllerResponse —actionSaveText()
Saves product content text data.
public
actionSaveText() : RedirectHttpControllerResponse
Return values
RedirectHttpControllerResponse —actionUpdate()
public
actionUpdate() : mixed
Return values
mixed —init()
Initialize Controller
public
init() : mixed
Return values
mixed —proceed()
Processes a http response object which is get by invoking an action method.
public
proceed(HttpContextInterface $httpContext) : mixed
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.
Parameters
- $httpContext : HttpContextInterface
-
Http context object which hold the request variables.
Tags
Return values
mixed —validateCurrentAdminStatus()
Makes sure that the admin status is currently given in session
public
validateCurrentAdminStatus() : mixed
Tags
Return values
mixed —_callActionMethod()
Invokes an action method by the given action name.
protected
_callActionMethod(string $actionName) : HttpControllerResponseInterface
Parameters
- $actionName : string
-
Name of action method to call, without 'action'-Suffix.
Tags
Return values
HttpControllerResponseInterface —Response message.
_checkProductContentFileUploads()
Detects file uploads for file product contents and returns the array for new file post data.
protected
_checkProductContentFileUploads() : array<string|int, mixed>
Return values
array<string|int, mixed> —_createContentNavigation()
Creates the content navigation object for the content manager templates.
protected
_createContentNavigation(LanguageTextManager $languageTextManager[, string|null $current = null ]) : ContentNavigationCollection
Parameters
- $languageTextManager : LanguageTextManager
-
Text manager instance to fetch texts.
- $current : string|null = null
-
(Optional) Whether "pages", "elements" or "productContents" to set nav item active.
Return values
ContentNavigationCollection —_createNewContentGroupId()
Creates a new content group id.
protected
_createNewContentGroupId(CI_DB_query_builder $queryBuilder) : int
Parameters
- $queryBuilder : CI_DB_query_builder
-
Query builder instance to access the database.
Return values
int —New content manager group id.
_getAssets()
Returns the assets for the content manager editing and creation pages.
protected
_getAssets() : AssetCollection
Return values
AssetCollection —_getCkEditorData()
protected
_getCkEditorData() : mixed
Return values
mixed —_getContentType()
Returns the content type of the given query result.
protected
_getContentType(array<string|int, mixed> $queryResult) : string
Parameters
- $queryResult : array<string|int, mixed>
-
Data sets of query for content_manager table.
Return values
string —Whether "content", "file" or "link".
_getEditData()
protected
_getEditData() : mixed
Return values
mixed —_getFileType()
Returns the type of a file by its file extension.
protected
_getFileType( $file) : string
Parameters
Return values
string —_getOverviewData()
Return the data for the products content overview.
protected
_getOverviewData() : array<string|int, mixed>
Return values
array<string|int, mixed> —_getPostData()
Returns the expected $_POST value by the given key name.
protected
_getPostData(string $keyName) : string|null
This method is the object oriented layer for $_POST[$keyName].
Parameters
- $keyName : string
-
Expected key of post parameter.
Return values
string|null —Either the expected value or null, of not found.
_getPostDataCollection()
Creates and returns a key value collection which represent the global $_POST array.
protected
_getPostDataCollection() : KeyValueCollection
Return values
KeyValueCollection —_getProductContentCustomerGroups()
protected
_getProductContentCustomerGroups() : mixed
Return values
mixed —_getProductContentEditData()
protected
_getProductContentEditData() : mixed
Return values
mixed —_getProductContentProducts()
protected
_getProductContentProducts() : mixed
Return values
mixed —_getProductsContentFiles()
Returns an array with allowed script files for content data.
protected
_getProductsContentFiles() : array<string|int, mixed>
Return values
array<string|int, mixed> —List with allowed script files.
_getQueryParameter()
Returns the expected $_GET value by the given key name.
protected
_getQueryParameter(string $keyName) : mixed|null
This method is the object oriented layer for $_GET[$keyName].
Parameters
- $keyName : string
-
Expected key of query parameter.
Return values
mixed|null —Either the expected value or null, of not found.
_getQueryParametersCollection()
Creates and returns a key value collection which represent the global $_GET array.
protected
_getQueryParametersCollection() : KeyValueCollection
Return values
KeyValueCollection —_getScriptPageFiles()
Returns an array with allowed script files for content data.
protected
_getScriptPageFiles() : array<string|int, mixed>
Return values
array<string|int, mixed> —List with allowed script files.
_getServerData()
Returns the expected $_SERVER value by the given key name.
protected
_getServerData(string $keyName) : string|null
This method is the object oriented layer for $_SERVER[$keyName].
Parameters
- $keyName : string
-
Expected key of server parameter.
Return values
string|null —Either the expected value or null, of not found.
_getTemplate()
Returns an existing file object with the path to a content manager template file.
protected
_getTemplate(string $type, string $name) : ExistingFile
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.
Parameters
- $type : string
-
Content manager type, whether "pages", "elements" or "product_contents".
- $name : string
-
Name of template file.
Return values
ExistingFile —_getUpdateResponse()
Whether redirects to the last overview or update pages.
protected
_getUpdateResponse(string $contentManagerType, int $contentGroupId[, mixed $editMethod = 'edit' ]) : RedirectHttpControllerResponse
Parameters
- $contentManagerType : string
-
Name of content manager controller class.
- $contentGroupId : int
-
Content id of last edited content.
- $editMethod : mixed = 'edit'
Return values
RedirectHttpControllerResponse —_insertContentData()
Inserts the given content data in the database.
protected
_insertContentData(CI_DB_query_builder $queryBuilder, array<string|int, mixed> $contentData) : $this|ContentManagerPagesController
Parameters
- $queryBuilder : CI_DB_query_builder
-
Query builder instance to access the database.
- $contentData : array<string|int, mixed>
-
Content data array.
Return values
$this|ContentManagerPagesController —Same instance for chained method calls.
_insertIntoProductContentDescriptionsAndResources()
protected
_insertIntoProductContentDescriptionsAndResources(array<string|int, mixed> $productContentDescriptionData, array<string|int, mixed> $productContentResourceData, mixed $type) : mixed
Parameters
- $productContentDescriptionData : array<string|int, mixed>
- $productContentResourceData : array<string|int, mixed>
- $type : mixed
Return values
mixed —_insertIntoProductContentProducts()
protected
_insertIntoProductContentProducts(mixed $productContentId, mixed $type) : mixed
Parameters
- $productContentId : mixed
- $type : mixed
Return values
mixed —_insertIntoProductContentsAndReturnInsertId()
protected
_insertIntoProductContentsAndReturnInsertId(mixed $type) : mixed
Parameters
- $type : mixed
Return values
mixed —_insertProductContentPostData()
protected
_insertProductContentPostData(mixed $type) : mixed
Parameters
- $type : mixed
Return values
mixed —_isFilemanagerAvailable()
Returns true if the "Responsive File Manager" is installed an false otherwise.
protected
_isFilemanagerAvailable() : bool
Return values
bool —_prepareContentManagerGroupCheckData()
Prepares $_POST data for the content_manager's 'group_ids' column.
protected
_prepareContentManagerGroupCheckData() : string
Return values
string —_prepareProductContentDescriptionData()
protected
_prepareProductContentDescriptionData(mixed $productContentId, mixed $type) : mixed
Parameters
- $productContentId : mixed
- $type : mixed
Return values
mixed —_prepareProductContentResourceData()
protected
_prepareProductContentResourceData(mixed $type) : mixed
Parameters
- $type : mixed
Return values
mixed —_render()
Renders and returns a template file.
protected
_render(string $templateFile, array<string|int, mixed> $contentArray) : string
Parameters
- $templateFile : string
-
Template file to render.
- $contentArray : array<string|int, mixed>
-
Content array which represent the variables of the template.
Return values
string —Rendered template.
_setExpertMode()
Sets the expert mode, if the query parameter has been passed.
protected
_setExpertMode() : mixed
Return values
mixed —_updateContentData()
Updates the given content data in the database.
protected
_updateContentData(CI_DB_query_builder $queryBuilder, array<string|int, mixed> $contentData, int $contentGroupId) : $this|ContentManagerPagesController
Parameters
- $queryBuilder : CI_DB_query_builder
-
Query builder instance to access the database.
- $contentData : array<string|int, mixed>
-
Content data array.
- $contentGroupId : int
-
Content group id.
Return values
$this|ContentManagerPagesController —Same instance for chained method calls.
_updateIntoProductContentDescriptionsAndResources()
protected
_updateIntoProductContentDescriptionsAndResources(array<string|int, mixed> $productContentDescriptionData, array<string|int, mixed> $productContentResourceData) : mixed
Parameters
- $productContentDescriptionData : array<string|int, mixed>
- $productContentResourceData : array<string|int, mixed>
Return values
mixed —_updateIntoProductContentProducts()
protected
_updateIntoProductContentProducts(mixed $productContentId, mixed $type) : mixed
Parameters
- $productContentId : mixed
- $type : mixed
Return values
mixed —_updateIntoProductContentsAndReturnInsertId()
protected
_updateIntoProductContentsAndReturnInsertId(mixed $type) : mixed
Parameters
- $type : mixed
Return values
mixed —_validatePageToken()
Check if the $_POST['pageToken'] or $_GET['pageToken'] variable is provided and if it's valid.
protected
_validatePageToken([string $customExceptionMessage = null ]) : mixed
Example: public function proceed(HttpContextInterface $httpContext) { parent::proceed($httpContext); // proceed http context from parent class if($_SERVER['REQUEST_METHOD'] === 'POST') { $this->_validatePageToken(); // CSRF Protection } }
Parameters
- $customExceptionMessage : string = null
-
(optional) You can specify a custom exception message.
Tags
Return values
mixed —_verifyPageToken()
Verifies the page token and stops script if the token is invalid.
protected
_verifyPageToken() : mixed
Return values
mixed —getTemplateFile()
Searches the GXModules directory and admin/html directory for a template file, wich can be useed inside the AdminLayoutHttpControllerResponse object for the template parameter.
protected
getTemplateFile(string $templateFile) : ExistingFile
Parameters
- $templateFile : string
-
The relative path and filename to search for
Tags
Return values
ExistingFile —containing absolute file path to the given template file
isValidJson()
protected
isValidJson(string $string) : bool
Parameters
- $string : string
Return values
bool —isValidRequestMethod()
protected
isValidRequestMethod(string $method) : bool
Parameters
- $method : string
Return values
bool —prepareJsonInput()
protected
prepareJsonInput(string $json) : array<string|int, mixed>
Parameters
- $json : string