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,117 @@
+<?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 Puli\Repository\Api\Resource\PuliResource;
+
+/**
+ * Descriptive metadata for resources.
+ */
+class Description
+{
+    /**
+     * @var array
+     */
+    private $descriptors = [];
+
+    /**
+     * @var PuliResource
+     */
+    private $resource;
+
+    /**
+     * @param PuliResource $resource
+     */
+    public function __construct(PuliResource $resource)
+    {
+        $this->resource = $resource;
+    }
+
+    /**
+     * Return the descriptors value for the given descriptor.
+     *
+     * @param string $descriptor
+     *
+     * @return mixed
+     */
+    public function get($descriptor)
+    {
+        if (!isset($this->descriptors[$descriptor])) {
+            throw new \InvalidArgumentException(sprintf(
+                'Descriptor "%s" not supported for resource "%s" of class "%s". Supported descriptors: "%s"',
+                $descriptor,
+                $this->resource->getPath(),
+                get_class($this->resource),
+                implode('", "', array_keys($this->descriptors))
+            ));
+        }
+
+        return $this->descriptors[$descriptor];
+    }
+
+    /**
+     * Return true if the given descriptor has been set.
+     *
+     * @param string $descriptor
+     *
+     * @return bool
+     */
+    public function has($descriptor)
+    {
+        return isset($this->descriptors[$descriptor]);
+    }
+
+    /**
+     * Return all of the descriptors.
+     *
+     * @return array
+     */
+    public function all()
+    {
+        return $this->descriptors;
+    }
+
+    /**
+     * Set value for descriptors descriptor.
+     *
+     * Note that:
+     *
+     * - It is possible to overwrite existing descriptors.
+     *
+     * - Where possible the descriptor should be the value of one of the constants
+     *   defined in the Descriptor class.
+     *
+     * @param string $descriptor
+     * @param mixed  $value
+     */
+    public function set($descriptor, $value)
+    {
+        if (null !== $value && !is_scalar($value)) {
+            throw new \InvalidArgumentException(sprintf(
+                'Only scalar values are allowed as descriptor values, got "%s" when setting descriptor "%s"',
+                gettype($value), $descriptor
+            ));
+        }
+
+        $this->descriptors[$descriptor] = $value;
+    }
+
+    /**
+     * Return the resource for which this is the description.
+     *
+     * @return PuliResource
+     */
+    public function getResource()
+    {
+        return $this->resource;
+    }
+}

Description/DescriptionEnhancerInterface.php

@@ -0,0 +1,35 @@
+<?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 Puli\Repository\Api\Resource\PuliResource;
+
+interface DescriptionEnhancerInterface
+{
+    /**
+     * Enrich the payload description.
+     *
+     * @param Description $description
+     *
+     * @return Description
+     */
+    public function enhance(Description $description);
+
+    /**
+     * Return true if the provider supports the given type.
+     *
+     * @param CmfResource $resource
+     *
+     * @return bool
+     */
+    public function supports(PuliResource $resource);
+}

Description/DescriptionFactory.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;
+
+use Puli\Repository\Api\Resource\PuliResource;
+
+class DescriptionFactory
+{
+    /**
+     * @var DescriptionEnhancerInterface[]
+     */
+    private $enhancers = [];
+
+    /**
+     * @param array $enhancers
+     */
+    public function __construct(array $enhancers)
+    {
+        $this->enhancers = $enhancers;
+    }
+
+    /**
+     * Return a description of the given (CMF) Resource.
+     *
+     * @param PuliResource $resource
+     *
+     * @return Description
+     */
+    public function getPayloadDescriptionFor(PuliResource $resource)
+    {
+        $description = new Description($resource);
+
+        foreach ($this->enhancers as $enhancer) {
+            if (false === $enhancer->supports($resource)) {
+                continue;
+            }
+
+            $enhancer->enhance($description);
+        }
+
+        return $description;
+    }
+}

Description/Descriptor.php

@@ -0,0 +1,54 @@
+<?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 recommended descriptors for use by enhancers 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';
+
+    /**
+     * Descriptors for HTML links.
+     */
+    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';
+    const LINK_LIST_HTML = 'link.list.html';
+
+    /**
+     * Descriptors for REST links.
+     */
+    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';
+    const LINK_LIST_REST = 'link.show.rest';
+}

Description/Enhancer/Sonata/AdminEnhancer.php

@@ -0,0 +1,120 @@
+<?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\Enhancer\Sonata;
+
+use Sonata\AdminBundle\Admin\Pool;
+use Doctrine\Common\Util\ClassUtils;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+use Symfony\Cmf\Component\Resource\Description\DescriptionEnhancerInterface;
+use Symfony\Cmf\Component\Resource\Description\Description;
+use Puli\Repository\Api\Resource\PuliResource;
+use Symfony\Cmf\Component\Resource\Description\Descriptor;
+
+/**
+ * Add links and meta-info from Sonata Admin.
+ *
+ * @author Daniel Leech <[email protected]>
+ */
+class AdminEnhancer implements DescriptionEnhancerInterface
+{
+    /**
+     * @var Pool
+     */
+    private $pool;
+
+    /**
+     * @var UrlGeneratorInterface
+     */
+    private $urlGenerator;
+
+    /**
+     * @param Pool                  $pool
+     * @param UrlGeneratorInterface $urlGenerator
+     */
+    public function __construct(Pool $pool, UrlGeneratorInterface $urlGenerator)
+    {
+        $this->pool = $pool;
+        $this->urlGenerator = $urlGenerator;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function enhance(Description $description)
+    {
+        $object = $description->getResource()->getPayload();
+
+        // sonata has dependency on ClassUtils so this is fine.
+        $class = ClassUtils::getClass($object);
+        $admin = $this->pool->getAdminByClass($class);
+
+        $links = array();
+
+        $routeCollection = $admin->getRoutes();
+
+        foreach ($routeCollection->getElements() as $code => $route) {
+            $routeName = $route->getDefault('_sonata_name');
+            $url = $this->urlGenerator->generate($routeName, array(
+                $admin->getIdParameter() => $admin->getUrlsafeIdentifier($object),
+            ), true);
+
+            $routeRole = substr($code, strlen($admin->getCode()) + 1);
+
+            $links[$routeRole] = $url;
+        }
+
+        if (isset($links['list'])) {
+            $description->set('list', $links['list']);
+            unset($links['list']);
+        }
+
+        if (isset($links['create'])) {
+            $description->set(Descriptor::LINK_CREATE_HTML, $links['create']);
+            unset($links['create']);
+        }
+
+        if (isset($links['edit'])) {
+            $description->set(Descriptor::LINK_EDIT_HTML, $links['edit']);
+            unset($links['edit']);
+        }
+
+        if (isset($links['delete'])) {
+            $description->set(Descriptor::LINK_REMOVE_HTML, $links['delete']);
+            unset($links['delete']);
+        }
+
+        if (isset($links['show'])) {
+            $description->set(Descriptor::LINK_SHOW_HTML, $links['show']);
+            unset($links['show']);
+        }
+
+        $description->set(Descriptor::PAYLOAD_TITLE, $admin->toString($object));
+        $description->set(Descriptor::TYPE_ALIAS, $admin->getLabel());
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supports(PuliResource $resource)
+    {
+        if (false === $resource instanceof CmfResource) {
+            return false;
+        }
+
+        $payload = $resource->getPayload();
+
+        // sonata has dependency on ClassUtils so this is fine.
+        $class = ClassUtils::getClass($payload);
+
+        return $this->pool->hasAdminByClass($class);
+    }
+}