forci/banner-bundle

A simple banner manager Symfony3/4

v0.1.1 2017-12-14 19:26 UTC

Requires

• php: >=7.1.3
• symfony/symfony: ~3.4|~4.0
• wucdbm/quick-ui-bundle: ~0.3

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.8
• wucdbm/php-cs-fixers: ~0.1

GPL-3.0

• Martin Kirilov

• wucdbm
• forci
• banner bundle

README

Usage

Add this bundle to your AppKernel.php new \Forci\Bundle\BannerBundle\ForciBannerBundle()

Execute app/console doctrine:schema:update --dump-sql and after verifying what is being executed, execute again with --force. Alternatively, use doctrine migrations via the DoctrineMigrations bundle.

Once this has been done, you can start using the bundle. Simply register it in your routing.yml in a protected area such as admin, like so:

forci_banner:
    resource: "@ForciBannerBundle/Resources/config/routing.yml"
    prefix: /banners

You can create a link to the builder using {{ path('forci_banner_dashboard') }}, or embed it into your admin UI via an iframe like so <iframe src="{{ path('forci_banner_dashboard') }}" style="border: 0; width: 100%; height: 100%;"></iframe>

The User Interface is pretty self-explanatory. You create banners and positions. Banners contain the JavaScript or HTML code. This can also be used for tracking or anything external you would like to add to your website via a UI in your admin section without thinking too much about its implementation. Positions are placed in your code on your pages, like this {{ 'YourPositionName'|banner }} (There is also a twig function) You can also print a link to the same page you're at, but with positions in debug mode, but only if your user has the ROLE_ADMIN role using {{ showBannerPositionsUrl() }} If a position is lacking a banner, is inactive, the banner is inactive, or any other error, if you have ROLE_ADMIN, you will get an error message

Caching

If you need cache: Alias your own Psr\Cache\CacheItemPoolInterface to forci_banner.cache, for example:

<service id="forci_banner.cache" alias="app.cache" /> where the app.cache service is an instance of Psr\Cache\CacheItemPoolInterface

TODO

• Tests!