Bootstraps the staticSeoUrl overview 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
stringName of action method to call, without 'action'-Suffix.
Response
\HttpControllerResponseInterfaceResponse message.
Returns a static seo url content object.
_createStaticSeoUrlContentObject(\IdType $languageId, array $staticSeoUrlContentData) : \StaticSeoUrlContentInterface
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
stringExpected key of post parameter.
Response
string|nullEither 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
stringExpected key of query parameter.
Response
mixed|nullEither 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
stringExpected key of server parameter.
Response
string|nullEither the expected value or null, of not found.
Fetches a static seo url.
_getStaticSeoUrl(integer|null $id) : \StaticSeoUrlInterface
If no ID has been passed, a new static seo url will be created.
Arguments
$id
integer|nullStatic SeoUrl ID (optional).
Response
\StaticSeoUrlInterfaceFetched static seo url.
Returns the staticSeoUrlContent data.
_getStaticSeoUrlContentData(\StaticSeoUrlContentInterface $staticSeoUrlContent) : array
Arguments
Response
arrayExtracted data from staticSeoUrlContent object.
Returns the content template data.
_getStaticSeoUrlContentTemplateData() : array
Response
arrayStaticSeoUrlContent template data.
Returns the static seoUrl content data.
_getStaticSeoUrlStaticSeoUrlContentsData(\StaticSeoUrlInterface $staticSeoUrl) : array
New static seoUrl contents for each language will be created if not existing.
Arguments
Response
arrayStaticSeoUrlContents data.
Renders and returns a template file.
_render(string $templateFile, array $contentArray) : string
inherited
Arguments
$templateFile
stringTemplate file to render.
$contentArray
arrayContent array which represent the variables of the template.
Response
stringRendered 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
Renders the static seo url details form page.
actionDetails()
|
|
|
|
|
|
| Throws |
- \InvalidArgumentException
- \UnexpectedValueException
|
Performs save action
actionSave()
|
|
|
|
|
|
| Throws |
- \InvalidArgumentException
- \UnexpectedValueException
|
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
stringThe relative path and filename to search for
Response
\ExistingFilecontaining absolute file path to the given template file
getUploadMaxFilesize
getUploadMaxFilesize()
Initialize 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
staticSeoUrlReadService
staticSeoUrlReadService : \StaticSeoUrlReadService
staticSeoUrlWriteService
staticSeoUrlWriteService : \StaticSeoUrlWriteService
languageProvider
languageProvider : \LanguageProvider
staticSeoUrl
staticSeoUrl :
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