core/model/modx/rest/modrestserver.class.php

Show:

inherited

Classes
- \modRestServer

Table of Contents

Package: modx
Subpackage: rest

\modRestServer
jump to top

Package: modx\rest

An extendable class for handling REST requests.

Constants

 
                OPT_AUTH
                = 'authenticate'

 
                OPT_AUTH_GET
                = 'authenticateGet'

 
                OPT_AUTH_USER_VAR
                = 'authUserVar'

 
                OPT_AUTH_PASS_VAR
                = 'authPassVar'

 
                OPT_ENCODING
                = 'encoding'

 
                OPT_ERROR_DATA_NODE
                = 'error_data_node'

 
                OPT_ERROR_NODE
                = 'error_node'

 
                OPT_ERROR_MESSAGE_NODE
                = 'error_message_node'

 
                OPT_FORMAT
                = 'format'

 
                OPT_PROCESSORS_PATH
                = 'processors_path'

 
                OPT_REQUEST_PATH
                = 'request_path'

 
                OPT_REQUEST_VAR
                = 'requestVar'

 
                OPT_REALM
                = 'realm'

 
                OPT_RENDERERS
                = 'renderers'

Properties

\$error
                 $error= 'false'

The current error message

Default valuefalseDetails

Type: \$error
Access: protected

Methods

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

Parameters

Name	Type	Description
$modx	\modX	A reference to the modX object
$config	array	An array of configuration options

_err204(
          string $output
              =
              ''
          )
        
        :
          string

Sets HTTP 204 response headers

Parameters

Name	Type	Description
$output	string	The outputted response to send

Returns

Type	Description
string

_err400(
          string $output
              =
              ''
          )
        
        :
          string

Sets HTTP 400 response headers

Parameters

Name	Type	Description
$output	string	The outputted response to send

Returns

Type	Description
string

Sets HTTP 401 response headers

Returns

Type	Description
string

_err404(
          array $scriptProperties
              =
              array()
          )
        
        :
          string

Sets HTTP 404 response headers

Parameters

Name	Type	Description
$scriptProperties	array	An array of properties

Returns

Type	Description
string

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

Sets HTTP 405 response headers

Parameters

Name	Type	Description
$allowed	string	A comma-separated list of allowed protocols

Returns

Type	Description
string

_err406(
          string $output
              =
              ''
          )
        
        :
          string

Sets HTTP 406 response headers

Parameters

Name	Type	Description
$output	string	The outputted response to send

Returns

Type	Description
string

_err411(
          string $output
              =
              ''
          )
        
        :
          string

Sets HTTP 411 response headers

Parameters

Name	Type	Description
$output	string	The outputted response to send

Returns

Type	Description
string

_err500(
          string $output
              =
              ''
          )
        
        :
          string

Sets HTTP 500 response headers

Parameters

Name	Type	Description
$output	string	The outputted response to send

Returns

Type	Description
string

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

Converts an array to xml

Parameters

Name	Type	Description
$array	array
$level	integer

Returns

Type	Description
string

Details

Access: protected

authenticate(
          
          )
        
        :
          boolean

Handles basic authentication for the server

Returns

Type	Description
boolean	True if successful.

Details

Todo: Add an optional usergroup check

computePath(
          
          )
        
        :
          string

Computes the path for the REST request

Returns

Type	Description
string	The absolute path to the processor to load

Details

Access: public

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

Deny access and send a 401.

Parameters

Name	Type	Description
$message	string
$data	array

Returns

Type	Description
string

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

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

Parameters

Name	Type	Description
$data	array \| \xPDOObject
$root	string

Returns

Type	Description
string	The encoded message

Details

Access: public

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

Handles error messages

Parameters

Name	Type	Description
$message	string	An error message
$data	array \| \xPDOObject	Any additional data
$type	string	The type of the error message

Returns

Type	Description
string

Details

Access: public

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.

Returns

Type	Description
string

Details

Access: public

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

Handles success messages

Parameters

Name	Type	Description
$data	array \| \xPDOObject	The data to pass and encode
$root	string

Returns

Type	Description
string	The encoded message

core/model/modx/rest/modrestserver.class.php

\modRestServerjump to top

Constants

Properties

Methods

\modRestServer
jump to top