Bootstraps the teaser slider edit page.
category
|
System
|
package
|
AdminHttpViewControllers
|
Methods
__construct
__construct(\HttpContextReaderInterface $httpContextReader, \HttpResponseProcessorInterface $httpResponseProcessor, \ContentViewInterface $defaultContentView)
inherited
Adds a new success message.
_addSuccessMessage()
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 a slide image area object.
_createSlideImageAreaObject(array $slideImageAreaFormData) : \SlideImageAreaInterface
Returns a slide image object.
_createSlideImageObject(\IdType $languageId, array $slideImageFormData) : \SlideImageInterface
Returns a slide object.
_createSlideObject(\IdType $languageId, array $slideData) : \SlideInterface
Returns all available breakpoints.
_getBreakpoints() : array
Returns a default slide image collection.
_getDefaultSlideImageCollection(\IdType $languageId) : \SlideImageCollection
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
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
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.
Returns the slide data.
_getSlideData(\SlideInterface $slide) : array
Arguments
Response
array
Extracted data from slide object.
Returns the slide image area data.
_getSlideImageAreaData(\SlideImageAreaInterface $slideImageArea) : array
Arguments
Response
array
Slide image area data.
Returns the slide image areas data (iterating over the slide image area collection).
_getSlideImageAreasData(\SlideImageAreaCollection $slideImageAreaCollection) : array
Returns the slide image data.
_getSlideImageData(\SlideImageInterface $slideImage) : array
Arguments
Response
array
Slide image data.
Returns the slide images data (iterating over the slide image collection).
_getSlideImagesData(\SlideImageCollection $slideImageCollection, \IdType $languageId) : array
Fetches a slider.
_getSlider(integer|null $id) : \Slider
If no ID has been passed, a new slider will be created.
Arguments
$id
integer|null
Slider ID (optional).
Response
\Slider
Fetched slider.
Returns the slides data.
_getSliderSlidesData(\SliderInterface $slider) : array
If no ID is set, new slides for each language will be created.
Arguments
Response
array
Slides data.
Returns the slide template data.
_getSlideTemplateData() : array
Response
array
Slide template data.
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.
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
Saves a slider.
actionSave() : \JsonHttpControllerResponse.
|
|
Throws |
- \InvalidArgumentException
|
Response
\JsonHttpControllerResponse.
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
Initializes the controller.
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
Makes sure that the admin status is currently given in session
validateCurrentAdminStatus()
inherited
Properties
sliderReadService
sliderReadService : \SliderReadService
sliderWriteService
sliderWriteService : \SliderWriteService
languageProvider
languageProvider : \LanguageProvider
languageTextManager
languageTextManager : \LanguageTextManager
Type(s)
\LanguageTextManager
userCfgService
userCfgService : \UserConfigurationService
httpContextReader
httpContextReader : \HttpContextReaderInterface
inherited
httpResponseProcessor
httpResponseProcessor : \HttpResponseProcessorInterface
inherited
contentView
contentView : \ContentViewInterface
inherited
queryParametersArray
queryParametersArray : array
inherited
postDataArray
postDataArray : array
inherited
Contain the assets needed to be included in the view HTML.
assets : \AssetCollectionInterface
inherited
Server data.
serverDataArray : array
inherited