Doctrine 1.2.4
Doctrine_Data Class Reference

Inherited by Doctrine_Data_Export, and Doctrine_Data_Import.

Public Member Functions

 exportData ($directory, $format= 'yml', $models=array(), $_exportIndividualFiles=false)
 
 exportIndividualFiles ($bool=null)
 
 getDirectory ()
 
 getFormat ()
 
 getFormats ()
 
 getModels ()
 
 importData ($directory, $format= 'yml', $models=array(), $append=false)
 
 isRelation (Doctrine_Record $record, $fieldName)
 
 purge ($models=null)
 
 setDirectory ($directory)
 
 setFormat ($format)
 
 setModels ($models)
 

Detailed Description

Definition at line 36 of file Data.php.

Member Function Documentation

Doctrine_Data::exportData (   $directory,
  $format = 'yml',
  $models = array(),
  $_exportIndividualFiles = false 
)

exportData

Interface for exporting data to fixtures files from Doctrine models

Parameters
string$directory
string$format
string$models
string$_exportIndividualFiles
Returns
void

Definition at line 196 of file Data.php.

{
$export = new Doctrine_Data_Export($directory);
$export->setFormat($format);
$export->setModels($models);
$export->exportIndividualFiles($_exportIndividualFiles);
return $export->doExport();
}
Doctrine_Data::exportIndividualFiles (   $bool = null)

_exportIndividualFiles

Set/Get whether or not to export individual files

Returns
bool $_exportIndividualFiles

Definition at line 176 of file Data.php.

{
if ($bool !== null) {
$this->_exportIndividualFiles = $bool;
}
return $this->_exportIndividualFiles;
}
Doctrine_Data::getDirectory ( )

getDirectory

Get directory for dumping/loading data from and to

Returns
void

Definition at line 139 of file Data.php.

{
return $this->_directory;
}
Doctrine_Data::getFormat ( )

getFormat

Get the current format we are working with

Returns
void

Definition at line 103 of file Data.php.

{
return $this->_format;
}
Doctrine_Data::getFormats ( )

getFormats

Get array of available formats

Returns
void

Definition at line 115 of file Data.php.

{
return $this->_formats;
}
Doctrine_Data::getModels ( )

getModels

Get the array of specified models to work with

Returns
void

Definition at line 164 of file Data.php.

{
return $this->_models;
}
Doctrine_Data::importData (   $directory,
  $format = 'yml',
  $models = array(),
  $append = false 
)

importData

Interface for importing data from fixture files to Doctrine models

Parameters
string$directory
string$format
string$models
Returns
void

Definition at line 216 of file Data.php.

{
$import = new Doctrine_Data_Import($directory);
$import->setFormat($format);
$import->setModels($models);
return $import->doImport($append);
}
Doctrine_Data::isRelation ( Doctrine_Record  $record,
  $fieldName 
)

isRelation

Check if a fieldName on a Doctrine_Record is a relation, if it is we return that relationData

Parameters
string$Doctrine_Record
string$fieldName
Returns
void

Definition at line 234 of file Data.php.

{
$relations = $record->getTable()->getRelations();
foreach ($relations as $relation) {
$relationData = $relation->toArray();
if ($relationData['local'] === $fieldName) {
return $relationData;
}
}
return false;
}
Doctrine_Data::purge (   $models = null)

purge

Purge all data for loaded models or for the passed array of Doctrine_Records

Parameters
string$models
Returns
void

Definition at line 258 of file Data.php.

{
if ($models) {
} else {
}
$connections = array();
foreach ($models as $model) {
$connections[Doctrine_Core::getTable($model)->getConnection()->getName()][] = $model;
}
foreach ($connections as $connection => $models) {
$models = Doctrine_Manager::getInstance()->getConnection($connection)->unitOfWork->buildFlushTree($models);
$models = array_reverse($models);
foreach ($models as $model) {
Doctrine_Core::getTable($model)->createQuery()->delete()->execute();
}
}
}
Doctrine_Data::setDirectory (   $directory)

setDirectory

Set the array/string of directories or yml file paths

Returns
void

Definition at line 127 of file Data.php.

{
$this->_directory = $directory;
}
Doctrine_Data::setFormat (   $format)

setFormat

Set the current format we are working with

Parameters
string$format
Returns
void

Definition at line 91 of file Data.php.

{
$this->_format = $format;
}
Doctrine_Data::setModels (   $models)

setModels

Set the array of specified models to work with

Parameters
string$models
Returns
void

Definition at line 152 of file Data.php.

{
$this->_models = $models;
}

The documentation for this class was generated from the following file: