Class AbstractCommand

Direct known subclasses

JRA\Abstracts\AbstractMethod, JRA\Commands\ContentCommand, JRA\Commands\TokenCommand, JRA\Commands\UserCommand

Indirect known subclasses

JRA\Commands\Methods\Content\DeleteContentId, JRA\Commands\Methods\Content\GetCategoryFields, JRA\Commands\Methods\Content\PostContentUpdateId, JRA\Commands\Methods\Token\GetTokenToken, JRA\Commands\Methods\User\GetUser, JRA\Commands\Methods\User\GetUserLoginUsernamePassword, JRA\Commands\Methods\User\GetUserLogoutUserSession, JRA\Commands\Methods\User\GetUserSessions, JRA\Commands\Methods\User\PutUserProfile, JRA\Commands\Methods\User\PutUserProfileId, JRA\Commands\Methods\Content\GetCategoryListAll, JRA\Commands\Methods\Content\GetCategoryListIdCategories, JRA\Commands\Methods\Content\GetCategoryListIdContent, JRA\Commands\Methods\Content\GetCategorySingleId, JRA\Commands\Methods\Content\GetContentFields, JRA\Commands\Methods\Content\GetContentListAll, JRA\Commands\Methods\Content\GetContentSingleId, JRA\Commands\Methods\Content\PostContentCreate

Abstract
Namespace: JRA\Abstracts
Located at Abstracts/AbstractCommand.php

Methods summary

`public`	# `__construct( JRA\Interfaces\ConfigInterface $pConfig, JRA\Factories\InternalFactory $pInternalFactory )` AbstractCommand constructor. AbstractCommand constructor. Parameters `$pConfig` `$pInternalFactory`
`public boolean`	# `isAutoLogin( )` Returns true if auto login is on, false otherwise. Returns true if auto login is on, false otherwise. Returns boolean
`protected`	# `setAutoLogin( boolean $pValue )` Sets the auto login to the specified value. Sets the auto login to the specified value. Parameters `$pValue`
`public array`	# `getAdditionalArguments( )` Get the additional arguments which are for replacing the keys in the routes. It also contains additional arguments which will be sent with the request body. Get the additional arguments which are for replacing the keys in the routes. It also contains additional arguments which will be sent with the request body. Returns array
`public`	# `setAdditionalArguments( array $pAdditionalArguments )` Set the additional arguments which are for replacing the keys in the routes. It also contains additional arguments which will be sent with the request body. Set the additional arguments which are for replacing the keys in the routes. It also contains additional arguments which will be sent with the request body. Parameters `$pAdditionalArguments`
`public string`	# `getResponse( )` Get the response of the web request (only the html) Get the response of the web request (only the html) Returns string
`protected`	# `setResponse( string $pResponse )` Set the response of the web request (only the html) Set the response of the web request (only the html) Parameters `$pResponse`
`public`	# `process( )` Processes the method and calls Guzzle for requesting the URL. Processes the method and calls Guzzle for requesting the URL.
`public boolean`	# `checkArguments( )` Checks the arguments, so that all necessary arguments are give. Checks the arguments, so that all necessary arguments are give. Returns boolean Returns true if correct arguments are specified, false otherwise.
`abstract protected boolean`	# `_checkArguments( )` The methods need to check addition arguments by itself. The methods need to check addition arguments by itself. Returns boolean
`public string`	# `getParsedUrl( )` Returns the parsed url (with keywords replaced and url params attached). Returns the parsed url (with keywords replaced and url params attached). Returns string
`public string`	# `getHttpMethod( )` Returns the http method for the current method. Returns the http method for the current method. Returns string
`protected JRA\Abstracts\AbstractMethod`	# `_getMethod( )` Returns the current specified method. Returns the current specified method. Returns `JRA\Abstracts\AbstractMethod`
`protected`	# `_setMethod( JRA\Abstracts\AbstractMethod $pMethod )` Sets the current specified method. Sets the current specified method. Parameters `$pMethod`
`public string`	# `getMethodRoute( )` Returns the none parsed route. Returns the none parsed route. Returns string
`public`	# `setMethodRoute( string $pMethodRoute )` Sets the none parsed route. Sets the none parsed route. Parameters `$pMethodRoute`
`public array`	# `getUrlParams( )` Get all url params. Get all url params. Returns array
`public`	# `setUrlParams( array $urlParams )` Set all url params. Set all url params. Parameters `$urlParams`

Properties summary

`protected string[]`	`$_keyWords` The words which should be replaced in the url The words which should be replaced in the url	#
`protected JRA\Interfaces\ConfigInterface`	`$_config` The configuration for the current JRA execution The configuration for the current JRA execution	#
`protected JRA\Factories\InternalFactory`	`$_factory` The factory for internal use The factory for internal use	#