Example for admin metadata implementation,

.travis.yml

@@ -1,7 +1,6 @@
 language: php
 
 php:
-  - 5.4
   - 5.5
   - 5.6
   - 7.0

Description/Description.php

@@ -0,0 +1,63 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2015 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Component\Resource\Description;
+
+class Description
+{
+    private $descriptors = [];
+    private $payloadType;
+
+    public function __construct($payloadType)
+    {
+        $this->payloadType = $payloadType;
+    }
+
+    /**
+     * Return the descriptors value for the given key.
+     *
+     * The key should be one of the constants defined in this class.
+     *
+     * @param string $key
+     *
+     * @return mixed
+     */
+    public function get($key)
+    {
+        if (!isset($this->descriptors[$key])) {
+            throw new \InvalidArgumentException(sprintf(
+                'Descriptor "%s" not supported for payload type "%s". Supported descriptors: "%s"',
+                $key,
+                $this->payloadType,
+                implode('", "', array_keys($this->descriptors))
+            ));
+        }
+
+        return $this->descriptors[$key];
+    }
+
+    /**
+     * Set value for descriptors key.
+     *
+     * - It is possible to overwrite existing keys.
+     *
+     * - To help ensure interoperability, where possible, the key should be the
+     *   value of one of the appropriate constants defined in the MetadescriptorsKey
+     *   class.
+     *
+     * @param string $key
+     * @param mixed  $value
+     */
+    public function set($key, $value)
+    {
+        $this->descriptors[$key] = $value;
+    }
+}

Description/DescriptionEnricherInterface.php

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2015 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Component\Resource\Description;
+
+use Symfony\Cmf\Component\Resource\Repository\Resource\CmfResource;
+
+interface DescriptionEnricherInterface
+{
+    /**
+     * Enrich the payload description.
+     *
+     * @param Description $description
+     * @param object      $payload
+     *
+     * @return Description
+     */
+    public function enrich(Description $description, $payload);
+
+    /**
+     * Return true if the provider supports the given type.
+     *
+     * @param CmfResource $resource
+     *
+     * @return bool
+     */
+    public function supports(CmfResource $resource);
+}

Description/DescriptionFactory.php

@@ -0,0 +1,49 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2015 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Component\Resource\Description;
+
+use Symfony\Cmf\Component\Resource\Repository\Resource\CmfResource;
+
+class DescriptionFactory
+{
+    private $enrichers = [];
+
+    /**
+     * @param array $enrichers
+     */
+    public function __construct(array $enrichers)
+    {
+        $this->enrichers = $enrichers;
+    }
+
+    /**
+     * Return a description of the given (CMF) Resource.
+     *
+     * @param CmfResource $resource
+     */
+    public function getPayloadDescriptionFor(CmfResource $resource)
+    {
+        $type = $resource->getPayloadType();
+        $payload = $resource->getPayload();
+        $description = new Description($type);
+
+        foreach ($this->enrichers as $enricher) {
+            if (false === $enricher->supports($resource)) {
+                continue;
+            }
+
+            $enricher->enrich($description, $payload);
+        }
+
+        return $description;
+    }
+}

Description/Descriptor.php

@@ -0,0 +1,52 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2015 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Component\Resource\Description;
+
+/**
+ * Class containing standard description keys which should be used when appropriate
+ * by enrichers in order to provide a level of interoperability.
+ */
+final class Descriptor
+{
+    /**
+     * Alias for the resource type for example `app.page`.
+     */
+    const TYPE_ALIAS = 'type.alias';
+
+    /**
+     * Humanized representation of the resource type.
+     */
+    const TYPE_TITLE = 'type.title';
+
+    /**
+     * Title of the actual payload, e.g. "My Blog Post".
+     */
+    const PAYLOAD_TITLE = 'title';
+
+    /**
+     * Keys to be used to store link values for HTML.
+     */
+    const LINK_EDIT_HTML = 'link.edit.html';
+    const LINK_CREATE_HTML = 'link.create.html';
+    const LINK_UPDATE_HTML = 'link.update.html';
+    const LINK_REMOVE_HTML = 'link.remove.html';
+    const LINK_SHOW_HTML = 'link.show.html';
+
+    /**
+     * Keys to be used to store link values for REST.
+     */
+    const LINK_EDIT_REST = 'link.edit.rest';
+    const LINK_CREATE_REST = 'link.create.rest';
+    const LINK_UPDATE_REST = 'link.update.rest';
+    const LINK_REMOVE_REST = 'link.remove.rest';
+    const LINK_SHOW_REST = 'link.show.rest';
+}

