ParcelshopfinderController
extends HttpViewController
in package
Class ParcelshopfinderController
Tags
Table of Contents
- $assets : AssetCollectionInterface
- $configuration : ConfigurationStorage
- $contentView : ContentViewInterface
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $languageTextManager : LanguageTextManager
- $postDataArray : array<string|int, mixed>
- $queryParametersArray : array<string|int, mixed>
- $serverDataArray : array<string|int, mixed>
- __construct() : mixed
- actionAddAddressBookEntry() : mixed
- actionDefault() : HttpControllerResponseInterface
- Default action method.
- actionValidatePostnumber() : mixed
- isValidPostnummer() : bool
- checks validity of a DHL post number
- proceed() : mixed
- Processes a http response object which is get by invoking an action method.
- _callActionMethod() : HttpControllerResponseInterface
- Invokes an action method by the given action name.
- _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.
- _getSearchResultOutput() : string
- _getServerData() : string|null
- Returns the expected $_SERVER value by the given key name.
- _render() : string
- Renders and returns a template file.
- _validatePageToken() : mixed
- Check if the $_POST['pageToken'] or $_GET['pageToken'] variable is provided and if it's valid.
- findCountryByIso2() : CustomerCountry
- finds a country by its 2-letter ISO code
- getRedirectToSearchByDefaultAddress() : string
- 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.
- init() : mixed
- makeMapUrl() : false|string
- Generates img URL for static Google map integration.
- makeMarkersJson() : mixed
- splitStreet() : array<string|int, mixed>
- Heuristically splits up a street address into its component street name and house number
Properties
$assets
protected
AssetCollectionInterface
$assets
$configuration
protected
ConfigurationStorage
$configuration
$contentView
protected
ContentViewInterface
$contentView
$httpContextReader
protected
HttpContextReaderInterface
$httpContextReader
$httpResponseProcessor
protected
HttpResponseProcessorInterface
$httpResponseProcessor
$languageTextManager
protected
LanguageTextManager
$languageTextManager
$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 —actionAddAddressBookEntry()
public
actionAddAddressBookEntry() : mixed
Return values
mixed —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 —actionValidatePostnumber()
public
actionValidatePostnumber() : mixed
Return values
mixed —isValidPostnummer()
checks validity of a DHL post number
public
isValidPostnummer( $postnum) : bool
Parameters
Return values
bool —true if $postnum represents a (syntactically) valid post number
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 —_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.
_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 —_getSearchResultOutput()
protected
_getSearchResultOutput(mixed $country, mixed $city, mixed $zip, mixed $house, mixed $street[, mixed $filter = 'both' ]) : string
Parameters
- $country : mixed
- $city : mixed
- $zip : mixed
- $house : mixed
- $street : mixed
- $filter : mixed = 'both'
Return values
string —_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.
_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.
_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 —findCountryByIso2()
finds a country by its 2-letter ISO code
protected
findCountryByIso2( $iso2) : CustomerCountry
Parameters
Tags
Return values
CustomerCountry —getRedirectToSearchByDefaultAddress()
protected
getRedirectToSearchByDefaultAddress(string $filter) : string
Parameters
- $filter : string
Return values
string —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
init()
protected
init() : mixed
Return values
mixed —makeMapUrl()
Generates img URL for static Google map integration.
protected
makeMapUrl(array<string|int, mixed> &$locationList) : false|string
Parameters
- $locationList : array<string|int, mixed>
Return values
false|string —makeMarkersJson()
protected
makeMarkersJson(array<string|int, mixed> &$locations) : mixed
Parameters
- $locations : array<string|int, mixed>
Return values
mixed —splitStreet()
Heuristically splits up a street address into its component street name and house number
protected
splitStreet(mixed $street_address) : array<string|int, mixed>
Parameters
- $street_address : mixed
Return values
array<string|int, mixed> —with keys 'street' and 'house_no'