diff --git a/bundles/block/cache.rst b/bundles/block/cache.rst index 60592544..dc8c06b4 100644 --- a/bundles/block/cache.rst +++ b/bundles/block/cache.rst @@ -1,11 +1,11 @@ Cache ===== -The Symfony2 CMF BlockBundle integrates with the `SonataCacheBundle`_ to +The CmfBlockBundle integrates with the `SonataCacheBundle`_ to provide several caching solutions. Have a look at the available adapters in the `SonataCacheBundle`_ to see all options. -The Symfony2 CMF BlockBundle additionally provides its own adapters for: +The CmfBlockBundle additionally provides its own adapters for: * `ESI`_ (service: ``cmf.block.cache.varnish``) * `SSI`_ (service: ``cmf.block.cache.ssi``) @@ -119,7 +119,7 @@ CmfBlockBundle and the SonataBlockBundle: ), ), 'blocks_by_class' => array( - 'Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\RssBlock' => array( + Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\RssBlock::class => array( 'cache' => 'symfony_cmf.block.cache.js_async', ), ), @@ -133,8 +133,7 @@ When a block having a cache configured is rendered, the following process is triggered: * The document is loaded based on the name; -* If caching is configured, the cache is checked and content is returned if - found. +* The cache is checked and content is returned if found. * Cache keys are computed using: diff --git a/bundles/block/configuration.rst b/bundles/block/configuration.rst index 691c58b5..a76a7141 100644 --- a/bundles/block/configuration.rst +++ b/bundles/block/configuration.rst @@ -34,21 +34,6 @@ is the following configuration: enabled: false block_basepath: /cms/content manager_name: ~ - string_document_class: Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\StringBlock - simple_document_class: Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\SimpleBlock - container_document_class: Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ContainerBlock - reference_document_class: Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ReferenceBlock - action_document_class: Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ActionBlock - slideshow_document_class: Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\SlideshowBlock - imagine_document_class: Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ImagineBlock - use_sonata_admin: auto - string_admin_class: Symfony\Cmf\Bundle\BlockBundle\Admin\StringBlockAdmin - simple_admin_class: Symfony\Cmf\Bundle\BlockBundle\Admin\SimpleBlockAdmin - container_admin_class: Symfony\Cmf\Bundle\BlockBundle\Admin\ContainerBlockAdmin - reference_admin_class: Symfony\Cmf\Bundle\BlockBundle\Admin\ReferenceBlockAdmin - action_admin_class: Symfony\Cmf\Bundle\BlockBundle\Admin\ActionBlockAdmin - slideshow_admin_class: Symfony\Cmf\Bundle\BlockBundle\Admin\Imagine\SlideshowBlockAdmin - imagine_admin_class: Symfony\Cmf\Bundle\BlockBundle\Admin\Imagine\ImagineBlockAdmin .. code-block:: xml @@ -59,23 +44,8 @@ is the following configuration: @@ -90,21 +60,6 @@ is the following configuration: 'enabled' => false, 'block-basepath' => '/cms/content', 'manager_name' => null, - 'string_document_class' => 'Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\StringBlock', - 'simple_document_class' => 'Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\SimpleBlock', - 'container_document_class' => 'Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ContainerBlock', - 'reference_document_class' => 'Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ReferenceBlock', - 'action_document_class' => 'Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ActionBlock', - 'slideshow_document_class' => 'Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\SlideshowBlock', - 'imagine_document_class' => 'Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ImagineBlock', - 'use_sonata_admin' => 'auto', - 'string_admin_class' => 'Symfony\Cmf\Bundle\BlockBundle\Admin\StringBlockAdmin', - 'simple_admin_class' => 'Symfony\Cmf\Bundle\BlockBundle\Admin\SimpleBlockAdmin', - 'container_admin_class' => 'Symfony\Cmf\Bundle\BlockBundle\Admin\ContainerBlockAdmin', - 'reference_admin_class' => 'Symfony\Cmf\Bundle\BlockBundle\Admin\ReferenceBlockAdmin', - 'action_admin_class' => 'Symfony\Cmf\Bundle\BlockBundle\Admin\ActionBlockAdmin', - 'slideshow_admin_class' => 'Symfony\Cmf\Bundle\BlockBundle\Admin\Imagine\SlideshowBlockAdmin', - 'imagine_admin_class' => 'Symfony\Cmf\Bundle\BlockBundle\Admin\Imagine\ImagineBlockAdmin', ), ), )); @@ -130,123 +85,6 @@ the value of ``%cmf_core.persistence.phpcr.basepath%/content``. .. include:: ../_partials/persistence_phpcr_manager_name.rst.inc -``string_document_class`` -""""""""""""""""""""""""" - -**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\StringBlock`` - -The string block document class. - -``simple_document_class`` -""""""""""""""""""""""""" - -**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\SimpleBlock`` - -The simple block document class. - -``container_document_class`` -"""""""""""""""""""""""""""" - -**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ContainerBlock`` - -The container block document class. - -``reference_document_class`` -"""""""""""""""""""""""""""" - -**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ReferenceBlock`` - -The reference block document class. - -``action_document_class`` -""""""""""""""""""""""""" - -**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ActionBlock`` - -The action block document class. - -If phpcr is enabled ``use_sonata_admin`` is enabled, the class value is set in -``Resources/config/admin.xml``. - -``slideshow_document_class`` -"""""""""""""""""""""""""""" - -**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\SlideshowBlock`` - -The slideshow block document class. - -``imagine_document_class`` -"""""""""""""""""""""""""" - -**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ImagineBlock`` - -The imagine block document class. This document will only work properly if -you set up the LiipImagineBundle. - -``use_sonata_admin`` -"""""""""""""""""""" - -**type**: ``enum`` **valid values**: ``true|false|auto`` **default**: ``auto`` - -If ``true``, the admin classes are activated. If set to ``auto``, they are -activated only if the SonataPhpcrAdminBundle is present. - -If the :doc:`CoreBundle <../core/introduction>` is registered, this will default to the value -of ``cmf_core.persistence.phpcr.use_sonata_admin``. - -``string_admin_class`` -"""""""""""""""""""""" - -**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\StringBlockAdmin`` - -The sonata admin class of the string block. - -``simple_admin_class`` -"""""""""""""""""""""" - -**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\SimpleBlockAdmin`` - -The sonata admin class of the simple block. - -``container_admin_class`` -""""""""""""""""""""""""" - -**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\ContainerBlockAdmin`` - -The sonata admin class of the container block. - -``reference_admin_class`` -""""""""""""""""""""""""" - -**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\ReferenceBlockAdmin`` - -The sonata admin class of the reference block. - -``action_admin_class`` -"""""""""""""""""""""" - -**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\ActionBlockAdmin`` - -The sonata admin class of the action block. - -``slideshow_admin_class`` -""""""""""""""""""""""""" - -**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\Imagine\SlideshowBlockAdmin`` - -The sonata admin class of the slideshow block. - -This admin will only be loaded if ``use_imagine`` is enabled. - -``imagine_admin_class`` -""""""""""""""""""""""" - -**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\Imagine\ImagineBlockAdmin`` - -The sonata admin class of the imagine block. - -This admin will only be loaded if ``use_imagine`` is enabled. - ``twig`` ~~~~~~~~ @@ -275,14 +113,6 @@ The part before the actual path to the block. The part after the actual path to the block. -``use_imagine`` -~~~~~~~~~~~~~~~ - -**type**: ``enum`` **valid values**: ``true|false|auto`` **default**: ``auto`` - -If ``true``, the imagine related block classes and admin classes are activated. -If set to ``auto``, they are activated only if the LiipImagineBundle is present. - ``caches`` ~~~~~~~~~~ diff --git a/bundles/block/create_your_own_blocks.rst b/bundles/block/create_your_own_blocks.rst index 2c55336f..ec88989e 100644 --- a/bundles/block/create_your_own_blocks.rst +++ b/bundles/block/create_your_own_blocks.rst @@ -21,13 +21,13 @@ duplication, so instead you decide to create your own block, the ``RssBlock``. the CmfBlockBundle, but this one is more powerful as it allows to define a specific feed URL per block instance. -Create a block document +Create a Block Document ----------------------- The first thing you need is a document that contains the options and indicates the location where the RSS feed should be shown. The easiest way is to extend ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\AbstractBlock``, but you are -free to do create your own document. At least, you have to implement +free to do create your own document as long as it implements ``Sonata\BlockBundle\Model\BlockInterface``. In your document, you need to define the ``getType`` method which returns the type name of your block, for instance ``rss_block``:: @@ -292,9 +292,8 @@ on the current page: This mechanism is not recommended. For optimal load times, it is better to have a central assets definition for your project and aggregate them - into a single Stylesheet and a single JavaScript file, e.g. with Assetic_, - rather than having individual ```` and ``