Doctrine

Timestamp:

03/10/08 20:08:13 (16 months ago)

Author:

jwage

Message:

Fixed issue with options not existing in Schema.php. A few minor other changes.

Location:

branches/0.10/lib/Doctrine/Import

Files:

• Builder.php (modified) (4 diffs)
• Schema.php (modified) (16 diffs)

branches/0.10/lib/Doctrine/Import/Builder.php

@@ -61 +61 @@
      */
     protected $_packagesPath = '';
-    
+
+    /**
+     * _packagesFolderName
+     *
+     * @var string
+     */
+    protected $_packagesFolderName = 'packages';
+
     /**
      * _suffix
@@ -104 +111 @@
      */
     protected $_baseClassName = 'Doctrine_Record';
-    
+
     /**
      * _tpl
@@ -134 +141 @@
         if ($path) {
             if ( ! $this->_packagesPath) {
-                $this->setPackagesPath($path . DIRECTORY_SEPARATOR . 'packages');
+                $this->setPackagesPath($path . DIRECTORY_SEPARATOR . $this->_packagesFolderName);
             }
 
@@ -252 +259 @@
     public function setOptions($options)
     {
-        if (!empty($options)) {
+        if ( ! empty($options)) {
             foreach ($options as $key => $value) {
                 $this->setOption($key, $value);

branches/0.10/lib/Doctrine/Import/Schema.php

@@ -21 +21 @@
 
 /**
- * class Doctrine_Import_Schema
+ * Doctrine_Import_Schema
  *
- * Different methods to import a XML schema. The logic behind using two different
- * methods is simple. Some people will like the idea of producing Doctrine_Record
- * objects directly, which is totally fine. But in fast and growing application,
- * table definitions tend to be a little bit more volatile. importArr() can be used
- * to output a table definition in a PHP file. This file can then be stored
- * independantly from the object itself.
+ * Class for importing Doctrine_Record classes from a yaml schema definition
  *
  * @package     Doctrine
@@ -43 +38 @@
     protected $_options = array('packagesPrefix'        =>  'Package',
                                 'packagesPath'          =>  '',
+                                'packagesFolderName'    =>  'packages',
+                                'suffix'                =>  '.php',
                                 'generateBaseClasses'   =>  true,
+                                'baseClassesPrefix'     =>  'Base',
                                 'baseClassesDirectory'  =>  'generated',
-                                'baseClassName'         =>  'Doctrine_Record',
-                                'suffix'                =>  '.php');
+                                'baseClassName'         =>  'Doctrine_Record');
     
     /**
@@ -93 +90 @@
     public function setOptions($options)
     {
-        if (!empty($options)) {
+        if ( ! empty($options)) {
           $this->_options = $options;
         }
@@ -101 +98 @@
      * buildSchema
      *
-     * Loop throug directories of schema files and part them all in to one complete array of schema information
+     * Loop throug directories of schema files and parse them all in to one complete array of schema information
      *
      * @param  string   $schema Array of schema files or single schema file. Array of directories with schema files or single directory
@@ -141 +138 @@
      *
      * @param  string $schema       The file containing the XML schema
+     * @param  string $format       Format of the schema file
      * @param  string $directory    The directory where the Doctrine_Record class will be written
-     * @param  array $models        Optional array of models to import
+     * @param  array  $models       Optional array of models to import
      *
      * @return void
@@ -170 +168 @@
      *
      * @param  string $schema   Path to the file containing the schema
+     * @param  string $type     Format type of the schema we are parsing
      * @return array  $build    Built array of schema information
      */
@@ -312 +311 @@
      * 
      * Perform some processing on inheritance.
+     * Sets the default type and sets some default values for certain types
      *
      * @param string $array 
@@ -348 +348 @@
 
         // Array of the array keys to move to the parent, and the value to default the child definition to
-        // after moving it
+        // after moving it. Will also populate the subclasses array for the inheritance parent
         $moves = array('columns' => array(), 'relations' => array());
         
@@ -362 +362 @@
                 }
 
+                // Populate the parents subclasses
                 if ($definition['inheritance']['type'] == 'column_aggregation') {
                     $array[$extends]['inheritance']['subclasses'][$definition['className']] = array($definition['inheritance']['keyField'] => $definition['inheritance']['keyValue']);
@@ -375 +376 @@
      *
      * Loop through an array of schema information and build all the necessary relationship information
-     * Will attempt to auto complete relationships and simplify the amount of information required for defining a relationship
+     * Will attempt to auto complete relationships and simplify the amount of information required 
+     * for defining a relationship
      *
      * @param  string $array 
@@ -387 +389 @@
             if (isset($properties['columns']) && ! empty($properties['columns']) && isset($properties['detect_relations']) && $properties['detect_relations']) {
                 foreach ($properties['columns'] as $column) {
+                    // Check if the column we are inflecting has a _id on the end of it before trying to inflect it and find
+                    // the class name for the column
                     if (strpos($column['name'], '_id')) {
                         $columnClassName = Doctrine_Inflector::classify(str_replace('_id', '', $column['name']));
@@ -445 +449 @@
         // Make sure we do not have any duplicate relations
         $this->_fixDuplicateRelations();
-        
+
+        // Set the full array of relationships for each class to the final array
         foreach ($this->_relations as $className => $relations) {
             $array[$className]['relations'] = $relations;
@@ -485 +490 @@
                     }
                 }
-                
+
+                // Make sure it doesn't already exist
                 if ( ! isset($this->_relations[$relation['class']][$newRelation['alias']])) {
                     $newRelation['key'] = $this->_buildUniqueRelationKey($newRelation);
@@ -506 +512 @@
                 } else {
                     // check to see if this relationship is not autogenerated, if it's not, then the user must have explicitly declared it
-                    if (!isset($relation['autogenerated']) || $relation['autogenerated'] != true) {
+                    if ( ! isset($relation['autogenerated']) || $relation['autogenerated'] != true) {
                         $uniqueRelations = array_merge($uniqueRelations, array($relation['alias'] => $relation));
                     }
@@ -519 +525 @@
      * _buildUniqueRelationKey
      *
+     * Build a unique key to identify a relationship by
+     * Md5 hash of all the relationship parameters
+     *
      * @param string $relation 
      * @return void
@@ -524 +533 @@
     protected function _buildUniqueRelationKey($relation)
     {
-      return md5($relation['local'].$relation['foreign'].$relation['class'].(isset($relation['refClass']) ? $relation['refClass']:null));
+        return md5($relation['local'].$relation['foreign'].$relation['class'].(isset($relation['refClass']) ? $relation['refClass']:null));
     }
 }