phpDocumentor

ContentManagerElementsController extends AdminHttpViewController
in package

AdminHttpViewControllers

Uses ContentManagerContentNavigationTrait

Class ContentManagerPagesController

$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

$fieldMap


    protected
        array<string|int, mixed>
    $fieldMap
     = ['content_title', 'content_heading', 'content_text', 'content_status', 'content_file', 'content_type']

$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

$postDataArray


    protected
        array<string|int, mixed>
    $postDataArray

$queryBuilder


    protected
        CI_DB_query_builder
    $queryBuilder

$queryParametersArray


    protected
        array<string|int, mixed>
    $queryParametersArray

$serverDataArray


    protected
        array<string|int, mixed>
    $serverDataArray

$switcherFields


    protected
        array<string|int, mixed>
    $switcherFields
     = ['content_status']

$title


    protected
        NonEmptyStringType
    $title

$typeMap


    protected
        array<string|int, mixed>
    $typeMap
     = ['home' => 'elements_start', 'header' => 'elements_header', 'footer' => 'elements_footer', 'boxes' => 'elements_boxes']

$languageTextManager


    private
        LanguageTextManager
    $languageTextManager

$userConfigurationService


    private
        UserConfigurationService
    $userConfigurationService

__construct()


    public
                __construct(HttpContextReaderInterface $httpContextReader, HttpResponseProcessorInterface $httpResponseProcessor, ContentViewInterface $defaultContentView) : mixed

Parameters

$httpContextReader : HttpContextReaderInterface
$httpResponseProcessor : HttpResponseProcessorInterface
$defaultContentView : ContentViewInterface

Return values

mixed —

actionCreateBoxes()

Renders the creation form for content manager boxes element pages.


    public
                actionCreateBoxes() : AdminLayoutHttpControllerResponse

Return values

AdminLayoutHttpControllerResponse —

actionCreateFooter()

Renders the creation form for content manager footer element pages.


    public
                actionCreateFooter() : AdminLayoutHttpControllerResponse

Return values

AdminLayoutHttpControllerResponse —

actionCreateHeader()

Renders the creation form for content manager header element pages.


    public
                actionCreateHeader() : AdminLayoutHttpControllerResponse

Return values

AdminLayoutHttpControllerResponse —

actionCreateHome()

Renders the creation form for content manager home element pages.


    public
                actionCreateHome() : AdminLayoutHttpControllerResponse

Return values

AdminLayoutHttpControllerResponse —

actionCreateOthers()

Renders the creation form for content manager others element pages.


    public
                actionCreateOthers() : AdminLayoutHttpControllerResponse

Return values

AdminLayoutHttpControllerResponse —

actionCreateWithdrawal()

Renders the creation form for content manager withdrawal element pages.


    public
                actionCreateWithdrawal() : AdminLayoutHttpControllerResponse

Return values

AdminLayoutHttpControllerResponse —

actionDefault()

Default actions, renders the content manager elements overview.


    public
                actionDefault() : AdminLayoutHttpControllerResponse

Return values

AdminLayoutHttpControllerResponse —

actionEdit()

Renders the edit form for content manager home element pages.


    public
                actionEdit() : AdminLayoutHttpControllerResponse

Return values

AdminLayoutHttpControllerResponse —

actionSaveBoxes()

Stores content manager boxes element data in the database and redirects to the overview.


    public
                actionSaveBoxes() : RedirectHttpControllerResponse

Return values

RedirectHttpControllerResponse —

actionSaveFooter()

Stores content manager footer element data in the database and redirects to the overview.


    public
                actionSaveFooter() : RedirectHttpControllerResponse

Return values

RedirectHttpControllerResponse —

actionSaveHeader()

Stores content manager header element data in the database and redirects to the overview.


    public
                actionSaveHeader() : RedirectHttpControllerResponse

Return values

RedirectHttpControllerResponse —

actionSaveHome()

Stores content manager home element data in the database and redirects to the overview.


    public
                actionSaveHome() : RedirectHttpControllerResponse

Return values

RedirectHttpControllerResponse —

actionSaveOthers()

Stores content manager others element data in the database and redirects to the overview.


    public
                actionSaveOthers() : RedirectHttpControllerResponse

Return values

RedirectHttpControllerResponse —

actionSaveWithdrawal()

Stores content manager withdrawal element data in the database and redirects to the overview.


    public
                actionSaveWithdrawal() : RedirectHttpControllerResponse

Return values

RedirectHttpControllerResponse —

actionUpdate()

Updates content manager elements data in the database and redirects to the overview.


    public
                actionUpdate() : RedirectHttpControllerResponse

Return values

RedirectHttpControllerResponse —

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.

Return values

mixed —

validateCurrentAdminStatus()

Makes sure that the admin status is currently given in session


    public
                validateCurrentAdminStatus() : mixed

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.

Return values

HttpControllerResponseInterface —

Response message.

_checkScriptpageFileUploads()

Detects file uploads for scriptpages and returns the array for new content_file post data.


    protected
                _checkScriptpageFileUploads() : 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 —

_getContentData()

Fetches and returns the content data for the content manager elements.


    protected
                _getContentData() : array<string|int, mixed>

Return values

array<string|int, 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".

_getCreationData()

Creates the template data for creation pages.


    protected
                _getCreationData(string $action) : array<string|int, mixed>|bool|KeyValueCollection

The action determines the target location after clicking the submit button.

Parameters

$action : string: Should be whether "home", "header", "footer" or "boxes".

Return values

array<string|int, mixed>|bool|KeyValueCollection —

_getEditData()

Prepares and returns the content manager data to be edited.


    protected
                _getEditData() : KeyValueCollection

Return values

KeyValueCollection —

_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 —

_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.

_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 —

_preparePostData()

Prepares the content manager elements post data.


    protected
                _preparePostData(string $type) : array<string|int, mixed>

Parameters

$type : string: Content manager type, whether "home", "header", "footer" or "boxes".

Return values

array<string|int, mixed> —

Prepared data array for inserting or updating in database.

_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.

_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.

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

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

Return values

array<string|int, mixed> —

ContentManagerElementsController extends AdminHttpViewController in package AdminHttpViewControllers Uses ContentManagerContentNavigationTrait

Tags

Table of Contents

Properties

$assets

$contentTypeFileFlagMap

$contentView

$fieldMap

$fileTypMap

$httpContextReader

$httpResponseProcessor

$isExpertMode

$languageProvider

$postDataArray

$queryBuilder

$queryParametersArray

$serverDataArray

$switcherFields

$title

$typeMap

$languageTextManager

$userConfigurationService

Methods

__construct()

Parameters

Return values

actionCreateBoxes()

Return values

actionCreateFooter()

Return values

actionCreateHeader()

Return values

actionCreateHome()

Return values

actionCreateOthers()

Return values

actionCreateWithdrawal()

Return values

actionDefault()

Return values

actionEdit()

Return values

actionSaveBoxes()

Return values

actionSaveFooter()

Return values

actionSaveHeader()

Return values

actionSaveHome()

Return values

actionSaveOthers()

Return values

actionSaveWithdrawal()

Return values

actionUpdate()

Return values

init()

Return values

proceed()

Parameters

Tags

Return values

validateCurrentAdminStatus()

Tags

Return values

_callActionMethod()

Parameters

Tags

Return values

_checkScriptpageFileUploads()

Return values

_createContentNavigation()

Parameters

Return values

_createNewContentGroupId()

Parameters

Return values

_getAssets()

Return values

_getContentData()

ContentManagerElementsController extends AdminHttpViewController
in package

AdminHttpViewControllers

Uses ContentManagerContentNavigationTrait