tweedegolf/media-bundle

Media manager bundle for Symfony and tinyMCE

Wednesday, December 27, 2017
by tweedegolf
Repository
4 Watchers
7 Stars
820 Installations

PHP
0 Dependents
0 Suggesters
1 Forks
3 Open issues
10 Versions
1 % Grown

The README.md

TweedeGolf MediaBundle

The TweedeGolf MediaBundle provides a ready-to-use media manager for your Symfony project. Although it is especially designed to work with tinyMCE, the media bundle could be used for several other purposes., _(*1)

screenshot of the media manger modal , _(*2)

In essence, the TweedeGolf MediaBundle provides a File Entity and a controller that implements a JSON API for this entity, _(*3)

Dependencies

This repository only provides the Symfony bundle and can be installed via composer. The front-end scripts used to display the modal can be found on https://github.com/tweedegolf/media-browser and can be installed using bower., _(*4)

Composer dependencies:, _(*5)

Bower dependencies:, _(*6)

TweedeGolfMediaBrowser

Installation and configuration

A good starting point to setup a Symfony project with bower and gulp is the TweedeGolf Symfony Okoa Project., _(*7)

Using Composer add the bundle to your requirements, running composer require tweedegolf/media-bundle., _(*8)

For installation instructions of the media browser, see the repository., _(*9)

Basic configuration

Define mappings in your configuration file config/packages/tweede_golf_media.yaml (or app/config/config.yml):, _(*10)

You can configure the maximum number of items displayed per page., _(*11)

You must configure the name of your File entity., _(*12)

tweede_golf_media:
    max_per_page: 24  # this is optional (default is 18)
    file_entity: 'App:File'  # this is required

This is an example of File entity you can define:, _(*13)

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;
use TweedeGolf\MediaBundle\Model\AbstractFile;

/**
 * @ORM\Entity
 * @ORM\Table
 * @ORM\Entity(repositoryClass="TweedeGolf\MediaBundle\Entity\FileRepository")
 */
class File extends AbstractFile
{
    /**
     * @ORM\Column(type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    private $id;

    public function getId(): int
    {
        return $this->id;
    }
}

Also, the MediaBundle depends on some configurations in other bundles. There needs to be a VichUploader mapping defined with the name tgmedia_files. Furthermore, there has to be a LiipImagine filter with the name tgmedia_thumbnail., _(*14)

A example configuration of these bundles is available in the documentation., _(*15)

Add routes to your routing file

Ini config/routes.yaml (or app/config/routing.yml), add the routes for the media bundle api:, _(*16)

tweedegolf_media:
    resource: "@TweedeGolfMediaBundle/Controller/"
    type: annotation
    prefix: /api

Make sure the path to the bundle matches the path specified in the javascript source when including the media browser. Thus /api should match the firts part in the path speciefied when including the javascript source:, _(*17)

var media_callback = require('tweedegolf-media-browser').tinymce_callback('/api/modal');

Add the bundle to your AppKernel

If you use Flex, you should already have bundles in config/bundles.php:, _(*18)

return [
    // ...
    Vich\UploaderBundle\VichUploaderBundle::class => 'all',
    Liip\ImagineBundle\LiipImagineBundle::class => 'all',
    TweedeGolf\MediaBundle\TweedeGolfMediaBundle::class => 'all',
    // ...
];

If you still use old system, you need to manually add to app/AppKernel.php:, _(*19)

public function registerBundles()
{
    return [
        // ...
        new Vich\UploaderBundle\VichUploaderBundle(),
        new Liip\ImagineBundle\LiipImagineBundle(),
        new TweedeGolf\MediaBundle\TweedeGolfMediaBundle(),
        // ...
    ];
}

The Versions

27/12 2017

dev-master

9999999-dev

Media manager bundle for Symfony and tinyMCE

Sources Download

MIT

The Requires

The Development Requires

by Marlon Baeten

18/04 2017

v0.2.4

0.2.4.0

Media manager bundle for Symfony2 and tinyMCE

Sources Download

MIT

The Requires

The Development Requires

friendsofphp/php-cs-fixer ^2.2

Media manager bundle for Symfony and tinyMCE