Class jCmdLineRequest

Description

a request object for scripts used in a command line

Located in /core/request/jCmdLineRequest.class.php (line 21)

jRequest
   |
   --jCmdLineRequest
Variable Summary
Method Summary
jCmdLineRequest __construct ([boolean $onlyDefaultAction = false])
string getIP ()
void isAllowedResponse ( $response)
void _initParams ()
void _initUrlData ()
Variables
mixed $authorizedResponseClass = 'jResponseCmdline' (line 27)
  • access: public

Redefinition of:
jRequest::$authorizedResponseClass
mixed $defaultResponseType = 'cmdline' (line 25)
  • access: public

Redefinition of:
jRequest::$defaultResponseType
the type of the default response
mixed $onlyDefaultAction = false (line 29)
  • access: protected
mixed $type = 'cmdline' (line 23)
  • access: public

Redefinition of:
jRequest::$type
the request type code

Inherited Variables

Inherited from jRequest

jRequest::$action
jRequest::$module
jRequest::$params
jRequest::$urlPathInfo
jRequest::$urlScript
jRequest::$urlScriptName
jRequest::$urlScriptPath
Methods
Constructor __construct (line 38)

If you want to have a CLI script dedicated to the default action, tell it by given true, so you haven't to indicate the action on the command line. It means of course you couldn't execute any other actions with this script.

jCmdLineRequest __construct ([boolean $onlyDefaultAction = false])
  • boolean $onlyDefaultAction

Redefinition of:
jRequest::__construct()
getIP (line 89)

return the ip address of the user

  • return: the ip
string getIP ()

Redefinition of:
jRequest::getIP()
return the ip address of the user
isAllowedResponse (line 93)
  • access: public
void isAllowedResponse ( $response)
  • $response

Redefinition of:
jRequest::isAllowedResponse()
_initParams (line 48)
  • access: protected
void _initParams ()

Redefinition of:
jRequest::_initParams()
analyse the http request and sets the params property
_initUrlData (line 42)
  • access: protected
void _initUrlData ()

Redefinition of:
jRequest::_initUrlData()
init the url* properties

Inherited Methods

Inherited From jRequest

jRequest::__construct()
jRequest::getDomainName()
jRequest::getErrorResponse()
jRequest::getIP()
jRequest::getModuleAction()
jRequest::getParam()
jRequest::getPort()
jRequest::getProtocol()
jRequest::getResponse()
jRequest::getServerURI()
jRequest::header()
jRequest::headers()
jRequest::init()
jRequest::isAjax()
jRequest::isAllowedResponse()
jRequest::readHttpBody()
jRequest::_initParams()
jRequest::_initUrlData()

Documentation generated on Mon, 26 Oct 2015 21:52:01 +0100 by phpDocumentor 1.4.3