model/modx/rest/modrestserver.class.php

Classes

package: modx
Classes: modRestServer

Description

\modRestServer
jump to top

package: modx
subpackage: rest
Constants: OPT_AUTH; OPT_AUTH_GET; OPT_AUTH_PASS_VAR; OPT_AUTH_USER_VAR; OPT_ENCODING; OPT_ERROR_DATA_NODE; OPT_ERROR_MESSAGE_NODE; OPT_ERROR_NODE; OPT_FORMAT; OPT_PROCESSORS_PATH; OPT_REALM; OPT_RENDERERS; OPT_REQUEST_PATH; OPT_REQUEST_VAR
Properties: $error
Methods: __construct; _err204; _err400; _err401; _err404; _err405; _err406; _err411; _err500; array2xml; authenticate; computePath; deny; encode; error; handle; success

Description

An extendable class for handling REST requests.

Constants

OPT_AUTH
jump to class

 OPT_AUTH = 'authenticate'

Details

value: authenticate

OPT_AUTH_GET
jump to class

 OPT_AUTH_GET = 'authenticateGet'

Details

value: authenticateGet

OPT_AUTH_USER_VAR
jump to class

 OPT_AUTH_USER_VAR = 'authUserVar'

Details

value: authUserVar

OPT_AUTH_PASS_VAR
jump to class

 OPT_AUTH_PASS_VAR = 'authPassVar'

Details

value: authPassVar

OPT_ENCODING
jump to class

 OPT_ENCODING = 'encoding'

Details

value: encoding

OPT_ERROR_DATA_NODE
jump to class

 OPT_ERROR_DATA_NODE = 'error_data_node'

Details

value: error_data_node

OPT_ERROR_NODE
jump to class

 OPT_ERROR_NODE = 'error_node'

Details

value: error_node

OPT_ERROR_MESSAGE_NODE
jump to class

 OPT_ERROR_MESSAGE_NODE = 'error_message_node'

Details

value: error_message_node

OPT_FORMAT
jump to class

 OPT_FORMAT = 'format'

Details

value: format

OPT_PROCESSORS_PATH
jump to class

 OPT_PROCESSORS_PATH = 'processors_path'

Details

value: processors_path

OPT_REQUEST_PATH
jump to class

 OPT_REQUEST_PATH = 'request_path'

Details

value: request_path

OPT_REQUEST_VAR
jump to class

 OPT_REQUEST_VAR = 'requestVar'

Details

value: requestVar

OPT_REALM
jump to class

 OPT_REALM = 'realm'

Details

value: realm

OPT_RENDERERS
jump to class

 OPT_RENDERERS = 'renderers'

Details

value: renderers

Properties

$errorThe current error message
jump to class

\$error $error = 'false'

Details

: \$error
The current error message
visibility: protected
default: false
final: false
static: false
access: protected

Methods

__construct
jump to class

__construct(
          \modX $modx, array $config
              =
              array
          )
        
        :

Arguments

$modx: \modX
A reference to the modX object
$config: array
An array of configuration options

Details

visibility: public
final: false
static: false

_err204
jump to class

_err204(
          string $output
          )
        
        :
        string

Sets HTTP 204 response headers

Arguments

$output: string
The outputted response to send

Output

string

Details

visibility: private
final: false
static: false

_err400
jump to class

_err400(
          string $output
          )
        
        :
        string

Sets HTTP 400 response headers

Arguments

$output: string
The outputted response to send

Output

string

Details

visibility: private
final: false
static: false

_err401
jump to class

Sets HTTP 401 response headers

Output

string

Details

visibility: private
final: false
static: false

_err404
jump to class

_err404(
          array $scriptProperties
              =
              array
          )
        
        :
        string

Sets HTTP 404 response headers

Arguments

$scriptProperties: array
An array of properties

Output

string

Details

visibility: private
final: false
static: false

_err405
jump to class

_err405(
          string $allowed
              =
              GET, HEAD
          )
        
        :
        string

Sets HTTP 405 response headers

Arguments

$allowed: string
A comma-separated list of allowed protocols

Output

string

Details

visibility: private
final: false
static: false

_err406
jump to class

_err406(
          string $output
          )
        
        :
        string

Sets HTTP 406 response headers

Arguments

$output: string
The outputted response to send

Output

string

Details

visibility: private
final: false
static: false

_err411
jump to class

_err411(
          string $output
          )
        
        :
        string

Sets HTTP 411 response headers

Arguments

$output: string
The outputted response to send

Output

string

Details

visibility: private
final: false
static: false

_err500
jump to class

_err500(
          string $output
          )
        
        :
        string

