By ElfStack Dev Group

With Broken English :) For personal purpose, we wrote this extension. In this extended CI, you can use our functional Unit Test class Unit. We also provide you a simple way to treat RESTful requests. By the way, you can now load class within namespaces because we extended the behaviour of CI_Loader.

This extension for CodeIgniter is based on CodeIgniter v3.0.6.

1. You can quickly treat RESTful requests easily by extending REST_Controller instead of Controller.
2. You can quickly create Unit test and generate report easily.
3. You can now load library within namespace by using this $this->load->library('NameOfNamespace\ClassName', null, null, 'File.php');

The head of raw CodeIgniter's library loader looks like this: library($class[, $param = null[, $object_name = null]]) We make it like this: library($class[, $param = null[, $object_name = null, $file = null]]) So your code still works.

If you want to load class in a namespace, you must specific the file name to load(relevant to libraries path). If the object_name is not provided(given an empty value), we will take the last segment of $class as name. As if you are not using a namespace, we take the last segment of $class and treat it as how origin CI did. 'NameOfNamespace\ClassName' => 'classname'

// This will load `libraries/ClassName.php` and load class `NamespaceName\ClassName`.
$this->load->library('NamespaceName\ClassName', null, null, 'ClassName.php');
// Use the loaded class
$this->classname->some_method();
// Or you can specific an object name
$this->load->library('NamespaceName\ClassName', null, 'foo', 'ClassName.php');
$this->foo->some_method();

Check Controller: tests/Run. You can view the report through yourdomain/tests/run. Here is a simple code demo:

$this->load->library('Unit');
$this->unit->start();        // Start to record the running time(using benchmark)
$this->unit->assert('Summary of the test', function() {
	echo 'Output will be captured.';
	echo 'The return value of this function will be shown too.';
	echo 'Whether the test is passed depends on the return value of this function.';
	return true;
}, 'Detailed description of this test, default is null');
$this->unit->printResult();

None for the time being, sorry.

Router now adds default http verb after methods name. It means if we got uri like this: /controller/method/params(/params...) We will call:

Class: Controller
Method: method_{http-verb}

BUT if http_verb is get or cli(which means you run the app in command line),we won't add http_verb after method name. It works as before.

We know that before we can use http verb in route rules like this:

$route['product/(:any)']['POST'] = 'product/index_post/$1';

We keep this feature too but we expand a little.

1. If you have specific route rules with http verb, we will not add default http verb after method name.
2. HTTP verb allows common case *.
3. Specific HTTP verb is prior to the common case.

e.g. If you have route rules as follow

$route['product/(:any)']['POST'] = 'product/add/$1';
$route['product/(:any)']['*'] = 'product/index/$1';

$route['user/(:any)'] = 'user/index/$1';
$route['user/(:any)']['PUT'] = 'user/update/$1';

you will got:

We also check route rules in /application/config/api.php in order to manage your API together.

We create one more reserved route rule which look like this:

$route['disable_http_suffix'] = FALSE;

If it sets to TRUE, we will not add http verb after method name in any case, but you can still use specific http verbs in route rules like $route['user/(:any)']['PUT'].

To enable RESTful Controller and use our method, just simply extends our class in your controller like this:

class Welcome extends REST_Controller {

Also you can use raw controller.(Use CI_Controller instead of REST_Controller.

Notice that: use raw controller will not change route rules, if you want to use the Router as before, just remove our router file/appication/core/Router.php.

If you have enabled our you can use some of our methods.

To see the detail, check Reference below.

• You can use $this->api->method directly to get HTTP verb.
• You can use $this->api->query(); to get query string. also you can specific index $this->api->query('id');
• You can use $this->api->request(); to access data in the http body, also you can specific index $this->api->request('name');, this method gets data from php://input

We offer you method to response data. To see the detail, check Reference below. By using $this->api->response method you can send response easily, check reference below.

var string

The value of this var is the lower case of HTTP verbs or cli in command line. such as get,post,put,patch,delete,options,cli

mixed query([$key = null])

Returns query string.

If you do not offer $key, return an array which contains all information of query string. If you offer $key, return the value of that.

mixed request([$key = null])

Returns data in the HTTP body.

This function get data from php://input and translate into array. If you do not offer $key, return an array which contains all information in the input stream. If you offer $key, return the value of that.

void response($data[, $code = 200[, $type = null]])

Send response to client and exit.

If $data is an array or an object, we use json_encode function to treat data and set Content-Type to application/json. Else if $type not offered, we set Content-Type to text/plain, you can edit the default type in /application/core/REST_Controller.php $code sets header http code to return, default is 200.