DOC: SapphireTest objFromFixture

The current docs for `objFromFixture` cause PHPStorm to generate an error because of the mismatched data types.

`$product = $this->objFromFixture('ProductPage', 'StandardSpecs');`

Causes: `Expected The, got string`.
This commit is contained in:
Thomas Speak 2014-02-20 13:19:53 +00:00 committed by Tom Speak
parent caecc05b0b
commit 437cbe0d91

View File

@ -388,11 +388,11 @@ class SapphireTest extends PHPUnit_Framework_TestCase {
return $id; return $id;
} }
/** /**
* Return all of the IDs in the fixture of a particular class name. * Return all of the IDs in the fixture of a particular class name.
* Will collate all IDs form all fixtures if multiple fixtures are provided. * Will collate all IDs form all fixtures if multiple fixtures are provided.
* *
* @param string $className * @param string $className
* @return A map of fixture-identifier => object-id * @return A map of fixture-identifier => object-id
*/ */
@ -402,9 +402,11 @@ class SapphireTest extends PHPUnit_Framework_TestCase {
/** /**
* Get an object from the fixture. * Get an object from the fixture.
* *
* @param $className The data class, as specified in your fixture file. Parent classes won't work * @param string $className The data class, as specified in your fixture file. Parent classes won't work
* @param $identifier The identifier string, as provided in your fixture file * @param string $identifier The identifier string, as provided in your fixture file
*
* @return DataObject
*/ */
protected function objFromFixture($className, $identifier) { protected function objFromFixture($className, $identifier) {
$obj = $this->getFixtureFactory()->get($className, $identifier); $obj = $this->getFixtureFactory()->get($className, $identifier);