init
This commit is contained in:
132
vendor/codeception/stub/docs/Expected.md
vendored
Normal file
132
vendor/codeception/stub/docs/Expected.md
vendored
Normal file
@@ -0,0 +1,132 @@
|
||||
|
||||
## Codeception\Stub\Expected
|
||||
|
||||
|
||||
|
||||
#### *public static* never($params = null)
|
||||
Checks if a method never has been invoked
|
||||
|
||||
If method invoked, it will immediately throw an
|
||||
exception.
|
||||
|
||||
```php
|
||||
<?php
|
||||
use \Codeception\Stub\Expected;
|
||||
|
||||
$user = $this->make('User', [
|
||||
'getName' => Expected::never(),
|
||||
'someMethod' => function() {}
|
||||
]);
|
||||
$user->someMethod();
|
||||
?>
|
||||
```
|
||||
|
||||
* `param mixed` $params
|
||||
* return StubMarshaler
|
||||
|
||||
#### *public static* once($params = null)
|
||||
Checks if a method has been invoked exactly one
|
||||
time.
|
||||
|
||||
If the number is less or greater it will later be checked in verify() and also throw an
|
||||
exception.
|
||||
|
||||
```php
|
||||
<?php
|
||||
use \Codeception\Stub\Expected;
|
||||
|
||||
$user = $this->make(
|
||||
'User',
|
||||
array(
|
||||
'getName' => Expected::once('Davert'),
|
||||
'someMethod' => function() {}
|
||||
)
|
||||
);
|
||||
$userName = $user->getName();
|
||||
$this->assertEquals('Davert', $userName);
|
||||
?>
|
||||
```
|
||||
Alternatively, a function can be passed as parameter:
|
||||
|
||||
```php
|
||||
<?php
|
||||
Expected::once(function() { return Faker::name(); });
|
||||
```
|
||||
|
||||
* `param mixed` $params
|
||||
|
||||
* return StubMarshaler
|
||||
|
||||
#### *public static* atLeastOnce($params = null)
|
||||
Checks if a method has been invoked at least one
|
||||
time.
|
||||
|
||||
If the number of invocations is 0 it will throw an exception in verify.
|
||||
|
||||
```php
|
||||
<?php
|
||||
use \Codeception\Stub\Expected;
|
||||
|
||||
$user = $this->make(
|
||||
'User',
|
||||
array(
|
||||
'getName' => Expected::atLeastOnce('Davert')),
|
||||
'someMethod' => function() {}
|
||||
)
|
||||
);
|
||||
$user->getName();
|
||||
$userName = $user->getName();
|
||||
$this->assertEquals('Davert', $userName);
|
||||
?>
|
||||
```
|
||||
|
||||
Alternatively, a function can be passed as parameter:
|
||||
|
||||
```php
|
||||
<?php
|
||||
Expected::atLeastOnce(function() { return Faker::name(); });
|
||||
```
|
||||
|
||||
* `param mixed` $params
|
||||
|
||||
* return StubMarshaler
|
||||
|
||||
#### *public static* exactly($count, $params = null)
|
||||
Checks if a method has been invoked a certain amount
|
||||
of times.
|
||||
If the number of invocations exceeds the value it will immediately throw an
|
||||
exception,
|
||||
If the number is less it will later be checked in verify() and also throw an
|
||||
exception.
|
||||
|
||||
``` php
|
||||
<?php
|
||||
use \Codeception\Stub;
|
||||
use \Codeception\Stub\Expected;
|
||||
|
||||
$user = $this->make(
|
||||
'User',
|
||||
array(
|
||||
'getName' => Expected::exactly(3, 'Davert'),
|
||||
'someMethod' => function() {}
|
||||
)
|
||||
);
|
||||
$user->getName();
|
||||
$user->getName();
|
||||
$userName = $user->getName();
|
||||
$this->assertEquals('Davert', $userName);
|
||||
?>
|
||||
```
|
||||
Alternatively, a function can be passed as parameter:
|
||||
|
||||
```php
|
||||
<?php
|
||||
Expected::exactly(function() { return Faker::name() });
|
||||
```
|
||||
|
||||
* `param int` $count
|
||||
* `param mixed` $params
|
||||
|
||||
* return StubMarshaler
|
||||
|
||||
|
||||
328
vendor/codeception/stub/docs/Stub.md
vendored
Normal file
328
vendor/codeception/stub/docs/Stub.md
vendored
Normal file
@@ -0,0 +1,328 @@
|
||||
|
||||
## Codeception\Stub
|
||||
|
||||
|
||||
|
||||
#### *public static* make($class, $params = null, $testCase = null)
|
||||
Instantiates a class without executing a constructor.
|
||||
Properties and methods can be set as a second parameter.
|
||||
Even protected and private properties can be set.
|
||||
|
||||
``` php
|
||||
<?php
|
||||
Stub::make('User');
|
||||
Stub::make('User', ['name' => 'davert']);
|
||||
?>
|
||||
```
|
||||
|
||||
Accepts either name of class or object of that class
|
||||
|
||||
``` php
|
||||
<?php
|
||||
Stub::make(new User, ['name' => 'davert']);
|
||||
?>
|
||||
```
|
||||
|
||||
To replace method provide it's name as a key in second parameter
|
||||
and it's return value or callback function as parameter
|
||||
|
||||
``` php
|
||||
<?php
|
||||
Stub::make('User', ['save' => function () { return true; }]);
|
||||
Stub::make('User', ['save' => true]);
|
||||
?>
|
||||
```
|
||||
|
||||
**To create a mock, pass current testcase name as last argument:**
|
||||
|
||||
```php
|
||||
<?php
|
||||
Stub::make('User', [
|
||||
'save' => \Codeception\Stub\Expected::once()
|
||||
], $this);
|
||||
```
|
||||
|
||||
* `param mixed` $class - A class to be mocked
|
||||
* `param array` $params - properties and methods to set
|
||||
* `param bool|\PHPUnit\Framework\TestCase` $testCase
|
||||
|
||||
* return object - mock
|
||||
* throws \RuntimeException when class does not exist
|
||||
* throws \Exception
|
||||
|
||||
#### *public static* factory($class, $num = null, $params = null)
|
||||
Creates $num instances of class through `Stub::make`.
|
||||
|
||||
* `param mixed` $class
|
||||
* `param int` $num
|
||||
* `param array` $params
|
||||
|
||||
* return array
|
||||
* throws \Exception
|
||||
|
||||
#### *public static* makeEmptyExcept($class, $method, $params = null, $testCase = null)
|
||||
Instantiates class having all methods replaced with dummies except one.
|
||||
Constructor is not triggered.
|
||||
Properties and methods can be replaced.
|
||||
Even protected and private properties can be set.
|
||||
|
||||
``` php
|
||||
<?php
|
||||
Stub::makeEmptyExcept('User', 'save');
|
||||
Stub::makeEmptyExcept('User', 'save', ['name' => 'davert']);
|
||||
?>
|
||||
```
|
||||
|
||||
Accepts either name of class or object of that class
|
||||
|
||||
``` php
|
||||
<?php
|
||||
* Stub::makeEmptyExcept(new User, 'save');
|
||||
?>
|
||||
```
|
||||
|
||||
To replace method provide it's name as a key in second parameter
|
||||
and it's return value or callback function as parameter
|
||||
|
||||
``` php
|
||||
<?php
|
||||
Stub::makeEmptyExcept('User', 'save', ['isValid' => function () { return true; }]);
|
||||
Stub::makeEmptyExcept('User', 'save', ['isValid' => true]);
|
||||
?>
|
||||
```
|
||||
|
||||
**To create a mock, pass current testcase name as last argument:**
|
||||
|
||||
```php
|
||||
<?php
|
||||
Stub::makeEmptyExcept('User', 'validate', [
|
||||
'save' => \Codeception\Stub\Expected::once()
|
||||
], $this);
|
||||
```
|
||||
|
||||
* `param mixed` $class
|
||||
* `param string` $method
|
||||
* `param array` $params
|
||||
* `param bool|\PHPUnit\Framework\TestCase` $testCase
|
||||
|
||||
* return object
|
||||
* throws \Exception
|
||||
|
||||
#### *public static* makeEmpty($class, $params = null, $testCase = null)
|
||||
Instantiates class having all methods replaced with dummies.
|
||||
Constructor is not triggered.
|
||||
Properties and methods can be set as a second parameter.
|
||||
Even protected and private properties can be set.
|
||||
|
||||
``` php
|
||||
<?php
|
||||
Stub::makeEmpty('User');
|
||||
Stub::makeEmpty('User', ['name' => 'davert']);
|
||||
```
|
||||
|
||||
Accepts either name of class or object of that class
|
||||
|
||||
``` php
|
||||
<?php
|
||||
Stub::makeEmpty(new User, ['name' => 'davert']);
|
||||
```
|
||||
|
||||
To replace method provide it's name as a key in second parameter
|
||||
and it's return value or callback function as parameter
|
||||
|
||||
``` php
|
||||
<?php
|
||||
Stub::makeEmpty('User', ['save' => function () { return true; }]);
|
||||
Stub::makeEmpty('User', ['save' => true));
|
||||
```
|
||||
|
||||
**To create a mock, pass current testcase name as last argument:**
|
||||
|
||||
```php
|
||||
<?php
|
||||
Stub::makeEmpty('User', [
|
||||
'save' => \Codeception\Stub\Expected::once()
|
||||
], $this);
|
||||
```
|
||||
|
||||
* `param mixed` $class
|
||||
* `param array` $params
|
||||
* `param bool|\PHPUnit\Framework\TestCase` $testCase
|
||||
|
||||
* return object
|
||||
* throws \Exception
|
||||
|
||||
#### *public static* copy($obj, $params = null)
|
||||
Clones an object and redefines it's properties (even protected and private)
|
||||
|
||||
* `param` $obj
|
||||
* `param array` $params
|
||||
|
||||
* return mixed
|
||||
* throws \Exception
|
||||
|
||||
#### *public static* construct($class, $constructorParams = null, $params = null, $testCase = null)
|
||||
Instantiates a class instance by running constructor.
|
||||
Parameters for constructor passed as second argument
|
||||
Properties and methods can be set in third argument.
|
||||
Even protected and private properties can be set.
|
||||
|
||||
``` php
|
||||
<?php
|
||||
Stub::construct('User', ['autosave' => false]);
|
||||
Stub::construct('User', ['autosave' => false], ['name' => 'davert']);
|
||||
?>
|
||||
```
|
||||
|
||||
Accepts either name of class or object of that class
|
||||
|
||||
``` php
|
||||
<?php
|
||||
Stub::construct(new User, ['autosave' => false), ['name' => 'davert']);
|
||||
?>
|
||||
```
|
||||
|
||||
To replace method provide it's name as a key in third parameter
|
||||
and it's return value or callback function as parameter
|
||||
|
||||
``` php
|
||||
<?php
|
||||
Stub::construct('User', [], ['save' => function () { return true; }]);
|
||||
Stub::construct('User', [], ['save' => true]);
|
||||
?>
|
||||
```
|
||||
|
||||
**To create a mock, pass current testcase name as last argument:**
|
||||
|
||||
```php
|
||||
<?php
|
||||
Stub::construct('User', [], [
|
||||
'save' => \Codeception\Stub\Expected::once()
|
||||
], $this);
|
||||
```
|
||||
|
||||
* `param mixed` $class
|
||||
* `param array` $constructorParams
|
||||
* `param array` $params
|
||||
* `param bool|\PHPUnit\Framework\TestCase` $testCase
|
||||
|
||||
* return object
|
||||
* throws \Exception
|
||||
|
||||
#### *public static* constructEmpty($class, $constructorParams = null, $params = null, $testCase = null)
|
||||
Instantiates a class instance by running constructor with all methods replaced with dummies.
|
||||
Parameters for constructor passed as second argument
|
||||
Properties and methods can be set in third argument.
|
||||
Even protected and private properties can be set.
|
||||
|
||||
``` php
|
||||
<?php
|
||||
Stub::constructEmpty('User', ['autosave' => false]);
|
||||
Stub::constructEmpty('User', ['autosave' => false), ['name' => 'davert']);
|
||||
```
|
||||
|
||||
Accepts either name of class or object of that class
|
||||
|
||||
``` php
|
||||
<?php
|
||||
Stub::constructEmpty(new User, ['autosave' => false], ['name' => 'davert']);
|
||||
```
|
||||
|
||||
To replace method provide it's name as a key in third parameter
|
||||
and it's return value or callback function as parameter
|
||||
|
||||
``` php
|
||||
<?php
|
||||
Stub::constructEmpty('User', [], ['save' => function () { return true; }]);
|
||||
Stub::constructEmpty('User', [], ['save' => true]);
|
||||
```
|
||||
|
||||
**To create a mock, pass current testcase name as last argument:**
|
||||
|
||||
```php
|
||||
<?php
|
||||
Stub::constructEmpty('User', [], [
|
||||
'save' => \Codeception\Stub\Expected::once()
|
||||
], $this);
|
||||
```
|
||||
|
||||
* `param mixed` $class
|
||||
* `param array` $constructorParams
|
||||
* `param array` $params
|
||||
* `param bool|\PHPUnit\Framework\TestCase` $testCase
|
||||
|
||||
* return object
|
||||
|
||||
#### *public static* constructEmptyExcept($class, $method, $constructorParams = null, $params = null, $testCase = null)
|
||||
Instantiates a class instance by running constructor with all methods replaced with dummies, except one.
|
||||
Parameters for constructor passed as second argument
|
||||
Properties and methods can be set in third argument.
|
||||
Even protected and private properties can be set.
|
||||
|
||||
``` php
|
||||
<?php
|
||||
Stub::constructEmptyExcept('User', 'save');
|
||||
Stub::constructEmptyExcept('User', 'save', ['autosave' => false], ['name' => 'davert']);
|
||||
?>
|
||||
```
|
||||
|
||||
Accepts either name of class or object of that class
|
||||
|
||||
``` php
|
||||
<?php
|
||||
Stub::constructEmptyExcept(new User, 'save', ['autosave' => false], ['name' => 'davert']);
|
||||
?>
|
||||
```
|
||||
|
||||
To replace method provide it's name as a key in third parameter
|
||||
and it's return value or callback function as parameter
|
||||
|
||||
``` php
|
||||
<?php
|
||||
Stub::constructEmptyExcept('User', 'save', [], ['save' => function () { return true; }]);
|
||||
Stub::constructEmptyExcept('User', 'save', [], ['save' => true]);
|
||||
?>
|
||||
```
|
||||
|
||||
**To create a mock, pass current testcase name as last argument:**
|
||||
|
||||
```php
|
||||
<?php
|
||||
Stub::constructEmptyExcept('User', 'save', [], [
|
||||
'save' => \Codeception\Stub\Expected::once()
|
||||
], $this);
|
||||
```
|
||||
|
||||
* `param mixed` $class
|
||||
* `param string` $method
|
||||
* `param array` $constructorParams
|
||||
* `param array` $params
|
||||
* `param bool|\PHPUnit\Framework\TestCase` $testCase
|
||||
|
||||
* return object
|
||||
|
||||
#### *public static* update($mock, array $params)
|
||||
Replaces properties of current stub
|
||||
|
||||
* `param \PHPUnit\Framework\MockObject\MockObject` $mock
|
||||
* `param array` $params
|
||||
|
||||
* return mixed
|
||||
* throws \LogicException
|
||||
|
||||
#### *public static* consecutive()
|
||||
Stubbing a method call to return a list of values in the specified order.
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$user = Stub::make('User', array('getName' => Stub::consecutive('david', 'emma', 'sam', 'amy')));
|
||||
$user->getName(); //david
|
||||
$user->getName(); //emma
|
||||
$user->getName(); //sam
|
||||
$user->getName(); //amy
|
||||
?>
|
||||
```
|
||||
|
||||
* return ConsecutiveMap
|
||||
|
||||
|
||||
250
vendor/codeception/stub/docs/StubTrait.md
vendored
Normal file
250
vendor/codeception/stub/docs/StubTrait.md
vendored
Normal file
@@ -0,0 +1,250 @@
|
||||
|
||||
## Codeception\Test\Feature\Stub
|
||||
|
||||
|
||||
|
||||
### Usage in Codeception
|
||||
|
||||
Since Codeception 2.3.8 this trait is enabled in `\Codeception\Test\Unit` class.
|
||||
|
||||
### Usage in PHPUnit
|
||||
|
||||
Include this trait into a TestCase to be able to use Stubs and Mocks:
|
||||
|
||||
```php
|
||||
<?php
|
||||
class MyTest extends \PHPUnit\Framework\TestCase
|
||||
{
|
||||
use Codeception\Test\Feature\Stub;
|
||||
}
|
||||
```
|
||||
|
||||
#### *public* make($class, $params = null)
|
||||
Instantiates a class without executing a constructor.
|
||||
Properties and methods can be set as a second parameter.
|
||||
Even protected and private properties can be set.
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$this->make('User');
|
||||
$this->make('User', ['name' => 'davert']);
|
||||
?>
|
||||
```
|
||||
|
||||
Accepts either name of class or object of that class
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$this->make(new User, ['name' => 'davert']);
|
||||
?>
|
||||
```
|
||||
|
||||
To replace method provide it's name as a key in second parameter
|
||||
and it's return value or callback function as parameter
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$this->make('User', ['save' => function () { return true; }]);
|
||||
$this->make('User', ['save' => true]);
|
||||
```
|
||||
|
||||
* `param mixed` $class - A class to be mocked
|
||||
* `param array` $params - properties and methods to set
|
||||
|
||||
* return object - mock
|
||||
* throws \RuntimeException when class does not exist
|
||||
* throws \Exception
|
||||
|
||||
#### *public* makeEmpty($class, $params = null)
|
||||
Instantiates class having all methods replaced with dummies.
|
||||
Constructor is not triggered.
|
||||
Properties and methods can be set as a second parameter.
|
||||
Even protected and private properties can be set.
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$this->makeEmpty('User');
|
||||
$this->makeEmpty('User', ['name' => 'davert']);
|
||||
```
|
||||
|
||||
Accepts either name of class or object of that class
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$this->makeEmpty(new User, ['name' => 'davert']);
|
||||
```
|
||||
|
||||
To replace method provide it's name as a key in second parameter
|
||||
and it's return value or callback function as parameter
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$this->makeEmpty('User', ['save' => function () { return true; }]);
|
||||
$this->makeEmpty('User', ['save' => true));
|
||||
```
|
||||
|
||||
* `param mixed` $class
|
||||
* `param array` $params
|
||||
* `param bool|\PHPUnit\Framework\TestCase` $testCase
|
||||
|
||||
* return object
|
||||
* throws \Exception
|
||||
|
||||
#### *public* makeEmptyExcept($class, $method, $params = null)
|
||||
Instantiates class having all methods replaced with dummies except one.
|
||||
Constructor is not triggered.
|
||||
Properties and methods can be replaced.
|
||||
Even protected and private properties can be set.
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$this->makeEmptyExcept('User', 'save');
|
||||
$this->makeEmptyExcept('User', 'save', ['name' => 'davert']);
|
||||
?>
|
||||
```
|
||||
|
||||
Accepts either name of class or object of that class
|
||||
|
||||
``` php
|
||||
<?php
|
||||
* $this->makeEmptyExcept(new User, 'save');
|
||||
?>
|
||||
```
|
||||
|
||||
To replace method provide it's name as a key in second parameter
|
||||
and it's return value or callback function as parameter
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$this->makeEmptyExcept('User', 'save', ['isValid' => function () { return true; }]);
|
||||
$this->makeEmptyExcept('User', 'save', ['isValid' => true]);
|
||||
```
|
||||
|
||||
* `param mixed` $class
|
||||
* `param string` $method
|
||||
* `param array` $params
|
||||
|
||||
* return object
|
||||
* throws \Exception
|
||||
|
||||
#### *public* construct($class, $constructorParams = null, $params = null)
|
||||
Instantiates a class instance by running constructor.
|
||||
Parameters for constructor passed as second argument
|
||||
Properties and methods can be set in third argument.
|
||||
Even protected and private properties can be set.
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$this->construct('User', ['autosave' => false]);
|
||||
$this->construct('User', ['autosave' => false], ['name' => 'davert']);
|
||||
?>
|
||||
```
|
||||
|
||||
Accepts either name of class or object of that class
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$this->construct(new User, ['autosave' => false), ['name' => 'davert']);
|
||||
?>
|
||||
```
|
||||
|
||||
To replace method provide it's name as a key in third parameter
|
||||
and it's return value or callback function as parameter
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$this->construct('User', [], ['save' => function () { return true; }]);
|
||||
$this->construct('User', [], ['save' => true]);
|
||||
?>
|
||||
```
|
||||
|
||||
* `param mixed` $class
|
||||
* `param array` $constructorParams
|
||||
* `param array` $params
|
||||
* `param bool|\PHPUnit\Framework\TestCase` $testCase
|
||||
|
||||
* return object
|
||||
* throws \Exception
|
||||
|
||||
#### *public* constructEmpty($class, $constructorParams = null, $params = null)
|
||||
Instantiates a class instance by running constructor with all methods replaced with dummies.
|
||||
Parameters for constructor passed as second argument
|
||||
Properties and methods can be set in third argument.
|
||||
Even protected and private properties can be set.
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$this->constructEmpty('User', ['autosave' => false]);
|
||||
$this->constructEmpty('User', ['autosave' => false), ['name' => 'davert']);
|
||||
```
|
||||
|
||||
Accepts either name of class or object of that class
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$this->constructEmpty(new User, ['autosave' => false], ['name' => 'davert']);
|
||||
```
|
||||
|
||||
To replace method provide it's name as a key in third parameter
|
||||
and it's return value or callback function as parameter
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$this->constructEmpty('User', array(), array('save' => function () { return true; }));
|
||||
$this->constructEmpty('User', array(), array('save' => true));
|
||||
```
|
||||
|
||||
**To create a mock, pass current testcase name as last argument:**
|
||||
|
||||
```php
|
||||
<?php
|
||||
$this->constructEmpty('User', [], [
|
||||
'save' => \Codeception\Stub\Expected::once()
|
||||
]);
|
||||
```
|
||||
|
||||
* `param mixed` $class
|
||||
* `param array` $constructorParams
|
||||
* `param array` $params
|
||||
|
||||
* return object
|
||||
|
||||
#### *public* constructEmptyExcept($class, $method, $constructorParams = null, $params = null)
|
||||
Instantiates a class instance by running constructor with all methods replaced with dummies, except one.
|
||||
Parameters for constructor passed as second argument
|
||||
Properties and methods can be set in third argument.
|
||||
Even protected and private properties can be set.
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$this->constructEmptyExcept('User', 'save');
|
||||
$this->constructEmptyExcept('User', 'save', ['autosave' => false], ['name' => 'davert']);
|
||||
?>
|
||||
```
|
||||
|
||||
Accepts either name of class or object of that class
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$this->constructEmptyExcept(new User, 'save', ['autosave' => false], ['name' => 'davert']);
|
||||
?>
|
||||
```
|
||||
|
||||
To replace method provide it's name as a key in third parameter
|
||||
and it's return value or callback function as parameter
|
||||
|
||||
``` php
|
||||
<?php
|
||||
$this->constructEmptyExcept('User', 'save', [], ['save' => function () { return true; }]);
|
||||
$this->constructEmptyExcept('User', 'save', [], ['save' => true]);
|
||||
?>
|
||||
```
|
||||
|
||||
* `param mixed` $class
|
||||
* `param string` $method
|
||||
* `param array` $constructorParams
|
||||
* `param array` $params
|
||||
|
||||
* return object
|
||||
|
||||
|
||||
Reference in New Issue
Block a user