Commit 14e18a6

committed

documentation

1 parent 8b2f8c4 commit 14e18a6Copy full SHA for 14e18a6

File tree

+31

-3

lines changed

+31

-3

lines changed

Lines changed: 30 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -3,12 +3,40 @@`
`3`	`3`	`This package integrates the function mock library`
`4`	`4`	`[PHP-Mock](https://github.com/php-mock/php-mock) with Mockery.`
`5`	`5`
`6`		`-# Requirements`
`7`		`-`
`8`	`6`	`# Installation`
`9`	`7`
	`8`	`+Use [Composer](https://getcomposer.org/):`
	`9`	`+`
	`10`	+```json
	`11`	`+{`
	`12`	`+ "require-dev": {`
	`13`	`+ "php-mock/mockery": "0.1"`
	`14`	`+ }`
	`15`	`+}`
	`16`	+```
	`17`	`+`
`10`	`18`	`# Usage`
`11`	`19`
	`20`	+[`PHPMockery::mock()`](http://php-mock.github.io/mockery/api/class-phpmock.mockery.PHPMockery.html#_mock)
	`21`	`+let's you build a function mock which can be equiped`
	`22`	`+with Mockery's expectations. After your test you'll have to disable all created`
	`23`	+function mocks by calling `Mockery::close()`.
	`24`	`+`
	`25`	`+## Example`
	`26`	`+`
	`27`	+```php
	`28`	`+<?php`
	`29`	`+`
	`30`	`+namespace foo;`
	`31`	`+`
	`32`	`+use phpmock\mockery\PHPMockery;`
	`33`	`+`
	`34`	`+$mock = PHPMockery::mock(__NAMESPACE__, "time")->andReturn(3);`
	`35`	`+assert (3 == time());`
	`36`	`+`
	`37`	`+\Mockery::close();`
	`38`	+```
	`39`	`+`
`12`	`40`	`# License and authors`
`13`	`41`
`14`	`42`	`This project is free and under the WTFPL.`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`"require": {`
`20`	`20`	`"php": ">=5.4",`
`21`	`21`	`"mockery/mockery": "^0.8",`
`22`		`- "php-mock/integration": "dev-master"`
	`22`	`+ "php-mock/integration": "^0.2"`
`23`	`23`	`},`
`24`	`24`	`"minimum-stability": "dev",`
`25`	`25`	`"require-dev": {`

Comments

(0)