" * * There are a couple of lines like this: * * Parent: =>Page.about * * This will tell the system to set the ParentID database field to the ID of the Page object with the identifier ŇaboutÓ. * This can be used on any has-one or many-many relationship. * Note that we use the name of the relationship (Parent), and not the name of the database field (ParentID) * * On many-many relationships, you should specify a comma separated list of values. * * MyRelation: =>Class.inst1,=>Class.inst2,=>Class.inst3 * * * An crucial thing to note is that the YAML file specifies DataObjects, not database records. * The database is populated by instantiating DataObject objects, setting the fields listed, and calling write(). * This means that any onBeforeWrite() or default value logic will be executed as part of the test. * This forms the basis of our testURLGeneration() test above. * * For example, the URLSegment value of Page.staffduplicate is the same as the URLSegment value of Page.staff. * When the fixture is set up, the URLSegment value of Page.staffduplicate will actually be my-staff-2. * * Finally, be aware that requireDefaultRecords() is not called by the database populator - * so you will need to specify standard pages such as 404 and home in your YAML file. * * * Page: * home: * Title: Home * about: * Title: About Us * staff: * Title: Staff * URLSegment: my-staff * Parent: =>Page.about * staffduplicate: * Title: Staff * URLSegment: my-staff * Parent: =>Page.about * products: * Title: Products * ErrorPage: * 404: * Title: Page not Found * ErrorCode: 404 * * * @package sapphire * @subpackage core * * @see http://code.google.com/p/spyc/ * * @todo Write unit test for YamlFixture */ class YamlFixture extends Object { /** * Absolute path to the .yml fixture file * * @var string */ protected $fixtureFile; /** * Array of fixture items * * @var array */ protected $fixtureDictionary; /** * @param String Absolute file path, or relative path to {@link Director::baseFolder()} */ function __construct($fixtureFile) { if(!Director::is_absolute($fixtureFile)) $fixtureFile = Director::baseFolder().'/'. $fixtureFile; if(!file_exists($fixtureFile)) { throw new InvalidArgumentException('YamlFixture::__construct(): Fixture path "' . $fixtureFile . '" not found'); } $this->fixtureFile = $fixtureFile; parent::__construct(); } /** * @return String Absolute file path */ function getFixtureFile() { return $this->fixtureFile; } /** * Get the ID of 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 */ public function idFromFixture($className, $identifier) { if(isset($this->fixtureDictionary[$className][$identifier])) { return $this->fixtureDictionary[$className][$identifier]; } else { return false; } } /** * Return all of the IDs in the fixture of a particular class name. * * @return A map of fixture-identifier => object-id */ public function allFixtureIDs($className) { if(isset($this->fixtureDictionary[$className])) { return $this->fixtureDictionary[$className]; } else { return false; } } /** * 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 */ public function objFromFixture($className, $identifier) { $id = $this->idFromFixture($className, $identifier); if($id) return DataObject::get_by_id($className, $id); } /** * Load a YAML fixture file into the database. * Once loaded, you can use idFromFixture() and objFromFixture() to get items from the fixture. * * Caution: In order to support reflexive relations which need a valid object ID, * the record is written twice: first after populating all non-relational fields, * then again after populating all relations (has_one, has_many, many_many). */ public function saveIntoDatabase(DataModel $model) { // We have to disable validation while we import the fixtures, as the order in // which they are imported doesnt guarantee valid relations until after the // import is complete. $validationenabled = DataObject::get_validation_enabled(); DataObject::set_validation_enabled(false); $parser = new Spyc(); $fixtureContent = $parser->loadFile($this->fixtureFile); $this->fixtureDictionary = array(); foreach($fixtureContent as $dataClass => $items) { if(ClassInfo::exists($dataClass)) { $this->writeDataObject($model, $dataClass, $items); } else { $this->writeSQL($dataClass, $items); } } DataObject::set_validation_enabled($validationenabled); } /** * Writes the fixture into the database using DataObjects * * @param string $dataClass * @param array $items */ protected function writeDataObject($model, $dataClass, $items) { foreach($items as $identifier => $fields) { $obj = $model->$dataClass->newObject(); // If an ID is explicitly passed, then we'll sort out the initial write straight away // This is just in case field setters triggered by the population code in the next block // Call $this->write(). (For example, in FileTest) if(isset($fields['ID'])) { $obj->ID = $fields['ID']; // The database needs to allow inserting values into the foreign key column (ID in our case) $conn = DB::getConn(); if(method_exists($conn, 'allowPrimaryKeyEditing')) $conn->allowPrimaryKeyEditing(ClassInfo::baseDataClass($dataClass), true); $obj->write(false, true); if(method_exists($conn, 'allowPrimaryKeyEditing')) $conn->allowPrimaryKeyEditing(ClassInfo::baseDataClass($dataClass), false); } // Populate the dictionary with the ID if($fields) foreach($fields as $fieldName => $fieldVal) { if($obj->many_many($fieldName) || $obj->has_many($fieldName) || $obj->has_one($fieldName)) continue; $obj->$fieldName = $this->parseFixtureVal($fieldVal); } $obj->write(); // has to happen before relations in case a class is referring to itself $this->fixtureDictionary[$dataClass][$identifier] = $obj->ID; // Populate all relations if($fields) foreach($fields as $fieldName => $fieldVal) { if($obj->many_many($fieldName) || $obj->has_many($fieldName)) { $parsedItems = array(); $items = preg_split('/ *, */',trim($fieldVal)); foreach($items as $item) { $parsedItems[] = $this->parseFixtureVal($item); } $obj->write(); if($obj->has_many($fieldName)) { $obj->getComponents($fieldName)->setByIDList($parsedItems); } elseif($obj->many_many($fieldName)) { $obj->getManyManyComponents($fieldName)->setByIDList($parsedItems); } } elseif($obj->has_one($fieldName)) { $obj->{$fieldName . 'ID'} = $this->parseFixtureVal($fieldVal); } } $obj->write(); //If LastEdited was set in the fixture, set it here if (array_key_exists('LastEdited', $fields)) { $manip = array($dataClass => array("command" => "update", "id" => $obj->id, "fields" => array("LastEdited" => "'".$this->parseFixtureVal($fields['LastEdited'])."'"))); DB::manipulate($manip); } } } /** * Writes the fixture into the database directly using a database manipulation * * @param string $table * @param array $items */ protected function writeSQL($table, $items) { foreach($items as $identifier => $fields) { $manipulation = array($table => array("fields" => array(), "command" => "insert")); foreach($fields as $fieldName=> $fieldVal) { $manipulation[$table]["fields"][$fieldName] = "'".$this->parseFixtureVal($fieldVal)."'"; } DB::manipulate($manipulation); $this->fixtureDictionary[$table][$identifier] = DB::getGeneratedID($table); } } /** * Parse a value from a fixture file. If it starts with => it will get an ID from the fixture dictionary */ protected function parseFixtureVal($fieldVal) { // Parse a dictionary reference - used to set foreign keys if(substr($fieldVal,0,2) == '=>') { list($a, $b) = explode('.', substr($fieldVal,2), 2); return $this->fixtureDictionary[$a][$b]; // Regular field value setting } else { return $fieldVal; } } }