endroid/tile

Endroid Tile

Fund package maintenance!
endroid

2.3.0 2024-10-25 22:08 UTC

README

By endroid

Latest Stable Version Build Status Total Downloads Monthly Downloads License

This library helps you generate images containing a typically Delft blue tile with a saying.

Installation

Use Composer to install the library.

$ composer require endroid/tile

Usage

use Endroid\Tile\Tile;

$tile = new Tile();
$this->setBackground(Tile::BACKGROUND_C);
$tile->setText("Life is too short to be generating tiles");
$tile->setSize(300);
$tile->render();

Tile

Symfony integration

Register the Symfony bundle in the kernel.

// app/AppKernel.php

public function registerBundles()
{
    $bundles = [
        // ...
        new Endroid\Tile\Bundle\TileBundle\EndroidTileBundle(),
    ];
}

Add the following section to your routing to be able to reach the tile controller.

EndroidTileBundle:
    resource:   "@EndroidTileBundle/Controller/"
    type:       annotation
    prefix:     /tile

Now tiles can be generated by appending the tile text to the url as mounted, followed by the file extension, like /tile/Life_is_too_short_to_be_generating_tiles.png.

Twig extension

The bundle also provides a Twig extension for quickly generating tile urls.

<img src="{{ tile_url(message) }}" />

Versioning

Version numbers follow the MAJOR.MINOR.PATCH scheme. Backwards compatibility breaking changes will be kept to a minimum but be aware that these can occur. Lock your dependencies for production and test your code when upgrading.

License

This bundle is under the MIT license. For the full copyright and license information please view the LICENSE file that was distributed with this source code.