• Home
• REST_Controller

PHP Class REST_Controller

A fully RESTful server implementation for CodeIgniter using one library, one config file and one controller. Show file Open project: chriskacerguis/codeigniter-restserver Class Usage Examples

Protected Properties

Property	Type	Description
$_allow	boolean	If the request is allowed based on the API key provided
$_apiuser	object	Information about the current API user
$_args	array	The arguments from GET, POST, PUT, DELETE, PATCH, HEAD and OPTIONS request methods combined
$_delete_args	array	The arguments for the DELETE request method
$_enable_xss	boolean	Enable XSS flag Determines whether the XSS filter is always active when GET, OPTIONS, HEAD, POST, PUT, DELETE and PATCH data is encountered Set automatically based on config setting
$_end_rtime	string	The end of the response time from the server
$_get_args	array	The arguments for the GET request method
$_head_args	array	The arguments for the HEAD request method
$_insert_id	string	The insert_id of the log entry (if we have one)
$_options_args	array	The arguments for the OPTIONS request method
$_patch_args	array	The arguments for the PATCH request method
$_post_args	array	The arguments for the POST request method
$_put_args	array	The arguments for the PUT request method
$_query_args	array	The arguments for the query parameters
$_start_rtime	string	The start of the response time from the server
$_supported_formats	array	List all supported methods, the first will be the default format
$_user_ldap_dn	string	The LDAP Distinguished Name of the User post authentication
$allowed_http_methods	array	List of allowed HTTP methods
$check_cors	boolean	Whether or not to perform a CORS check and apply CORS headers to the request
$http_status_codes	array	HTTP status codes and their respective description Note: Only the widely used HTTP status codes are used
$methods	array	Defines the list of method properties such as limit, log and level
$request	object	Contains details about the request Fields: body, format, method, ssl Note: This is a dynamic object (stdClass)
$response	object	Contains details about the response Fields: format, lang Note: This is a dynamic object (stdClass)
$rest	object	Contains details about the REST API Fields: db, ignore_limits, key, level, user_id Note: This is a dynamic object (stdClass)
$rest_format	string | null	This defines the rest format Must be overridden it in a controller so that it is set

Public Methods

Method	Description
__construct ( string $config = 'rest' )	Constructor for the REST API
__destruct ( ) : void	Deconstructor
_remap ( string $object_called, array $arguments = [] )	Requests are not made to methods directly, the request will be for an "object". This simply maps the object and method to the correct Controller method
delete ( null $key = NULL, null $xss_clean = NULL ) : array | string | null	Retrieve a value from a DELETE request
get ( null $key = NULL, null $xss_clean = NULL ) : array | string | null	Retrieve a value from a GET request
head ( null $key = NULL, null $xss_clean = NULL ) : array | string | null	Retrieve a value from a HEAD request
options ( null $key = NULL, null $xss_clean = NULL ) : array | string | null	Retrieve a value from a OPTIONS request
patch ( null $key = NULL, null $xss_clean = NULL ) : array | string | null	Retrieve a value from a PATCH request
post ( null $key = NULL, null $xss_clean = NULL ) : array | string | null	Retrieve a value from a POST request
put ( null $key = NULL, null $xss_clean = NULL ) : array | string | null	Retrieve a value from a PUT request
query ( null $key = NULL, null $xss_clean = NULL ) : array | string | null	Retrieve a value from the query parameters
response ( array | null $data = NULL, integer | null $http_code = NULL, boolean $continue = FALSE )	Takes mixed data and optionally a status code, then creates the response
set_response ( array | null $data = NULL, integer | null $http_code = NULL )	Takes mixed data and optionally a status code, then creates the response within the buffers of the Output class. The response is sent to the client lately by the framework, after the current controller's method termination.
validation_errors ( ) : array	Retrieve the validation errors

Protected Methods

Method	Description
_auth_override_check ( ) : boolean	Check if there is a specific auth type set for the current class/method/HTTP-method being called
_check_access ( ) : boolean	Check to see if the API key has access to the controller and methods
_check_blacklist_auth ( ) : void	Checks if the client's ip is in the 'rest_ip_blacklist' config and generates a 401 response
_check_cors ( ) : void	Checks allowed domains, and adds appropriate headers for HTTP access control (CORS)
_check_limit ( string $controller_method ) : boolean	Check if the requests to a controller method exceed a limit
_check_login ( string $username = NULL, boolean | string $password = FALSE ) : boolean	Check if the user is logged in
_check_php_session ( ) : void	Check to see if the user is logged in with a PHP session key
_check_whitelist_auth ( ) : void	Check if the client's ip is in the 'rest_ip_whitelist' config and generates a 401 response
_detect_api_key ( ) : boolean	See if the user has provided an API key
_detect_input_format ( ) : string | null	Get the input format e.g. json or xml
_detect_lang ( ) : string | null	Preferred return language
_detect_method ( ) : string | null	Get the HTTP request string e.g. get or post
_detect_output_format ( ) : mixed | null | string	Detect which format should be used to output the data
_force_login ( string $nonce = '' ) : void	Force logging in by setting the WWW-Authenticate header
_get_default_output_format ( ) : string	Gets the default format from the configuration. Fallbacks to 'json' if the corresponding configuration option $config['rest_default_format'] is missing or is empty
_log_access_time ( ) : boolean	Updates the log table with the total access time
_log_request ( boolean $authorized = FALSE ) : boolean	Add the request to the log table
_log_response_code ( $http_code ) : boolean	Updates the log table with HTTP response code
_parse_delete ( ) : void	Parse the DELETE request arguments
_parse_get ( ) : void	Parse the GET request arguments
_parse_head ( ) : void	Parse the HEAD request arguments
_parse_options ( ) : void	Parse the OPTIONS request arguments
_parse_patch ( ) : void	Parse the PATCH request arguments
_parse_post ( ) : void	Parse the POST request arguments
_parse_put ( ) : void	Parse the PUT request arguments
_parse_query ( ) : void	Parse the query parameters
_perform_ldap_auth ( string $username = '', string $password = NULL ) : boolean	Perform LDAP Authentication
_perform_library_auth ( string $username = '', string $password = NULL ) : boolean	Perform Library Authentication - Override this function to change the way the library is called
_prepare_basic_auth ( ) : void	Prepares for basic authentication
_prepare_digest_auth ( ) : void	Prepares for digest authentication
_xss_clean ( string $value, boolean $xss_clean ) : string	Sanitizes data so that Cross Site Scripting Hacks can be prevented
early_checks ( ) : void	Extend this function to apply additional checking early on in the process
preflight_checks ( )	Checks to see if we have everything we need to run this library.

Method Details

Property Details