ManufacturerAjaxController
extends AdminHttpViewController
in package
Class ManufacturerAjaxController
Tags
Table of Contents
- $assets : AssetCollectionInterface
- $contentView : ContentViewInterface
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $languageProvider : LanguageProvider
- $manufacturerReadService : ManufacturerReadService
- $manufacturerWriteService : ManufacturerWriteService
- $postDataArray : array<string|int, mixed>
- $queryParametersArray : array<string|int, mixed>
- $serverDataArray : array<string|int, mixed>
- __construct() : mixed
- _removeImage() : $this
- Removes an manufacturers image in the database and filesystem if image is set.
- actionDefault() : HttpControllerResponseInterface
- Default action method.
- actionGetById() : bool
- Gets an manufacturers entity from database by id.
- actionGetData() : bool
- Gets all manufacturers entity's from database.
- actionRemove() : bool
- Removes an manufacturers entity in the database.
- actionSave() : bool
- Creates an manufacturer entity in the database.
- actionUpdate() : bool
- Updates an manufacturers entity in the database.
- init() : mixed
- Initialization of Manufacturer 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.
- _deleteImageCheckbox() : $this
- If checkbox are checked, delete the manufacturer image.
- _deleteImageIfExists() : $this
- Deletes image from manufacturer if set.
- _deserializeManufacturer() : Manufacturer
- Deserialize manufacturer entities.
- _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.
- _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.
- _getServerData() : string|null
- Returns the expected $_SERVER value by the given key name.
- _isImageNameChanged() : bool
- Checks if the name of the image has changed.
- _langIdsByLangCode() : array<string|int, mixed>
- Converts an array with language codes to an array with codes as key and the language id as value.
- _manufacturerById() : ManufacturerInterface
- _render() : string
- Renders and returns a template file.
- _serializeManufacturer() : array<string|int, mixed>
- Serializes manufacturer entities.
- _serializeManufacturerCollection() : array<string|int, mixed>
- Serializes manufacturer collections.
- _setImageToManufacturer() : $this
- Set an Image to an Manufacturer after saving it in the Filesystem.
- _storeManufacturer() : array<string|int, mixed>
- Creates manufacturers data from post data.
- _storeManufacturerImage() : $this
- Stores an manufacturer image or replace one.
- _storeManufacturerImageName() : $this
- Stores manufacturer image name if set.
- _storeManufacturerUrls() : $this
- Stores all manufacturer urls with language id.
- _validatePageToken() : mixed
- Check if the $_POST['pageToken'] or $_GET['pageToken'] variable is provided and if it's valid.
- 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
$contentView
protected
ContentViewInterface
$contentView
$httpContextReader
protected
HttpContextReaderInterface
$httpContextReader
$httpResponseProcessor
protected
HttpResponseProcessorInterface
$httpResponseProcessor
$languageProvider
protected
LanguageProvider
$languageProvider
$manufacturerReadService
protected
ManufacturerReadService
$manufacturerReadService
$manufacturerWriteService
protected
ManufacturerWriteService
$manufacturerWriteService
$postDataArray
protected
array<string|int, mixed>
$postDataArray
$queryParametersArray
protected
array<string|int, mixed>
$queryParametersArray
$serverDataArray
protected
array<string|int, mixed>
$serverDataArray
Methods
__construct()
public
__construct(HttpContextReaderInterface $httpContextReader, HttpResponseProcessorInterface $httpResponseProcessor, ContentViewInterface $defaultContentView) : mixed
Parameters
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $defaultContentView : ContentViewInterface
Return values
mixed —_removeImage()
Removes an manufacturers image in the database and filesystem if image is set.
public
_removeImage() : $this
Return values
$this —actionDefault()
Default action method.
public
actionDefault() : HttpControllerResponseInterface
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.
Return values
HttpControllerResponseInterface —actionGetById()
Gets an manufacturers entity from database by id.
public
actionGetById() : bool
Return values
bool —actionGetData()
Gets all manufacturers entity's from database.
public
actionGetData() : bool
Return values
bool —actionRemove()
Removes an manufacturers entity in the database.
public
actionRemove() : bool
Return values
bool —actionSave()
Creates an manufacturer entity in the database.
public
actionSave() : bool
Return values
bool —actionUpdate()
Updates an manufacturers entity in the database.
public
actionUpdate() : bool
Return values
bool —init()
Initialization of Manufacturer 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.
_deleteImageCheckbox()
If checkbox are checked, delete the manufacturer image.
protected
_deleteImageCheckbox(ManufacturerInterface $manufacturer) : $this
Parameters
- $manufacturer : ManufacturerInterface
Return values
$this —_deleteImageIfExists()
Deletes image from manufacturer if set.
protected
_deleteImageIfExists(ManufacturerInterface $manufacturer) : $this
Parameters
- $manufacturer : ManufacturerInterface
Return values
$this —_deserializeManufacturer()
Deserialize manufacturer entities.
protected
_deserializeManufacturer(string $manufacturerJson[, null $id = null ]) : Manufacturer
Parameters
- $manufacturerJson : string
-
Manufacturer entity as json string.
- $id : null = null
Return values
Manufacturer —Deserialize manufacturer entity.
_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 —_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 —_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.
_isImageNameChanged()
Checks if the name of the image has changed.
protected
_isImageNameChanged(ManufacturerInterface $manufacturer) : bool
Parameters
- $manufacturer : ManufacturerInterface
Return values
bool —_langIdsByLangCode()
Converts an array with language codes to an array with codes as key and the language id as value.
protected
_langIdsByLangCode(array<string|int, mixed> $languageCodes) : array<string|int, mixed>
Parameters
- $languageCodes : array<string|int, mixed>
-
Array that contains the language codes.
Return values
array<string|int, mixed> —Format: [$languageCode => $languageId, (…)].
_manufacturerById()
protected
_manufacturerById([string $type = 'get' ]) : ManufacturerInterface
Parameters
- $type : string = 'get'
Return values
ManufacturerInterface —_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.
_serializeManufacturer()
Serializes manufacturer entities.
protected
_serializeManufacturer(ManufacturerInterface $manufacturer) : array<string|int, mixed>
Parameters
- $manufacturer : ManufacturerInterface
-
Manufacturer entity to be serialized.
Return values
array<string|int, mixed> —Serialized manufacturer array.
_serializeManufacturerCollection()
Serializes manufacturer collections.
protected
_serializeManufacturerCollection(ManufacturerCollection $manufacturerCollection) : array<string|int, mixed>
Parameters
- $manufacturerCollection : ManufacturerCollection
-
Manufacturer collection to be serialized.
Return values
array<string|int, mixed> —Serialized manufacturer collection array.
_setImageToManufacturer()
Set an Image to an Manufacturer after saving it in the Filesystem.
protected
_setImageToManufacturer(ManufacturerInterface $manufacturer, ExistingFile $existingFilesTmpName, FilenameStringType $imageName) : $this
Parameters
- $manufacturer : ManufacturerInterface
- $existingFilesTmpName : ExistingFile
- $imageName : FilenameStringType
Return values
$this —_storeManufacturer()
Creates manufacturers data from post data.
protected
_storeManufacturer(ManufacturerInterface $manufacturer) : array<string|int, mixed>
manufacturer_urls from $_POST parameter are set by this method.
Parameters
- $manufacturer : ManufacturerInterface
Return values
array<string|int, mixed> —_storeManufacturerImage()
Stores an manufacturer image or replace one.
protected
_storeManufacturerImage(ManufacturerInterface $manufacturer) : $this
Parameters
- $manufacturer : ManufacturerInterface
Return values
$this —_storeManufacturerImageName()
Stores manufacturer image name if set.
protected
_storeManufacturerImageName(ManufacturerInterface $manufacturer) : $this
Parameters
- $manufacturer : ManufacturerInterface
Return values
$this —_storeManufacturerUrls()
Stores all manufacturer urls with language id.
protected
_storeManufacturerUrls(ManufacturerInterface $manufacturer) : $this
Parameters
- $manufacturer : ManufacturerInterface
Return values
$this —_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 —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