README

Overview

Integrates Sonata Media Bundle and Liip Imagine Bundle without pain.

If you have tried to integrated LiipImagineBundle and Sonata Media Bundle as was described on this page you know what I is talking about. I've decided to free the Symfony world from such a headache.

The bundle provides a support for LiipImagineBundle through a specific Thumbnail service like as original Sonata Media. It also works good with Sonata Admin Bundle. So you no need any other actions for your admin part if you use Sonata Admin Bundle. You feel free to try this. Configure bundle takes about couple minutes.

1 Installation

$ composer require enemis/sonata-media-liip-imagine

2 Enable the Bundle

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...

            new Enemis\SonataMediaLiipImagineBundle\SonataMediaLiipImagineBundle(),
        );

        // ...
    }

    // ...
}

3 Sonata Media config

You need to configure your Sonata Media Bundle. Most important part is to configure context, cdn, providers.
You mustn't add formats to contexts that should use Liip formats. Tell to providers to use custom thumbnail service
'sonata.media.thumbnail.liip_imagine'. ** Please do not forget this bundle allow use Liip imagine only with image provider and youtube provider.
 If you require something else please let me know or suggest pull request **

#config.yml
sonata_media:
    # if you don't use default namespace configuration
    #class:
    #    media: MyVendor\MediaBundle\Entity\Media
    #    gallery: MyVendor\MediaBundle\Entity\Gallery
    #    gallery_has_media: MyVendor\MediaBundle\Entity\GalleryHasMedia
    db_driver: doctrine_orm # or doctrine_mongodb, doctrine_phpcr it is mandatory to choose one here
    default_context: photo # you need to set a context
    force_disable_category: true #true, if you really want to disable the relation with category
    category_manager:  null #null or "sonata.media.manager.category.default" if classification bundle exists
    admin_format: { width: 500 , quality: 90, format: 'jpg'}
    contexts:
        photo:
             download:
                 strategy: sonata.media.security.superadmin_strategy
                 mode: http
             providers:
                - sonata.media.provider.image
             formats: ~
        video:
             download:
                 strategy: sonata.media.security.superadmin_strategy
                 mode: http
             providers:
                - sonata.media.provider.youtube
             formats: ~
    cdn:
        server:
            path: /uploads/media #define path where sonata will be store uploaded files
    filesystem:
        local:
            directory:  "%kernel.root_dir%/../web/"
            create:     false
    providers:
        image:
            allowed_extensions: ['jpg', 'png', 'jpeg']
            allowed_mime_types: ['image/pjpeg', 'image/jpeg', 'image/png', 'image/x-png']
            thumbnail:  sonata.media.thumbnail.liip_imagine #if you want use Liip with this provider you have to use this thumbnail service
        youtube:
            thumbnail:  sonata.media.thumbnail.liip_imagine
            html5: true

More details you are able to find on official documentation.

4 VideoProvider and Youtube 3 Api

If you are using youtube provider from sonata media bundle, you might figure out that quality of thumbnails not always well. It happens because oembed API doesn't receive high res thumbnail, but default size. I've changed oembed to Youtube API 3, and now Youtube provider fetches high res thumbnail and also youtube statistics(views, likes, dislikes); Before using you need to generate Google Api Key and enable Youtube Api 3 at https://console.developers.google.com;

https://console.developers.google.com/projectcreate - create new project
press add services and apis and choose YouTube Data API v3 http://prntscr.com/m9sgzs
press enable
create credential to use this api http://prntscr.com/m9sipt
copy generated key and press done http://prntscr.com/m9sjdr
put generated key into your parameters.yml.dist

# This file is auto-generated during the composer install
parameters:
    google_youtube_api_key: AIza--sCE3t-r3Y5h0BbtRDPXVDJWQOM------

5 Configure you Liip Imagine and add filters sets

You need to add filter sets in format CONTEXT_FORMAT. You are able to use any filters or post-processors that Liip Imagine provides.

#config.yml
liip_imagine:
    filter_sets:
        video_wide:
            filters:
                downscale:
                     max: [970, 500]
                watermark:
                     # path to the watermark file (prepended with "%kernel.root_dir%")
                     image: '../web/watermark.png'
                     # size of the water mark relative to the input image
                     size: 0.3
                     position: bottomright
            post_processors:
                mozjpeg: { quality: 80 }

        photo_wide:
            filters:
                downscale:
                     max: [970, 500]
                watermark:
                     # path to the watermark file (prepended with "%kernel.root_dir%")
                     image: '../web/watermark.png' 
                     # size of the water mark relative to the input image
                     size: 0.3
                     position: bottomright

        photo_preview:
            filters:
                downscale:
                     max: [250, 250]

        video_preview:
            filters:
                downscale:
                     max: [100, 250]
            post_processors:
                mozjpeg: { quality: 80 }

More details about Liip Imagine

6 Override Sonata's Media provider.

In general, this bundle override sonata's providers(ImageProvider and YoutubeProvider). If you wanna override some provider's part, you have to extend own provider with Enemis\SonataMediaLiipImagineBundle\Provider\ImageProvider. or Enemis\SonataMediaLiipImagineBundle\Provider\YouTubeProvider for youtube provider and override the corresponding parameter. Sonata Media has two parameters for that. Just override it if you want.

sonata.media.provider.image.class: Application\Sonata\MediaBundle\Provider\ImageProvider
sonata.media.provider.youtube.class: Application\Sonata\MediaBundle\Provider\YouTubeProvider

You are able to put this parameters into parameters.yml, config.yml. I prefere add them in admin.yml from Application\Sonata\MediaBundle.

#admin.yml
parameters:
    sonata.media.provider.image.class: Application\Sonata\MediaBundle\Provider\ImageProvider
    sonata.media.provider.youtube.class: Application\Sonata\MediaBundle\Provider\YouTubeProvider

and don't forget extend your provider by provider from Enemis\SonataMediaLiipImagineBundle\Provider namespace.

<?php
#Application\Sonata\MediaBundle\Provider\YouTubeProvider

namespace Application\Sonata\MediaBundle\Provider;

use Enemis\SonataMediaLiipImagineBundle\Provider\YouTubeProvider as EnemisYoutubeProvider;

class YouTubeProvider extends EnemisYoutubeProvider
{
    /**
     * Get provider reference url.
     *
     * @param MediaInterface $media
     *
     * @return string
     */
    public function getReferenceUrl(MediaInterface $media)
    {
        return sprintf('https://www.youtube.com/watch?v=%s', $media->getProviderReference());
    }
}

7 troubleshooting guide

This bundle must go after Sonata Media bundle \ ApplicationSonataMediaBundle otherwise you will get exception: The service "enemis.sonata_media_liip_imagine.chain_resizer" has a dependency on a non-existent service "sonata.media.adapter.image.default".

If you have some question feel free to mail me on stadnikandreypublic@gmail.com. Also you are able to create issues and suggest pull request.

enemis / sonata-media-liip-imagine

Maintainers

Details