phpDocumentor

ContentManagerPagesController 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_name', 'content_title', 'content_heading', 'content_text', 'contents_meta_title', 'contents_meta_keywords', 'contents_meta_description', 'gm_url_keywords', 'url_rewrite', 'gm_robots_entry', 'gm_sitemap_entry', 'gm_priority', 'gm_changefreq', 'gm_link', 'gm_link_target', 'content_file', 'download_file', 'content_status', 'content_file', 'content_type', 'content_version', 'opengraph_image']

$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

$serverDataArray


    protected
        array<string|int, mixed>
    $serverDataArray

$sliderReadService


    protected
        SliderReadServiceInterface
    $sliderReadService

$sliderWriteService


    protected
        SliderWriteServiceInterface
    $sliderWriteService

$switcherFields


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

$title


    protected
        NonEmptyStringType
    $title

$typeMap


    protected
        array<string|int, mixed>
    $typeMap
     = ['content' => 'infopage', 'link' => 'linkpage', 'file' => 'scriptpage']

$urlRewriteStorage


    protected
        UrlRewriteStorage
    $urlRewriteStorage

$userConfigurationService


    protected
        UserConfigurationService
    $userConfigurationService

__construct()


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

Parameters

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

Return values

mixed —

actionCreateAdditional()

Renders the creation form for content manager info box pages.


    public
                actionCreateAdditional() : AdminLayoutHttpControllerResponse

Return values

AdminLayoutHttpControllerResponse —

actionCreateInfo()

Renders the creation form for content manager info pages.


    public
                actionCreateInfo() : AdminLayoutHttpControllerResponse

Return values

AdminLayoutHttpControllerResponse —

actionCreateInfoBox()

Renders the creation form for content manager info box pages.


    public
                actionCreateInfoBox() : AdminLayoutHttpControllerResponse

Return values

AdminLayoutHttpControllerResponse —

actionCreateMain()

Renders the creation form for content manager main pages.


    public
                actionCreateMain() : AdminLayoutHttpControllerResponse

Return values

AdminLayoutHttpControllerResponse —

actionCreateSecondary()

Renders the creation form for content manager secondary pages.


    public
                actionCreateSecondary() : AdminLayoutHttpControllerResponse

Return values

AdminLayoutHttpControllerResponse —

actionDefault()

Default actions, renders the content manager elements overview.


    public
                actionDefault() : AdminLayoutHttpControllerResponse

Return values

AdminLayoutHttpControllerResponse —

actionEdit()

Renders the editing form for content manager pages.


    public
                actionEdit() : AdminLayoutHttpControllerResponse

Return values

AdminLayoutHttpControllerResponse —

actionSaveInfoPage()

Stores content manager info page data in the database and redirects to the overview.


    public
                actionSaveInfoPage() : RedirectHttpControllerResponse

Return values

RedirectHttpControllerResponse —

actionSaveLinkPage()

Stores content manager link page data in the database and redirects to the overview.


    public
                actionSaveLinkPage() : RedirectHttpControllerResponse

Return values

RedirectHttpControllerResponse —

actionSaveScriptPage()

Stores content manager link page data in the database and redirects to the overview.


    public
                actionSaveScriptPage() : RedirectHttpControllerResponse

Return values

RedirectHttpControllerResponse —

actionUpdateContentPage()

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


    public
                actionUpdateContentPage() : RedirectHttpControllerResponse

Return values

RedirectHttpControllerResponse —

actionUpdateFilePage()

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


    public
                actionUpdateFilePage() : RedirectHttpControllerResponse

Return values

RedirectHttpControllerResponse —

actionUpdateLinkPage()

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


    public
                actionUpdateLinkPage() : 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 —

_getCkEditorData()

Returns required data for CkEditor settings.


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

Parameters

$contentId : int: Content manager tables "content_group" value.
$type : string: Content type, whether "content", "file" or "link".

Return values

array<string|int, mixed> —

_getContentDataById()

Executes an sql query again the content_manager table and returns the result.


    protected
                _getContentDataById(int $contentId) : array<string|int, mixed>

Parameters

$contentId : int: Content manager tables "content_group" value.

Return values

array<string|int, mixed> —

Content manager table data.

_getContentDescription()

Detects the content type names from the queries result data.


    protected
                _getContentDescription(string $contentType) : string

Parameters

$contentType : string: Must be whether "link", "file" or "content".

Return values

string —

Names of content types for whether "link", "file" or "content".

_getContentEditData()

Returns the content edit data array, which will be converted to a key value collection and assigned to the edit form.


    protected
                _getContentEditData(int $contentId, array<string|int, mixed> $contentData) : array<string|int, mixed>

Parameters

$contentId : int: Id of content manager entry to be edited.
$contentData : array<string|int, mixed>: Content manager data to be edited.

Return values

array<string|int, mixed> —

_getContentManagerEditData()

Prepares the given content manager data to use it in the edit form.


    protected
                _getContentManagerEditData(array<string|int, mixed> $contentManagerData) : array<string|int, mixed>

Parameters

$contentManagerData : array<string|int, mixed>: Content manager data from sql query.

Return values

array<string|int, mixed> —

Prepared content manager data.

_getContentPosition()

