Merge pull request #108 from symfony-cmf/adjust-page-document

have additionalInfoBlock and remove createDate from page

Author: lsmith77

Admin/PageAdmin.php

@@ -40,7 +40,6 @@ protected function configureListFields(ListMapper $listMapper)
             ->addIdentifier('title', 'text')
             ->add('label', 'text')
             ->add('name', 'text')
-            ->add('createDate', 'date')
         ;
     }
 
@@ -60,7 +59,6 @@ protected function configureFormFields(FormMapper $formMapper)
                 ->add('label', null, array('required' => false))
                 ->add('title')
                 ->add('body', 'textarea')
-                ->add('createDate')
             ->end()
             ->with('form.group_advanced', array(
                 'translation_domain' => 'CmfRoutingBundle',
@@ -112,7 +110,7 @@ protected function ensureOrderByDate($page)
         $itemsByDate = array();
         /** @var $item Page */
         foreach ($items as $item) {
-            $itemsByDate[$item->getDate()->format('U')][$item->getCreateDate()->format('U')][] = $item;
+            $itemsByDate[$item->getDate()->format('U')][$item->getPublishStartDate()->format('U')][] = $item;
         }
 
         if ('asc' == $this->sortOrder) {
@@ -127,8 +125,8 @@ protected function ensureOrderByDate($page)
             } else {
                 krsort($itemsForDate);
             }
-            foreach ($itemsForDate as $itemsForCreateDate) {
-                foreach ($itemsForCreateDate as $item) {
+            foreach ($itemsForDate as $itemsForPublishDate) {
+                foreach ($itemsForPublishDate as $item) {
                     $sortedItems[$item->getName()] = $item;
                 }
             }

CHANGELOG.md

@@ -4,15 +4,18 @@ Changelog
 1.1.0-RC2
 ---------
 
+* **2014-04-15**: Page now also provides the additionalInfoBlock child. Removed
+  the createDate as its redundant with the publishStartDate.
+
 * **2014-04-11**: drop Symfony 2.2 compatibility
 
 1.1.0-RC1
 ---------
 
 * **2014-04-01**: Refactored the RoutingBundle to provide all routing
   features needed by SimpleCmsBundle.
-  * If you where only using the SimpleCmsBundle you now need to activate
-    the dynamic router. SimpleCmsBundle automatically does this for you.
+  * The dynamic router of RoutingBundle needs to be active. The
+    SimpleCmsBundle automatically does this for you.
   * The configuration for document to route/template now all happens under
     cmf_routing.dynamic and the route enhancers also apply to simplecms Pages.
     You can configure additional base paths where to look for routes in the

Doctrine/Phpcr/Page.php

@@ -15,6 +15,7 @@
 use LogicException;
 use Knp\Menu\NodeInterface;
 use Doctrine\Common\Collections\ArrayCollection;
+use Sonata\BlockBundle\Model\BlockInterface;
 use Symfony\Cmf\Bundle\CoreBundle\PublishWorkflow\PublishTimePeriodInterface;
 use Symfony\Cmf\Bundle\CoreBundle\PublishWorkflow\PublishableInterface;
 use Symfony\Cmf\Bundle\CoreBundle\Translatable\TranslatableInterface;
@@ -114,9 +115,12 @@ class Page extends Route implements
     protected $body;
 
     /**
-     * @var \DateTime
+     * This will usually be a ContainerBlock but can be any block that will be
+     * rendered in the additionalInfoBlock area.
+     *
+     * @var BlockInterface
      */
-    protected $createDate;
+    protected $additionalInfoBlock;
 
     /**
      * @var \DateTime
@@ -144,13 +148,6 @@ class Page extends Route implements
      */
     protected $extras = array();
 
-    public function __construct(array $options = array())
-    {
-        parent::__construct($options);
-
-        $this->createDate = new \DateTime();
-    }
-
     /**
      * @deprecated use getOption('add_locale_pattern') instead
      */
@@ -192,12 +189,25 @@ public function setLocale($locale)
     }
 
     /**
-     * Get the "date" of this page, which is the publishStartDate if set,
-     * otherwise the createDate.
+     * @deprecated Since 1.1 we only have the publish start date
+     *
+     * This method is kept for BC but will return the result of getDate().
+     *
+     * @return \DateTime
+     */
+    public function getCreateDate()
+    {
+        return $this->getDate();
+    }
+
+    /**
+     * Get the "date" of this page, which is the publishStartDate.
+     *
+     * @return \DateTime
      */
     public function getDate()
     {
-        return $this->publishStartDate ? $this->publishStartDate : $this->createDate;
+        return $this->getPublishStartDate();
     }
 
     /**
@@ -251,7 +261,7 @@ public function setPublishable($publishable)
     /**
      * Get extras - a flat key-value hashmap
      *
-     * @return array with only string values
+     * @return array hashmap with only string values
      */
     public function getExtras()
     {
@@ -434,26 +444,23 @@ public function getBody()
     }
 
     /**
-     * Get the creation date
-     *
-     * @return \DateTime
+     * @return BlockInterface
      */
-    public function getCreateDate()
+    public function getAdditionalInfoBlock()
     {
-        return $this->createDate;
+        return $this->additionalInfoBlock;
     }
 
     /**
-     * Overwrite the creation date manually
-     *
-     * On creation of a Page, the createDate is automatically set to the
-     * current time.
+     * Set the additional info block for this content. Usually you want this to
+     * be a container block in order to be able to add several blocks.
      *
-     * @param \DateTime $createDate
+     * @param BlockInterface $block must be persistable through cascade by the
+     *      persistence layer.
      */
-    public function setCreateDate(\DateTime $createDate = null)
+    public function setAdditionalInfoBlock($block)
     {
-        $this->createDate = $createDate;
+        $this->additionalInfoBlock = $block;
     }
 
     /**

Migrator/Phpcr/Page.php

@@ -131,10 +131,6 @@ public function migrate($path = '/', $depth = -1)
             $page->setBody($data['body']);
         }
 
-        if (isset($data['create_date'])) {
-            $page->setCreateDate(date_create_from_format('U', strtotime($data['create_date'])));
-        }
-
         if (isset($data['publish_start_date'])) {
             $page->setPublishStartDate(date_create_from_format('U', strtotime($data['publish_start_date'])));
         }

Resources/config/doctrine-phpcr/Page.phpcr.xml

@@ -14,7 +14,9 @@
         <field name="title" type="string" translated="true"/>
         <field name="label" type="string" translated="true" nullable="true"/>
         <field name="body" type="string" translated="true" nullable="true"/>
-        <field name="createDate" type="date"/>
+        <child name="additionalInfoBlock">
+            <cascade><cascade-persist /></cascade>
+        </child>
         <field name="publishable" type="boolean"/>
         <field name="publishStartDate" type="date" nullable="true"/>
         <field name="publishEndDate" type="date" nullable="true"/>

Tests/Functional/Doctrine/Phpcr/PageTest.php

@@ -39,7 +39,6 @@ public function testPage()
         $page->setTitle('Page Title');
         $page->setLabel('Page Label');
         $page->setBody('This is body');
-        $page->setCreateDate(new \DateTime('2013-07-05'));
         $page->setPublishable(false);
         $page->setPublishStartDate(new \DateTime('2013-06-18'));
         $page->setPublishEndDate(new \DateTime('2013-06-18'));

UPGRADE-1.1.md

@@ -0,0 +1,18 @@
+UPGRADE FROM 1.0 TO 1.1
+=======================
+
+Removed all custom routing service as RoutingBundle is now flexible enough.
+  * Move all routing configuration from cmf_simple_cms to cmf_routing.dynamic
+  * The configuration for locales is not needed anymore. Configuring it on the
+    cmf_routing is enough.
+  * The options for the format pattern, trailing slash and locale pattern are
+    now moved into the route "options" and the Page Document now takes an
+    array of options in the constructor instead of boolean flags.
+
+The Page document has no `createDate` field anymore. Use the publishStartDate
+for this purpose. If you where using the createDate and want to keep that
+information, you can move it to the publishStartDate with the following query:
+
+    $ php app/console doctrine:phpcr:nodes:update \
+        --query="SELECT * FROM [nt:unstructured] WHERE [phpcr:class] = \"Symfony\\Cmf\\Bundle\\SimpleCmsBundle\\Doctrine\\Phpcr\\Page\"" \
+        --apply-closure="if (!\$node->getPublishStartDate()) \$node->setProperty('publishStartDate', \$node->getPropertyValue('createDate'));"