1. sfData.class.php
  2. /**
 * This class defines the interface for interacting with data, as well
 * as default implementations.
 *
 * @package    symfony
 * @subpackage addon
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfData.class.php 23810 2009-11-12 11:07:44Z Kris.Wallsmith $
 */
  3. abstract class sfData
  4. {
  5.   protected
  6.     $deleteCurrentData = true,
  7.     $object_references = array();
  9.   /**
  10.    * Sets a flag to indicate if the current data in the database
  11.    * should be deleted before new data is loaded.
  12.    *
  13.    * @param boolean $boolean The flag value
  14.    */
  15.   public function setDeleteCurrentData($boolean)
  16.   {
  17.     $this->deleteCurrentData = $boolean;
  18.   }
  20.   /**
  21.    * Gets the current value of the flag that indicates whether
  22.    * current data is to be deleted or not.
  23.    *
  24.    * @return boolean
  25.    */
  26.   public function getDeleteCurrentData()
  27.   {
  28.     return $this->deleteCurrentData;
  29.   }
  31.   /**
  32.    * Loads data for the database from a YAML file
  33.    *
  34.    * @param string $file The path to the YAML file.
  35.    */
  36.   protected function doLoadDataFromFile($file)
  37.   {
  38.     // import new datas
  39.     $data = sfYaml::load($file);
  41.     $this->loadDataFromArray($data);
  42.   }
  44.   /**
  45.    * Manages the insertion of data into the data source
  46.    *
  47.    * @param array $data The data to be inserted into the data source
  48.    */
  49.   abstract public function loadDataFromArray($data);
  51.   /**
  52.    * Manages reading all of the fixture data files and
  53.    * loading them into the data source
  54.    *
  55.    * @param array $files The path names of the YAML data files
  56.    */
  57.   protected function doLoadData(array $files)
  58.   {
  59.     $this->object_references = array();
  60.     $this->maps = array();
  62.     foreach ($files as $file)
  63.     {
  64.       $this->doLoadDataFromFile($file);
  65.     }
  66.   }
  68.   /**
  69.    * Gets a list of one or more *.yml files and returns the list in an array.
  70.    *
  71.    * The returned array of files is sorted by alphabetical order.
  72.    *
  73.    * @param string|array $element A directory or file name or an array of directories and/or file names
  74.    *                              If null, then defaults to 'sf_data_dir'/fixtures
  75.    *
  76.    * @return array A list of *.yml files
  77.    *
  78.    * @throws sfInitializationException If the directory or file does not exist.
  79.    */
  80.   public function getFiles($element = null)
  81.   {
  82.     if (null === $element)
  83.     {
  84.       $element = sfConfig::get('sf_data_dir').'/fixtures';
  85.     }
  87.     $files = array();
  88.     if (is_array($element))
  89.     {
  90.       foreach ($element as $e)
  91.       {
  92.         $files = array_merge($files, $this->getFiles($e));
  93.       }
  94.     }
  95.     else if (is_file($element))
  96.     {
  97.       $files[] = $element;
  98.     }
  99.     else if (is_dir($element))
  100.     {
  101.       $files = sfFinder::type('file')->name('*.yml')->sort_by_name()->in($element);
  102.     }
  103.     else
  104.     {
  105.       throw new sfInitializationException(sprintf('You must give an array, a directory or a file to sfData::getFiles() (%s given).', $element));
  106.     }
  108.     $files = array_unique($files);
  109.     sort($files);
  111.     return $files;
  112.   }
  113. }
Debug toolbar