Returns the content position of the given query result.


    protected
                _getContentPosition(array<string|int, mixed> $queryResult) : string

Parameters

$queryResult : array<string|int, mixed>: Data sets of query for content_manager table.

Return values

string —

Whether "pages_main", "pages_secondary" or "pages_info".

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

_getCreationResponse()

Renders the creation form for content manager main pages.


    protected
                _getCreationResponse(string $type) : AdminLayoutHttpControllerResponse

Parameters

$type : string: Content manager type to be created, whether "main", "secondary" or "info".

Return values

AdminLayoutHttpControllerResponse —

_getEditData()

Returns content manager data to be edited, prepared for the edit form.


    protected
                _getEditData(int $contentId, array<string|int, mixed> $contentData) : array<string|int, mixed>

Parameters

$contentId : int: Content manager tables "content_group" value.
$contentData : array<string|int, mixed>: Raw data set from sql query.

Return values

array<string|int, mixed> —

Prepared data set array for edit forms of content manager pages.

_getEditFormData()

Returns the required data for the edit form of content manager pages.


    protected
                _getEditFormData() : KeyValueCollection

Return values

KeyValueCollection —

Contains data for the edit form of content manager entries.

_getPagesData()

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


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

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

_getUrlRewriteEditData()

Executes an sql query again the url_rewrites table and returns the result.


    protected
                _getUrlRewriteEditData(int $contentId) : UrlRewriteCollection

Parameters

$contentId : int: Url rewrites table "content_id" value.

Return values

UrlRewriteCollection —

Url rewrite collection.

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

_prepareContentManagerData()

Prepares $_POST data for updating or inserting into the content_manager table.


    protected
                _prepareContentManagerData(int $contentGroupId, string $contentManagerType) : array<string|int, mixed>

Parameters

$contentGroupId : int: Content manager tables "content_group" value.
$contentManagerType : string: Whether "infopage", "linkpage" or "scriptpage".

Return values

array<string|int, mixed> —

Data set for the content_manager table.

_prepareContentManagerGroupCheckData()

Prepares $_POST data for the content_manager's 'group_ids' column.


    protected
                _prepareContentManagerGroupCheckData() : string

Return values

string —

_prepareData()

Prepares $_POST data for updating or inserting into the database.


    protected
                _prepareData(string $contentManagerType) : array<string|int, mixed>

Parameters

$contentManagerType : string: Whether "infopage", "linkpage" or "scriptpage".

Return values

array<string|int, mixed> —

Contains data sets for content_manager- and url_rewrites table and an additional content group id.

_prepareLinkPagePostData()

Prepares $_POST data for content manager link pages.


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

Return values

array<string|int, mixed> —

Prepared data set for updating or inserting into the 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.

_repairUrlKeywords()

Repairs gm_url_keywords for contents


    protected
                _repairUrlKeywords() : $this

Return values

$this —

Same instance for chained method calls.

_setExpertMode()

Sets the expert mode, if the query parameter has been passed.


    protected
                _setExpertMode() : mixed

Return values

mixed —

_storeUrlRewrites()

Stores the given url rewrites in the database.


    protected
                _storeUrlRewrites(array<string|int, mixed> $urlRewrites, int $contentGroupId) : $this|ContentManagerPagesController

Parameters

$urlRewrites : array<string|int, mixed>: Content data array.
$contentGroupId : int: Content group id.

Return values

$this|ContentManagerPagesController —

Same instance for chained method calls.

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

_updateSlider()

Update content slider


    protected
                _updateSlider(array<string|int, mixed> $data) : $this

Parameters

$data : array<string|int, mixed>

Return values

$this —

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 —

_verifyPageToken()

Verifies the page token and stops script if the token is invalid.


    protected
                _verifyPageToken() : mixed

Return values

mixed —

getStyleEditService()


    protected
                getStyleEditService() : StyleEditServiceInterface

Return values

StyleEditServiceInterface —

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

getThemeControlService()


    protected
                getThemeControlService() : ThemeControl

Return values

ThemeControl —

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

ContentManagerPagesController extends AdminHttpViewController in package AdminHttpViewControllers Uses ContentManagerContentNavigationTrait

Tags

Table of Contents

Properties

$assets

$contentTypeFileFlagMap

$contentView

$fieldMap

$fileTypMap

$httpContextReader

$httpResponseProcessor

$isExpertMode

$languageProvider

$languageTextManager

$postDataArray

$queryBuilder

$queryParametersArray

$serverDataArray

$sliderReadService

$sliderWriteService

$switcherFields

$title

$typeMap

$urlRewriteStorage

$userConfigurationService

Methods

__construct()

Parameters

Return values

actionCreateAdditional()

Return values

actionCreateInfo()

Return values

actionCreateInfoBox()

Return values

actionCreateMain()

Return values

actionCreateSecondary()

Return values

actionDefault()

Return values

actionEdit()

Return values

actionSaveInfoPage()

Return values

actionSaveLinkPage()

Return values

actionSaveScriptPage()

Return values

actionUpdateContentPage()

Return values

actionUpdateFilePage()

Return values

actionUpdateLinkPage()

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

_getCkEditorData()

Parameters

ContentManagerPagesController extends AdminHttpViewController
in package

AdminHttpViewControllers

Uses ContentManagerContentNavigationTrait