From 437cbe0d91ceb210c6d24d99f97d19f346e5a0ae Mon Sep 17 00:00:00 2001 From: Thomas Speak Date: Thu, 20 Feb 2014 13:19:53 +0000 Subject: [PATCH] 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`. --- dev/SapphireTest.php | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/dev/SapphireTest.php b/dev/SapphireTest.php index e13b4c518..4e4c7d9eb 100644 --- a/dev/SapphireTest.php +++ b/dev/SapphireTest.php @@ -388,11 +388,11 @@ class SapphireTest extends PHPUnit_Framework_TestCase { return $id; } - + /** * 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. - * + * * @param string $className * @return A map of fixture-identifier => object-id */ @@ -402,9 +402,11 @@ class SapphireTest extends PHPUnit_Framework_TestCase { /** * Get an object from the fixture. - * - * @param $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 $className The data class, as specified in your fixture file. Parent classes won't work + * @param string $identifier The identifier string, as provided in your fixture file + * + * @return DataObject */ protected function objFromFixture($className, $identifier) { $obj = $this->getFixtureFactory()->get($className, $identifier);