Tests/Unit/Description/DescriptionFactoryTest.php

@@ -0,0 +1,97 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2015 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Component\Resource\Tests\Unit\Repository;
+
+use Symfony\Cmf\Component\Resource\Description\Description;
+use Symfony\Cmf\Component\Resource\Description\DescriptionEnricherInterface;
+use Prophecy\Argument;
+use Symfony\Cmf\Component\Resource\Description\DescriptionFactory;
+use Symfony\Cmf\Component\Resource\Repository\Resource\CmfResource;
+
+class DescriptionFactoryTest extends \PHPUnit_Framework_TestCase
+{
+    private $factory;
+    private $enricher1;
+    private $enricher2;
+    private $payload;
+    private $resource;
+
+    public function setUp()
+    {
+        $this->enricher1 = $this->prophesize(DescriptionEnricherInterface::class);
+        $this->enricher2 = $this->prophesize(DescriptionEnricherInterface::class);
+        $this->resource = $this->prophesize(CmfResource::class);
+
+        $this->payload = new \stdClass();
+        $this->resource->getPayload()->willReturn($this->payload);
+        $this->resource->getPayloadType()->willReturn('payload-type');
+    }
+
+    /**
+     * It should return an enriched description.
+     */
+    public function testGetPayloadDescription()
+    {
+        $this->enricher1->enrich(Argument::type(Description::class), $this->payload)
+            ->will(function ($args) {
+                $description = $args[0];
+                $description->set('foobar', 'barfoo');
+            });
+        $this->enricher1->supports($this->resource->reveal())->willReturn(true);
+        $this->enricher2->enrich(Argument::type(Description::class), $this->payload)
+            ->will(function ($args) {
+                $description = $args[0];
+                $description->set('barfoo', 'foobar');
+            });
+        $this->enricher2->supports($this->resource->reveal())->willReturn(true);
+
+        $description = $this->createFactory([
+            $this->enricher1->reveal(),
+            $this->enricher2->reveal(),
+        ])->getPayloadDescriptionFor($this->resource->reveal());
+
+        $this->assertInstanceOf(Description::class, $description);
+        $this->assertEquals('barfoo', $description->get('foobar'));
+        $this->assertEquals('foobar', $description->get('barfoo'));
+    }
+
+    /**
+     * It should ignore providers that do not support the payload type.
+     */
+    public function testIgnoreNonSupporters()
+    {
+        $this->enricher1->enrich(Argument::cetera())->shouldNotBeCalled();
+        $this->enricher1->supports($this->resource->reveal())->willReturn(false);
+
+        $this->enricher2->enrich(Argument::cetera())->shouldBeCalled();
+        $this->enricher2->supports($this->resource->reveal())->willReturn(true);
+
+        $this->createFactory([
+            $this->enricher1->reveal(),
+            $this->enricher2->reveal(),
+        ])->getPayloadDescriptionFor($this->resource->reveal());
+    }
+
+    /**
+     * It should work when no enrichers are given.
+     */
+    public function testNoEnrichers()
+    {
+        $description = $this->createFactory([])->getPayloadDescriptionFor($this->resource->reveal());
+        $this->assertInstanceOf(Description::class, $description);
+    }
+
+    private function createFactory(array $enrichers)
+    {
+        return new DescriptionFactory($enrichers);
+    }
+}

Tests/Unit/Description/DescriptionTest.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2015 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Component\Resource\Tests\Unit\Repository;
+
+use Symfony\Cmf\Component\Resource\Description\Description;
+use Symfony\Cmf\Component\Resource\Description\Descriptor;
+
+class DescriptionTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var Description
+     */
+    private $description;
+
+    public function setUp()
+    {
+        $this->description = new Description('some-type');
+    }
+
+    /**
+     * It should allow values to be set and retrieved.
+     */
+    public function testGetSet()
+    {
+        $this->description->set(Descriptor::TYPE_ALIAS, 'page');
+        $this->description->set(Descriptor::LINK_EDIT_HTML, '/path/to/edit');
+        $this->description->set('custom.key', 'Hello');
+
+        $this->assertEquals('page', $this->description->get(Descriptor::TYPE_ALIAS));
+    }
+
+    /**
+     * It should throw an exception when requesting an unsupported descriptor.
+     *
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage Descriptor "not there" not supported for payload type "some-type". Supported descriptors: "foo", "bar"
+     */
+    public function testGetUnsupported()
+    {
+        $this->description->set('foo', 'bar');
+        $this->description->set('bar', 'foo');
+        $this->description->get('not there');
+    }
+}