Sets HTTP 500 response headers

Arguments

$output: string
The outputted response to send

Output

string

Details

visibility: private
final: false
static: false

array2xml
jump to class

array2xml(
          array $array, integer $level
              =
              1
          )
        
        :
        string

Converts an array to xml

Arguments

$array: array
$level: integer

Output

string

Details

visibility: protected
final: false
static: false
access: protected

authenticate
jump to class

authenticate(
          
          )
        
        :
        boolean

Handles basic authentication for the server

Output

boolean: True if successful.

Details

visibility: public
final: false
static: false
todo: Add an optional usergroup check

computePath
jump to class

computePath(
          
          )
        
        :
        string

Computes the path for the REST request

Output

string: The absolute path to the processor to load

Details

visibility: public
final: false
static: false
access: public

deny
jump to class

deny(
          string $message, array $data
              =
              array
          )
        
        :
        string

Deny access and send a 401.

Arguments

$message: string
$data: array

Output

string

Details

visibility: public
final: false
static: false

encode
jump to class

encode(
          array|\xPDOObject $data, string $root
          )
        
        :
        string

Encodes the data to the specified format. Defaults to XML.

Arguments

$data: array\xPDOObject
$root: string

Output

string: The encoded message

Details

visibility: public
final: false
static: false
access: public

error
jump to class

error(
          string $message, array|\xPDOObject $data
              =
              array, string $type
              =
              404
          )
        
        :
        string

Handles error messages

Arguments

$message: string
An error message
$data: array\xPDOObject
Any additional data
$type: string
The type of the error message

Output

string

Details

visibility: public
final: false
static: false
access: public

handle
jump to class

handle(
          
          )
        
        :
        string

Handles the REST request and loads the correct processor. Checks for authentication should it be a type not equal to GET if authenticate is set to true, or always if authenticateGet is set to true.

Output

string

Details

visibility: public
final: false
static: false
access: public

success
jump to class

success(
          array|\xPDOObject $data, string $root
          )
        
        :
        string

Handles success messages

Arguments

$data: array\xPDOObject
The data to pass and encode
$root: string

Output

string: The encoded message

Details

visibility: public
final: false
static: false

model/modx/rest/modrestserver.class.php

Description

\modRestServerjump to top

Description

Constants

OPT_AUTHjump to class

Details

OPT_AUTH_GETjump to class

Details

OPT_AUTH_USER_VARjump to class

Details

OPT_AUTH_PASS_VARjump to class

Details

OPT_ENCODINGjump to class

Details

OPT_ERROR_DATA_NODEjump to class

Details

OPT_ERROR_NODEjump to class

Details

OPT_ERROR_MESSAGE_NODEjump to class

Details

OPT_FORMATjump to class

Details

OPT_PROCESSORS_PATHjump to class

Details

OPT_REQUEST_PATHjump to class

Details

OPT_REQUEST_VARjump to class

Details

OPT_REALMjump to class

Details

OPT_RENDERERSjump to class

Details

Properties

$errorThe current error messagejump to class

Details

Methods

__constructjump to class

Arguments

Details

_err204jump to class

Arguments

Output

Details

_err400jump to class

Arguments

Output

Details

_err401jump to class

Output

Details

_err404jump to class

Arguments

Output

Details

_err405jump to class

Arguments

Output

Details

_err406jump to class

Arguments

Output

Details

_err411jump to class

Arguments

Output

Details

_err500jump to class

Arguments

Output

Details

array2xmljump to class

Arguments

Output

Details

authenticatejump to class

Output

Details

computePathjump to class

Output

\modRestServer
jump to top

OPT_AUTH
jump to class

OPT_AUTH_GET
jump to class

OPT_AUTH_USER_VAR
jump to class

OPT_AUTH_PASS_VAR
jump to class

OPT_ENCODING
jump to class

OPT_ERROR_DATA_NODE
jump to class

OPT_ERROR_NODE
jump to class

OPT_ERROR_MESSAGE_NODE
jump to class

OPT_FORMAT
jump to class

OPT_PROCESSORS_PATH
jump to class

OPT_REQUEST_PATH
jump to class

OPT_REQUEST_VAR
jump to class

OPT_REALM
jump to class

OPT_RENDERERS
jump to class

$errorThe current error message
jump to class

__construct
jump to class

_err204
jump to class

_err400
jump to class

_err401
jump to class

_err404
jump to class

_err405
jump to class

_err406
jump to class

_err411
jump to class

_err500
jump to class

array2xml
jump to class

authenticate
jump to class

computePath
jump to class

deny
jump to class

encode
jump to class

error
jump to class

handle
jump to class

success
jump to class