Improving metadata caching performance by only serializing what is ab…

…solutely necessary.
doctrine · Apr 18, 2010 · 4b71afe · 4b71afe
1 parent 4b39705
commit 4b71afe
Show file tree

Hide file tree

Showing 7 changed files with 170 additions and 30 deletions.
diff --git a/lib/Doctrine/Common/Annotations/Parser.php b/lib/Doctrine/Common/Annotations/Parser.php
@@ -1,7 +1,5 @@
 <?php
 /*
- *  $Id$
- *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
@@ -250,7 +248,7 @@ public function Annotation()
 
         // Is it really an annotation class?
         if (
-            (! $this->_isNestedAnnotation && $this->_lexer->lookahead != null &&
+            ( ! $this->_isNestedAnnotation && $this->_lexer->lookahead != null &&
             ! $this->_lexer->isNextToken(Lexer::T_OPEN_PARENTHESIS) &&
             ! $this->_lexer->isNextToken(Lexer::T_AT)) ||
             ! class_exists($name, false)

diff --git a/lib/Doctrine/ORM/Mapping/AssociationMapping.php b/lib/Doctrine/ORM/Mapping/AssociationMapping.php
@@ -340,5 +340,58 @@ public function getQuotedJoinTableName($platform)
             ? $platform->quoteIdentifier($this->joinTable['name'])
             : $this->joinTable['name'];
     }
-
+
+    /**
+     * Determines which fields get serialized.
+     *
+     * It is only serialized what is necessary for best unserialization performance.
+     * That means any metadata properties that are not set or empty or simply have
+     * their default value are NOT serialized.
+     *
+     * @return array The names of all the fields that should be serialized.
+     */
+    public function __sleep()
+    {
+        $serialized = array(
+            'sourceEntityName',
+            'targetEntityName',
+            'sourceFieldName'
+        );
+
+        if ($this->isCascadeDetach) {
+            $serialized[] = 'isCascadeDetach';
+        }
+        if ($this->isCascadeMerge) {
+            $serialized[] = 'isCascadeMerge';
+        }
+        if ($this->isCascadePersist) {
+            $serialized[] = 'isCascadePersist';
+        }
+        if ($this->isCascadeRefresh) {
+            $serialized[] = 'isCascadeRefresh';
+        }
+        if ($this->isCascadeRemove) {
+            $serialized[] = 'isCascadeRemove';
+        }
+        if ( ! $this->isOwningSide) {
+            $serialized[] = 'isOwningSide';
+        }
+        if ($this->mappedBy) {
+            $serialized[] = 'mappedBy';
+        }
+        if ($this->inversedBy) {
+            $serialized[] = 'inversedBy';
+        }
+        if ($this->joinTable) {
+            $serialized[] = 'joinTable';
+        }
+        if ($this->inherited) {
+            $serialized[] = 'inherited';
+        }
+        if ($this->declared) {
+            $serialized[] = 'declared';
+        }
+
+        return $serialized;
+    }
 }
diff --git a/lib/Doctrine/ORM/Mapping/ClassMetadata.php b/lib/Doctrine/ORM/Mapping/ClassMetadata.php
@@ -264,40 +264,69 @@ public function __toString()
 
     /**
      * Determines which fields get serialized.
+     *
+     * It is only serialized what is necessary for best unserialization performance.
+     * That means any metadata properties that are not set or empty or simply have
+     * their default value are NOT serialized.
      * 
-     * Parts that are NOT serialized because they can not be properly unserialized:
+     * Parts that are also NOT serialized because they can not be properly unserialized:
      *      - reflClass (ReflectionClass)
      *      - reflFields (ReflectionProperty array)
      * 
      * @return array The names of all the fields that should be serialized.
      */
     public function __sleep()
     {
-        return array(
-            'associationMappings', // unserialization "bottleneck" with many associations
-            'changeTrackingPolicy',
+        // This metadata is always serialized/cached.
+        $serialized = array(
+            'associationMappings',
             'columnNames', //TODO: Not really needed. Can use fieldMappings[$fieldName]['columnName']
-            'customRepositoryClassName',
-            'discriminatorColumn',
-            'discriminatorValue',
-            'discriminatorMap',
-            'fieldMappings',//TODO: Not all of this stuff needs to be serialized. Only type, columnName and fieldName.
-            'fieldNames', 
-            'generatorType',
+            'fieldMappings',
+            'fieldNames',
             'identifier',
-            'idGenerator', //TODO: Does not really need to be serialized. Could be moved to runtime.
-            'inheritanceType',
-            'isIdentifierComposite',
-            'isMappedSuperclass',
-            'isVersioned',
-            'lifecycleCallbacks',
+            'isIdentifierComposite', // TODO: REMOVE
             'name',
-            'parentClasses',
             'table',
             'rootEntityName',
-            'subClasses',
-            'versionField'
+            'idGenerator', //TODO: Does not really need to be serialized. Could be moved to runtime.
         );
+
+        // The rest of the metadata is only serialized if necessary.
+        if ($this->changeTrackingPolicy != self::CHANGETRACKING_DEFERRED_IMPLICIT) {
+            $serialized[] = 'changeTrackingPolicy';
+        }
+
+        if ($this->customRepositoryClassName) {
+            $serialized[] = 'customRepositoryClassName';
+        }
+
+        if ($this->inheritanceType != self::INHERITANCE_TYPE_NONE) {
+            $serialized[] = 'inheritanceType';
+            $serialized[] = 'discriminatorColumn';
+            $serialized[] = 'discriminatorValue';
+            $serialized[] = 'discriminatorMap';
+            $serialized[] = 'parentClasses';
+            $serialized[] = 'subClasses';
+        }
+
+        if ($this->generatorType != self::GENERATOR_TYPE_NONE) {
+            $serialized[] = 'generatorType';
+        }
+
+        if ($this->isMappedSuperclass) {
+            $serialized[] = 'isMappedSuperclass';
+        }
+
+        if ($this->isVersioned) {
+            $serialized[] = 'isVersioned';
+            $serialized[] = 'versionField';
+        }
+
+        if ($this->lifecycleCallbacks) {
+            $serialized[] = 'lifecycleCallbacks';
+        }
+
+        return $serialized;
     }
 
     /**

diff --git a/lib/Doctrine/ORM/Mapping/ManyToManyMapping.php b/lib/Doctrine/ORM/Mapping/ManyToManyMapping.php
@@ -1,7 +1,5 @@
 <?php
 /*
- *  $Id$
- *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
@@ -182,4 +180,25 @@ public function isManyToMany()
     {
         return true;
     }
+
+    /**
+     * Determines which fields get serialized.
+     *
+     * It is only serialized what is necessary for best unserialization performance.
+     * That means any metadata properties that are not set or empty or simply have
+     * their default value are NOT serialized.
+     *
+     * @return array The names of all the fields that should be serialized.
+     */
+    public function __sleep()
+    {
+        $serialized = parent::__sleep();
+        $serialized[] = 'joinTableColumns';
+        $serialized[] = 'relationToSourceKeyColumns';
+        $serialized[] = 'relationToTargetKeyColumns';
+        if ($this->orderBy) {
+            $serialized[] = 'orderBy';
+        }
+        return $serialized;
+    }
 }
