Skip to content

FunctionAndClassReference.md

Latest commit

 

History

History
282 lines (212 loc) · 6.62 KB

FunctionAndClassReference.md

File metadata and controls

282 lines (212 loc) · 6.62 KB
Raw

CI PHPUnit Test for CodeIgniter 3.0

Function/Class Reference

function reset_instance()

Reset CodeIgniter instance. You must create new controller instance after calling this function.

[Deprecated] function get_new_instance()

returns CI_Controller instance

Generate new CodeIgniter instance and get it.

This function is deprecated. Please use reset_instance() instead.

before:

$this->CI = get_new_instance();
$controller = new Welcome();

↓

after:

reset_instance();
$controller = new Welcome();
$this->CI =& get_instance();

function set_is_cli($return)

param type description
$return bool return value to set

Set return value of is_cli() function.

set_is_cli(FALSE);

function load_class_instance($classname, $instance)

param type description
$classname string class name
$instance object object instance

Inject an instance directly into load_class() function.

$email = $this->getMockBuilder('CI_Email')
	->setMethods(['send'])
	->getMock();
$email->method('send')
	->willReturn(TRUE);
load_class_instance('email', $email);

class TestCase

TestCase::request($method, $argv, $params = [], $callable = null)

param type description
$method string HTTP method
$argv array/string controller, method [, arg1, ...] / URI string
$params array POST parameters / Query string
$callable callable [Deprecated] function to run after controller instantiation

returns (string) output strings (view)

Run a controller method or make a request to URI string after reset_instance().

$output = $this->request('GET', ['Form', 'index']);
$output = $this->request('GET', 'products/shoes/show/123');

$callable is deprecated. Use $this->request->setCallable() method instead.

before:

$load_agent = function ($CI) {
	$CI->load->library('user_agent');
};
$output = $this->request('GET', ['Bbs', 'index'], [], $load_agent);

↓

after:

$this->request->setCallable(
	function ($CI) {
		$CI->load->library('user_agent');
	};
);
$output = $this->request('GET', ['Bbs', 'index']);

If you want to enable hooks, call $this->request->enableHooks() method. It enables only pre_controller, post_controller_constructor, post_controller hooks.

$this->request->enableHooks();
$output = $this->request('GET', 'products/shoes/show/123');

TestCase::ajaxRequest($method, $argv, $params = [], $callable = null)

param type description
$method string HTTP method
$argv array/string controller, method [, arg1, ...] / URI string
$params array POST parameters / Query string
$callable callable [Deprecated] function to run after controller instantiation

returns (string) output strings

The same as TestCase::request(), but this makes a Ajax request. This adds only $_SERVER['HTTP_X_REQUESTED_WITH'].

TestCase::getDouble($classname, $params)

param type description
$classname string class name
$params array [method_name => return_value]

returns (object) PHPUnit mock object

Get PHPUnit mock object.

$email = $this->getMockBuilder('CI_Email')
	->setMethods(['send'])
	->getMock();
$email->method('send')
	->willReturn(TRUE);

You could write code above like below:

$email = $this->getDouble('CI_Email', ['send' => TRUE]);

TestCase::verifyInvoked($mock, $method, $params)

param type description
$mock object PHPUnit mock object
$method string method name
$params array arguments

Verifies a method was invoked at least once.

$loader->expects($this->atLeastOnce())
	->method('view')
	->with(
		['shop_confirm', $this->anything(), TRUE]
	);

You could write code above like below:

$this->verifyInvoked(
	$loader,
	'view',
	[
		['shop_confirm', $this->anything(), TRUE]
	]
);

TestCase::verifyInvokedOnce($mock, $method, $params)

param type description
$mock object PHPUnit mock object
$method string method name
$params array arguments

Verifies that method was invoked only once.

$loader->expects($this->once())
	->method('view')
	->with(
		['shop_confirm', $this->anything(), TRUE]
	);

You could write code above like below:

$this->verifyInvokedOnce(
	$loader,
	'view',
	[
		['shop_confirm', $this->anything(), TRUE]
	]
);

TestCase::verifyInvokedMultipleTimes($mock, $method, $times, $params)

param type description
$mock object PHPUnit mock object
$method string method name
$times int times
$params array arguments

Verifies that method was called exactly $times times.

$loader->expects($this->exactly(2))
	->method('view')
	->withConsecutive(
		['shop_confirm', $this->anything(), TRUE],
		['shop_tmpl_checkout', $this->anything()]
	);

You could write code above like below:

$this->verifyInvokedMultipleTimes(
	$loader,
	'view',
	2,
	[
		['shop_confirm', $this->anything(), TRUE],
		['shop_tmpl_checkout', $this->anything()]
	]
);

TestCase::verifyNeverInvoked($mock, $method, $params)

param type description
$mock object PHPUnit mock object
$method string method name
$params array arguments

Verifies that method was not called.

$loader->expects($this->never())
	->method('view')
	->with(
		['shop_confirm', $this->anything(), TRUE]
	);

You could write code above like below:

$this->verifyNeverInvoked(
	$loader,
	'view',
	[
		['shop_confirm', $this->anything(), TRUE]
	]
);

TestCase::warningOff()

Turn off WARNING in error reporting.

TestCase::warningOn()

Restore error reporting.