1. Installation

1.1. Prerequisites

There are some Sonata dependencies that need to be installed and configured beforehand.

Optional dependencies:

And the persistence bundle (choose one):

Follow also their configuration step; you will find everything you need in their own installation chapter.

Note

If a dependency is already installed somewhere in your project or in another dependency, you won’t need to install it again.

1.2. Installation

Add SonataMediaBundle via composer:

composer require sonata-project/media-bundle

Next, be sure to enable the bundles in your config/bundles.php file if they are not already enabled:

// config/bundles.php

return [
    // ...
    Sonata\MediaBundle\SonataMediaBundle::class => ['all' => true],
];

2. Configuration

2.1. SonataMediaBundle Configuration

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# config/packages/sonata_media.yaml

sonata_media:
    class:
        media: App\Entity\SonataMediaMedia
        gallery: App\Entity\SonataMediaGallery
        gallery_item: App\Entity\SonataMediaGalleryItem
    db_driver: doctrine_orm # or doctrine_mongodb, it is mandatory to choose one here
    default_context: default # you need to set a context
    contexts:
        default: # the default context is mandatory
            providers:
                - sonata.media.provider.dailymotion
                - sonata.media.provider.youtube
                - sonata.media.provider.image
                - sonata.media.provider.file
                - sonata.media.provider.vimeo
            formats:
                small: { width: 100, quality: 70 }
                big: { width: 500, quality: 70 }
    cdn:
        server:
            path: /uploads/media
    filesystem:
        local:
            directory: '%kernel.project_dir%/public/uploads/media'
            create: false

Note

You can define formats per provider type. You might want to set a transversal admin format to be used by the mediaadmin class.

Also, you can determine the resizer to use; the default value is sonata.media.resizer.simple but you can change it to sonata.media.resizer.square or sonata.media.resizer.crop

1
2
3
4
5
6
# config/packages/sonata_media.yaml

sonata_media:
    providers:
        image:
            resizer: sonata.media.resizer.square

Note

The square resizer works like the simple resizer when the image format has only the width. But if you specify the height the resizer crop the image in the lower size.

The crop resizer crops the image to the exact width and height. This is done by resizing the image first and cropping the unwanted parts at the end.

2.2. Doctrine ORM Configuration

Add the bundle in the config mapping definition (or enable auto_mapping):

# config/packages/doctrine.yaml

doctrine:
    orm:
        entity_managers:
            default:
                mappings:
                    SonataMediaBundle: ~

And then create the corresponding entities, src/Entity/SonataMediaMedia:

// src/Entity/SonataMediaMedia.php

use Doctrine\ORM\Mapping as ORM;
use Sonata\MediaBundle\Entity\BaseMedia;

/**
 * @ORM\Entity
 * @ORM\Table(name="media__media")
 */
class SonataMediaMedia extends BaseMedia
{
    /**
     * @ORM\Id
     * @ORM\GeneratedValue
     * @ORM\Column(type="integer")
     */
    protected $id;
}

src/Entity/SonataMediaGallery:

// src/Entity/SonataMediaGallery.php

use Doctrine\ORM\Mapping as ORM;
use Sonata\MediaBundle\Entity\BaseGallery;

/**
 * @ORM\Entity
 * @ORM\Table(name="media__gallery")
 */
class SonataMediaGallery extends BaseGallery
{
    /**
     * @ORM\Id
     * @ORM\GeneratedValue
     * @ORM\Column(type="integer")
     */
    protected $id;
}

and src/Entity/SonataMediaGalleryItem:

// src/Entity/SonataMediaGalleryItem.php

use Doctrine\ORM\Mapping as ORM;
use Sonata\MediaBundle\Entity\BaseGalleryItem;

/**
 * @ORM\Entity
 * @ORM\Table(name="media__gallery_item")
 */
class SonataMediaGalleryItem extends BaseGalleryItem
{
    /**
     * @ORM\Id
     * @ORM\GeneratedValue
     * @ORM\Column(type="integer")
     */
    protected $id;
}

The only thing left is to update your schema:

bin/console doctrine:schema:update --force

2.3. Doctrine MongoDB Configuration

Add the bundle in the config mapping definition (or enable auto_mapping):

# config/packages/doctrine_mongodb.yaml

doctrine_mongodb:
    odm:
        mappings:
            SonataMediaBundle: ~

Then you have to create the corresponding documents, src/Document/SonataMediaMedia:

// src/Document/SonataMediaMedia.php

use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
use Sonata\MediaBundle\Document\BaseMedia;

/**
 * @MongoDB\Document
 */
class SonataMediaMedia extends BaseMedia
{
    /**
     * @MongoDB\Id
     */
    protected $id;
}

src/Document/SonataMediaGallery:

// src/Document/SonataMediaGallery.php

use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
use Sonata\MediaBundle\Document\BaseGallery;

/**
 * @MongoDB\Document
 */
class SonataMediaGallery extends BaseGallery
{
    /**
     * @MongoDB\Id
     */
    protected $id;
}

and src/Document/SonataMediaGalleryItem:

// src/Document/SonataMediaGalleryItem.php

use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
use Sonata\MediaBundle\Document\BaseGalleryItem;

/**
 * @MongoDB\Document
 */
class SonataMediaGalleryItem extends BaseGalleryItem
{
    /**
     * @MongoDB\Id
     */
    protected $id;
}

And then configure SonataMediaBundle to use the newly generated classes:

# config/packages/sonata_media.yaml

sonata_media:
    db_driver: doctrine_mongodb
    class:
        media: App\Document\SonataMediaMedia
        gallery: App\Document\SonataMediaGallery
        gallery_item: App\Document\SonataMediaGalleryItem

2.4. Add SonataMediaBundle routes

1
2
3
4
5
# config/routes.yaml

media:
    resource: '@SonataMediaBundle/Resources/config/routing/media.xml'
    prefix: /media

2.5. Create uploads folder

If they are not already created, you need to add specific folder to allow uploads from users, make sure your http user can write to this directory:

1
mkdir -p public/uploads/media

2.6. Next Steps

At this point, your Symfony installation should be fully functional, without errors showing up from SonataMediaBundle. If, at this point or during the installation, you come across any errors, don’t panic:

  • Read the error message carefully. Try to find out exactly which bundle is causing the error. Is it SonataMediaBundle or one of the dependencies?
  • Make sure you followed all the instructions correctly, for both SonataMediaBundle and its dependencies.
  • Still no luck? Try checking the project’s open issues on GitHub.