diff --git a/lib/Doctrine/ORM/Mapping/OneToManyMapping.php b/lib/Doctrine/ORM/Mapping/OneToManyMapping.php
@@ -1,7 +1,5 @@
 <?php
 /*
- *  $Id$
- *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
@@ -136,4 +134,25 @@ public function load($sourceEntity, $targetCollection, $em, array $joinColumnVal
 
         $persister->loadOneToManyCollection($this, $conditions, $targetCollection);
     }
+
+    /**
+     * Determines which fields get serialized.
+     *
+     * It is only serialized what is necessary for best unserialization performance.
+     * That means any metadata properties that are not set or empty or simply have
+     * their default value are NOT serialized.
+     *
+     * @return array The names of all the fields that should be serialized.
+     */
+    public function __sleep()
+    {
+        $serialized = parent::__sleep();
+        if ($this->orderBy) {
+            $serialized[] = 'orderBy';
+        }
+        if ($this->orphanRemoval) {
+            $serialized[] = 'orphanRemoval';
+        }
+        return $serialized;
+    }
 }
diff --git a/lib/Doctrine/ORM/Mapping/OneToOneMapping.php b/lib/Doctrine/ORM/Mapping/OneToOneMapping.php
@@ -1,7 +1,5 @@
 <?php
 /*
- *  $Id$
- *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
@@ -187,4 +185,26 @@ public function load($sourceEntity, $targetEntity, $em, array $joinColumnValues
 
         return $targetEntity;
     }
+
+    /**
+     * Determines which fields get serialized.
+     *
+     * It is only serialized what is necessary for best unserialization performance.
+     * That means any metadata properties that are not set or empty or simply have
+     * their default value are NOT serialized.
+     *
+     * @return array The names of all the fields that should be serialized.
+     */
+    public function __sleep()
+    {
+        $serialized = parent::__sleep();
+        $serialized[] = 'joinColumns';
+        $serialized[] = 'joinColumnFieldNames';
+        $serialized[] = 'sourceToTargetKeyColumns';
+        $serialized[] = 'targetToSourceKeyColumns';
+        if ($this->orphanRemoval) {
+            $serialized[] = 'orphanRemoval';
+        }
+        return $serialized;
+    }
 }
diff --git a/tests/Doctrine/Tests/ORM/Mapping/ClassMetadataTest.php b/tests/Doctrine/Tests/ORM/Mapping/ClassMetadataTest.php
@@ -20,8 +20,10 @@ public function testClassMetadataInstanceSerialization()
         $this->assertEquals('Doctrine\Tests\Models\CMS\CmsUser', $cm->rootEntityName);
         $this->assertEquals(array(), $cm->subClasses);
         $this->assertEquals(array(), $cm->parentClasses);
+        $this->assertEquals(ClassMetadata::INHERITANCE_TYPE_NONE, $cm->inheritanceType);
 
         // Customize state
+        $cm->setInheritanceType(ClassMetadata::INHERITANCE_TYPE_SINGLE_TABLE);
         $cm->setSubclasses(array("One", "Two", "Three"));
         $cm->setParentClasses(array("UserParent"));
         $cm->setCustomRepositoryClass("UserRepository");