AutoUpdaterAjaxController
extends AdminHttpViewController
in package
Class AutoUpdaterAjaxController
Table of Contents
- $assets : AssetCollectionInterface
- $autoUpdater : AutoUpdater
- $autoUpdaterFactory : AutoUpdaterFactory
- $contentView : ContentViewInterface
- $db : CI_DB_query_builder
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $postDataArray : array<string|int, mixed>
- $queryParametersArray : array<string|int, mixed>
- $serverDataArray : array<string|int, mixed>
- $dataCache : DataCache
- $logControl : LogControl
- $textPhrases : LanguageTextManager
- $updateServer : string
- __construct() : mixed
- actionCheckFtpConnection() : JsonHttpControllerResponse
- Checks the ftp connection.
- actionCheckPermission() : JsonHttpControllerResponse
- Checks the permission for an update. Update ID must be given as post parameter.
- actionCheckPermissionForBackupRestore() : JsonHttpControllerResponse
- Checks the permission for an update. Update ID must be given as post parameter.
- actionDefault() : HttpControllerResponseInterface
- Default action method.
- actionDeleteBackup() : JsonHttpControllerResponse
- Deletes a backup by a given id.
- actionUninstallTheme() : JsonHttpControllerResponse
- Removes a theme from the shop.
- init() : mixed
- Initial method for this 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.
- _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.
- _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.
- createDebugLog() : mixed
- Creates a new debug log.
- deleteDirectory() : bool
- Deletes a directory. Return true on success and false otherwise.
- 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
$autoUpdater
protected
AutoUpdater
$autoUpdater
$autoUpdaterFactory
protected
AutoUpdaterFactory
$autoUpdaterFactory
$contentView
protected
ContentViewInterface
$contentView
$db
protected
CI_DB_query_builder
$db
$httpContextReader
protected
HttpContextReaderInterface
$httpContextReader
$httpResponseProcessor
protected
HttpResponseProcessorInterface
$httpResponseProcessor
$postDataArray
protected
array<string|int, mixed>
$postDataArray
$queryParametersArray
protected
array<string|int, mixed>
$queryParametersArray
$serverDataArray
protected
array<string|int, mixed>
$serverDataArray
$dataCache
private
DataCache
$dataCache
$logControl
private
LogControl
$logControl
$textPhrases
private
LanguageTextManager
$textPhrases
$updateServer
private
string
$updateServer
Methods
__construct()
public
__construct(HttpContextReaderInterface $httpContextReader, HttpResponseProcessorInterface $httpResponseProcessor, ContentViewInterface $defaultContentView) : mixed
Parameters
- $httpContextReader : HttpContextReaderInterface
- $httpResponseProcessor : HttpResponseProcessorInterface
- $defaultContentView : ContentViewInterface
Return values
mixed —actionCheckFtpConnection()
Checks the ftp connection.
public
actionCheckFtpConnection() : JsonHttpControllerResponse
Return values
JsonHttpControllerResponse —actionCheckPermission()
Checks the permission for an update. Update ID must be given as post parameter.
public
actionCheckPermission() : JsonHttpControllerResponse
Return values
JsonHttpControllerResponse —actionCheckPermissionForBackupRestore()
Checks the permission for an update. Update ID must be given as post parameter.
public
actionCheckPermissionForBackupRestore() : JsonHttpControllerResponse
Return values
JsonHttpControllerResponse —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 —actionDeleteBackup()
Deletes a backup by a given id.
public
actionDeleteBackup() : JsonHttpControllerResponse
Tags
Return values
JsonHttpControllerResponse —actionUninstallTheme()
Removes a theme from the shop.
public
actionUninstallTheme() : JsonHttpControllerResponse
Return values
JsonHttpControllerResponse —init()
Initial method for this 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.
_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.
_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 —createDebugLog()
Creates a new debug log.
protected
createDebugLog(string $message[, string|array<string|int, mixed> $additionalData = '' ]) : mixed
Parameters
- $message : string
- $additionalData : string|array<string|int, mixed> = ''
Return values
mixed —deleteDirectory()
Deletes a directory. Return true on success and false otherwise.
protected
deleteDirectory(string $directory) : bool
Parameters
- $directory : string
Return values
bool —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