Class AdminFavoritesAjaxController

This class handles the ajax requests for the favorites menu box from the admin menu.

HttpViewController implements HttpViewControllerInterface

AdminHttpViewController implements AdminStatusOnlyInterface

AdminFavoritesAjaxController

Package: AdminHttpViewControllers
Category: System
Extends: AdminHttpViewController
Located at Controllers/HttpView/AdminAjax/AdminFavoritesAjaxController.inc.php

Methods summary

`public`	# `init( )`
`public HttpControllerResponse`	# `actionAddMenuItem( )` Callback method Callback method This method inserts a menu item to the favorites table. Returns `HttpControllerResponse` 'success' if deletion was successfully else 'error' Throws AuthenticationException If the customer has no admin privileges. InvalidArgumentException If the link_key argument from the get request is not valid.
`public HttpControllerResponse`	# `actionRemoveMenuItem( )` Callback method Callback method This method deletes a menu item from the favorites table. Returns `HttpControllerResponse` 'success' if deletion was successfully else 'error' Throws AuthenticationException If the customer has no admin privileges. InvalidArgumentException If the link_key argument from the get request is not valid.
`public HttpControllerResponse`	# `actionDefault( )` Callback method for the default action Callback method for the default action Returns `HttpControllerResponse` Overrides `HttpViewController::actionDefault`
`protected boolean`	# `_isAdmin( )` Check if the customer is the admin. Check if the customer is the admin. Returns boolean Is the customer the admin?
`protected boolean`	# `_addMenuItemToFavorites( )` Adds an entry to the favorites table. Adds an entry to the favorites table. Returns boolean true on success, else false will be returned. Throws InvalidArgumentException If the link key is not valid.
`protected boolean`	# `_removeMenuItemFromFavorites( )` Removes an entry from the favorites database table. Removes an entry from the favorites database table. Returns boolean true on success, else false will be returned. Throws InvalidArgumentException If the link key is not valid.

Methods inherited from AdminHttpViewController

validateCurrentAdminStatus()

Methods inherited from HttpViewController

__construct(), _callActionMethod(), _getPostData(), _getPostDataCollection(), _getQueryParameter(), _getQueryParametersCollection(), _render(), _validatePageToken(), proceed()

Properties summary

`protected CI_DB_query_builder`	`$db` Database connection. Database connection.	#
`protected string`	`$linkKey` Link key. Unique link key of the menu item. Link key. Unique link key of the menu item.	#
`protected integer`	`$customerId` Customer ID. Customer ID.	#
`protected string`	`$adminFavoritesTable` Table name of the favorites table. Table name of the favorites table.	#

Properties inherited from HttpViewController

$assets, $contentView, $httpContextReader, $httpResponseProcessor, $postDataArray, $queryParametersArray

Packages

Classes

Class AdminFavoritesAjaxController

Methods summary

Returns

Throws

Returns

Throws

Returns

Overrides

Returns

Returns

Throws

Returns

Throws

Methods inherited from AdminHttpViewController

Methods inherited from HttpViewController

Properties summary

Properties inherited from HttpViewController