library laravel-theme-manager

roland/laravel-theme-manager

Laravel 5 Themes: Asset & Views folder per theme. Theme inheritance. Blade integration and more...

This package is a theme management package for Laravel with a set of tools to help you easily and quickly build a theme management system for your laravel based project. The goal of this package is to remain as flexible as possible and provide a way to use it internally., _(*1)

Supports

This package supports Blade, PHP and Twig template engines., _(*2)

Features

This package provides tools for the following:, _(*3)

• Change themes on runtime.
• Get theme meta infomations.
• Support fallback templates.
• Preview a theme using URL query parameter.
• Extend the theme functionalities.

Installation

To get started with this package, add the following lines to your composer.json file and run composer update., _(*4)

"require": {
    "roland/laravel-theme-manager": "~1.0"
}

Or, Run composer require from your terminal to install the package via the Composer package manager:, _(*5)

composer require roland/laravel-theme-manager

Service Provider & Facade

If you disabled the laravel's automatic package discovery feature these will help you., _(*6)

// Service Provider
Roland\Theme\ThemeServiceProvider::class,

// Facade
'Theme' => Roland\Theme\Facades\Theme::class,

Publish Configuration

Much of the package comes preconfigured, so that you can start building your API right away after you installed. You can either use .env file or config/themes.php to configure most of the package., _(*7)

You also can publish the configuration file with the following Artisan command:, _(*8)

php artisan vendor:publish --provider="Roland\Theme\ThemeServiceProvider"

Enable or disable the package

You can set the value to true or false to enable or disable the package., _(*9)

enable => true,

Default theme provider

Here you may specify which of the theme provider connections below you wish to use as your default provider., _(*10)

Available drivers: "file", _(*11)

'driver' => 'file',

Default theme

Here you may specify the default theme., _(*12)

'theme' => 'default',

Themes path

Here you may specify a path for themes., _(*13)

'path' => base_path('resources/themes'),

Basic Usage

Create a theme

To create a theme, first, add a themes folder to the resources folder of your app., _(*14)

Inside the themes folder, any folder you create with a theme.json the file represents a theme., _(*15)

The folder structure will look like this:, _(*16)

resources
└── themes
    ├── [Theme folder]
    |   └── theme.json
    |   └── welcome.blade.php
    |
    └── [Another theme folder]
        └── theme.json
        └── welcome.blade.php

Theme information file (theme.json)

This package only recognize a folder as a theme when a file called theme.json exists., _(*17)

This is the basic structure of the theme information file. You can add any number of key, value pairs to the file and retrieve later., _(*18)

{
    "theme_title": "Default theme",
    "theme_description": "Default theme for the theme package",
    "theme_uri": "https://domain.com",
    "theme_version": "1.0.0",
    "theme_license": "The MIT License (MIT)",
    "theme_tags": "default, simple",
    "theme_type": "web",
    "author_name": "Jon Deep",
    "author_email": "JonDeep@domain.com",
    "author_uri": "https://domain.com"
}

Basic methods

To simply display a view (welcome) using the current theme. Otherwise fallback (index)., _(*19)

return Theme::view(['welcome', 'index']);

To set the current theme on runtime., _(*20)

return Theme::use('mytheme')->view(['welcome']);

To set the current theme and update the default config theme., _(*21)

Theme::set('mytheme');

Add theme parameter to preview a theme on runtime., _(*22)

https://localhost/?theme=mytheme

You also can change the theme provider at runtime., _(*23)

return Theme::driver('file')->view(['welcome']);

To check whether a theme exists or not., _(*24)

Theme::exists('mytheme');

To check all themes., _(*25)

Theme::all();

Ps: it will return a json with all the installed themes, _(*26)

Return theme's information as json., _(*27)

// Return default theme's info
return Theme::info();

// Return provided theme's info
return Theme::info('mytheme');

Pass data to views., _(*28)

// with() method
return Theme::with(['name' => 'Victoria'])->view(['welcome']);

// Alternative way
return Theme::view(['welcome'], ['name' => 'Victoria']);

Advanced

We allow you extend or add more theme providers using extend function on runtime without a hassle., _(*29)

    Theme::extend('riak', function($app)
    {
        return 'Riak theme driver';
    });

    // Chnage the theme driver from route
    return Theme::driver('riak');

Configure Middleware, _(*30)

• Publish the package: php artisan vendor:publish
• On Http/kernel.php add to protected 'theme' => \App\Http\Middleware\CheckTheme::class,

• Use middleware on the routes, _(*31)

  Route example: Route::get('/', ['uses' => 'TestController@home'])->middleware('theme:ThemeName');, _(*32)

  ps. using the theme will allow you to use the deafult Laravel view() with the currect theme :), _(*33)

License

This package is licensed under the The MIT License (MIT)., _(*34)