Overview

Packages

  • CodeIgniter
    • Libraries
    • Rest
  • None

Classes

  • Example
  • Key
  • Overview
  • Package
  • Class

Class Example

This is an example of a few basic user interaction methods you could use all done with a hardcoded array

CI_Controller
Extended by REST_Controller
Extended by Example
Package: CodeIgniter\Rest
Category: Controller
License: MIT
Author: Phil Sturgeon, Chris Kacerguis
Link: https://github.com/chriskacerguis/codeigniter-restserver
Located at controllers/api/Example.php
Methods summary
public
# __construct( string $config,… )

Constructor for the REST API

Constructor for the REST API

Parameters

$config,…

Configuration filename minus the file extension e.g: my_rest.php is passed as 'my_rest'

Overrides

REST_Controller::__construct()
public
# users_get( )
public
# users_post( )
public
# users_delete( )
Methods inherited from REST_Controller
__destruct(), _auth_override_check(), _check_access(), _check_blacklist_auth(), _check_cors(), _check_limit(), _check_login(), _check_php_session(), _check_whitelist_auth(), _detect_api_key(), _detect_input_format(), _detect_lang(), _detect_method(), _detect_output_format(), _force_login(), _get_default_output_format(), _log_access_time(), _log_request(), _log_response_code(), _parse_delete(), _parse_get(), _parse_head(), _parse_options(), _parse_patch(), _parse_post(), _parse_put(), _parse_query(), _perform_ldap_auth(), _perform_library_auth(), _prepare_basic_auth(), _prepare_digest_auth(), _remap(), _xss_clean(), delete(), early_checks(), get(), head(), options(), patch(), post(), put(), query(), response(), set_response(), validation_errors()
Constants inherited from REST_Controller
HTTP_ACCEPTED, HTTP_ALREADY_REPORTED, HTTP_BAD_GATEWAY, HTTP_BAD_REQUEST, HTTP_CONFLICT, HTTP_CONTINUE, HTTP_CREATED, HTTP_EXPECTATION_FAILED, HTTP_FAILED_DEPENDENCY, HTTP_FORBIDDEN, HTTP_FOUND, HTTP_GATEWAY_TIMEOUT, HTTP_GONE, HTTP_IM_USED, HTTP_INSUFFICIENT_STORAGE, HTTP_INTERNAL_SERVER_ERROR, HTTP_I_AM_A_TEAPOT, HTTP_LENGTH_REQUIRED, HTTP_LOCKED, HTTP_LOOP_DETECTED, HTTP_METHOD_NOT_ALLOWED, HTTP_MOVED_PERMANENTLY, HTTP_MULTIPLE_CHOICES, HTTP_MULTI_STATUS, HTTP_NETWORK_AUTHENTICATION_REQUIRED, HTTP_NON_AUTHORITATIVE_INFORMATION, HTTP_NOT_ACCEPTABLE, HTTP_NOT_EXTENDED, HTTP_NOT_FOUND, HTTP_NOT_IMPLEMENTED, HTTP_NOT_MODIFIED, HTTP_NO_CONTENT, HTTP_OK, HTTP_PARTIAL_CONTENT, HTTP_PAYMENT_REQUIRED, HTTP_PERMANENTLY_REDIRECT, HTTP_PRECONDITION_FAILED, HTTP_PRECONDITION_REQUIRED, HTTP_PROCESSING, HTTP_PROXY_AUTHENTICATION_REQUIRED, HTTP_REQUESTED_RANGE_NOT_SATISFIABLE, HTTP_REQUEST_ENTITY_TOO_LARGE, HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE, HTTP_REQUEST_TIMEOUT, HTTP_REQUEST_URI_TOO_LONG, HTTP_RESERVED, HTTP_RESERVED_FOR_WEBDAV_ADVANCED_COLLECTIONS_EXPIRED_PROPOSAL, HTTP_RESET_CONTENT, HTTP_SEE_OTHER, HTTP_SERVICE_UNAVAILABLE, HTTP_SWITCHING_PROTOCOLS, HTTP_TEMPORARY_REDIRECT, HTTP_TOO_MANY_REQUESTS, HTTP_UNAUTHORIZED, HTTP_UNPROCESSABLE_ENTITY, HTTP_UNSUPPORTED_MEDIA_TYPE, HTTP_UPGRADE_REQUIRED, HTTP_USE_PROXY, HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL, HTTP_VERSION_NOT_SUPPORTED
Properties inherited from REST_Controller
$_allow, $_apiuser, $_args, $_delete_args, $_enable_xss, $_end_rtime, $_get_args, $_head_args, $_insert_id, $_options_args, $_patch_args, $_post_args, $_put_args, $_query_args, $_start_rtime, $_supported_formats, $_user_ldap_dn, $allowed_http_methods, $check_cors, $http_status_codes, $methods, $request, $response, $rest, $rest_format
API documentation generated by ApiGen