API Documentation » \AdminFavoritesAjaxController

category	System
package	AdminHttpViewControllers
extends	AdminHttpViewController

__construct

__construct(\HttpContextReaderInterface $httpContextReader, \HttpResponseProcessorInterface $httpResponseProcessor, \ContentViewInterface $defaultContentView)

inherited

Arguments

$httpContextReader

\HttpContextReaderInterface

$httpResponseProcessor

\HttpResponseProcessorInterface

$defaultContentView

\ContentViewInterface

Adds an entry to the favorites table.

_addMenuItemToFavorites() : boolean


Throws	\InvalidArgumentException If the link key is not valid.

Response

boolean

true on success, else false will be returned.

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

string

Name of action method to call, without 'action'-Suffix.

Response

\HttpControllerResponseInterface

Response message.

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

string

Expected key of post parameter.

Response

string|null

Either the expected value or null, of not found.

Creates and returns a key value collection which represent the global $_POST array.

_getPostDataCollection() : \KeyValueCollection

inherited

Response

\KeyValueCollection

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

string

Expected key of query parameter.

Response

mixed|null

Either the expected value or null, of not found.

Creates and returns a key value collection which represent the global $_GET array.

_getQueryParametersCollection() : \KeyValueCollection

inherited

Response

\KeyValueCollection

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

string

Expected key of server parameter.

Response

string|null

Either the expected value or null, of not found.

Check if the customer is the admin.

_isAdmin() : boolean

Response

boolean

Is the customer the admin?

Removes an entry from the favorites database table.

_removeMenuItemFromFavorites() : boolean


Throws	\InvalidArgumentException If the link key is not valid.

Response

boolean

true on success, else false will be returned.

Renders and returns a template file.

_render(string $templateFile, array $contentArray) : string

inherited

Arguments

$templateFile

string

Template file to render.

$contentArray

array

Content array which represent the variables of the template.

Response

string

Rendered template.

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.

Callback method

actionAddMenuItem() : \HttpControllerResponse

This method inserts a menu item to the favorites table.


Throws	\InvalidArgumentException If the link_key argument from the get request is not valid. \AuthenticationException If the customer has no admin privileges.

Response

\HttpControllerResponse

'success' if deletion was successfully else 'error'

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

Callback method

actionRemoveMenuItem() : \HttpControllerResponse

This method deletes a menu item from the favorites table.


Throws	\InvalidArgumentException If the link_key argument from the get request is not valid. \AuthenticationException If the customer has no admin privileges.

Response

\HttpControllerResponse

'success' if deletion was successfully else 'error'

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

string

The relative path and filename to search for

Response

\ExistingFile

containing absolute file path to the given template file

init

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

$httpContext

\HttpContextInterface

Http context object which hold the request variables.

Makes sure that the admin status is currently given in session

validateCurrentAdminStatus()

inherited



Throws	\LogicException

Database connection.

db : \CI_DB_query_builder

var

Type(s)

\CI_DB_query_builder

Link key. Unique link key of the menu item.

linkKey : string

var	Link key. Unique link key of the menu item.

Type(s)

string

Customer ID.

customerId : integer

var	Customer ID.

Type(s)

integer

Table name of the favorites table.

adminFavoritesTable : string

var	Table name of the favorites table.

Type(s)

string

httpContextReader

httpContextReader : \HttpContextReaderInterface

inherited

var

Type(s)

\HttpContextReaderInterface

httpResponseProcessor

httpResponseProcessor : \HttpResponseProcessorInterface

inherited

var

Type(s)

\HttpResponseProcessorInterface

contentView

contentView : \ContentViewInterface

inherited

var

Type(s)

\ContentViewInterface

queryParametersArray

queryParametersArray : array

inherited

var

Type(s)

array

postDataArray

postDataArray : array

inherited

var

Type(s)

array

Contain the assets needed to be included in the view HTML.

assets : \AssetCollectionInterface

inherited

var	Contain the assets needed to be included in the view HTML.

Type(s)

\AssetCollectionInterface

Server data.

serverDataArray : array

inherited

var	Server data.

Type(s)

array

AdminFavoritesAjaxController

Methods

__construct

Arguments

$httpContextReader

$httpResponseProcessor

$defaultContentView

Adds an entry to the favorites table.

Response

Invokes an action method by the given action name.

Arguments

$actionName

Response

Returns the expected $_POST value by the given key name.

Arguments

$keyName

Response

Creates and returns a key value collection which represent the global $_POST array.

Response

Returns the expected $_GET value by the given key name.

Arguments

$keyName

Response

Creates and returns a key value collection which represent the global $_GET array.

Response

Returns the expected $_SERVER value by the given key name.

Arguments

$keyName

Response

Check if the customer is the admin.

Response

Removes an entry from the favorites database table.

Response

Renders and returns a template file.

Arguments

$templateFile

$contentArray

Response

Check if the $_POST['pageToken'] or $_GET['pageToken'] variable is provided and if it's valid.

Arguments

$customExceptionMessage

Callback method

Response

Default action method.

Response

Callback method

Response

Searches the GXModules directory and admin/html directory for a template file, wich can be useed inside the AdminLayoutHttpControllerResponse object for the template parameter.

Arguments

$templateFile

Response

init

Processes a http response object which is get by invoking an action method.

Arguments

$httpContext

Makes sure that the admin status is currently given in session

Properties

Database connection.

Type(s)

Link key. Unique link key of the menu item.

Type(s)

Customer ID.

Type(s)

Table name of the favorites table.

Type(s)

httpContextReader

Type(s)

httpResponseProcessor

Type(s)

contentView

Type(s)

queryParametersArray

Type(s)

postDataArray

Type(s)

Contain the assets needed to be included in the view HTML.

Type(s)

Server data.

Type(s)