corb/template-manager

Template manager for laravel

CORB TEMPLATE MANAGER

A database template compiler for laravel 5, _(*1)

Installation

• Install as laravel project dependency, _(*2)

  composer require corb/template-manager, _(*3)

• Add service provider in providers array (config/app.php), _(*4)

  Corb\TemplateManager\TemplateManagerServiceProvider::class,, _(*5)

• Publish vendor files, _(*6)

  $ php artisan vendor:publish --tag=config, _(*7)

This will create a config file named template-manager.php, _(*8)

Configuration file

• models, _(*9)

  The model property is an array containing Model Namespaces to access table columns., _(*10)

  'models' => [ App\User::class ];, _(*11)

  or, _(*12)

  models => [ 'App\User' ];, _(*13)

  Why? If you want to implement a WYSIWYG edit maybe this option is useful., _(*14)

• use_routes, _(*15)

  If you want to use package routes to get available table fields set to true (default)., _(*16)

  'use_routes' => true,, _(*17)

• route Url of the route, default 'templates', _(*18)

  'route' => 'templates',, _(*19)

  Ex: localhost:8000/templates' //This url return all the configured tables with its columns, _(*20)

• template_table, _(*21)

  Name of the database table to be used, default 'templates'., _(*22)

  'template_table' => 'templates',, _(*23)

  WARNING: This configuration is used to create database migration. If you have an older migration it will be useless, so maybe you want to delete the migrate (Need to improve this)., _(*24)

Template table

• Create migration, _(*25)

  $ php artisan vendor:publish --tag=migrations, _(*26)

  This command create a new database migration using configuration file. Remember previous warning!., _(*27)

• Run migrate, _(*28)

  $ php artisan migrate, _(*29)

  And thats it, now store your templates., _(*30)

Usage

Compiling a template

Add the TemplateManager class to your code, _(*31)

use Corb\TemplateManager\TemplateManager;, _(*32)

Create a new TemplateManager object, _(*33)

$template = new TemplateManager;, _(*34)

Compile a new template, _(*35)

$compiled_template = $template->parse('test_template', $template_data), _(*36)

Example

Database template: test_template

Hi <b>{{$user->name}}</b>.<br/>
Thanks to use corb template manager, if you need help 
<a href="{{$help_link}}">Click here</a>.

Test code: routes.php

use Corb\TemplateManager\TemplateManager;

Route::get('/', function () {
    $template   = new TemplateManager;
    $user       = new stdClass;
    $user->name = 'Foo';
    $help_link  = 'https://github.com/gabomarin/l5-template-manager';
    $data = [
        'user'      => $user,
        'help_link' => $date
    ];
    echo $template->parse('test_template', $data);
});

Result

Hi Foo.
Thanks to use corb template manager, if you need help Click here.

TemplateManager Methods

getModels()

• Get models found in config file

• Return array, _(*37)

  [
      "App\User",
      "App\Product",
  ]

getFields()

• Get table columns from config models

• Return array, _(*38)

  [
      "users": [
          "id",
          "name",
          "email",
      ],
      "products": [
          "id",
          "name",
          "category",
          "sku"
      ]
  ]

parse($slug, $data)

• Parse a template

• Params:, _(*39)

  - $slug: template slug
  - $data: Array of data to be parsed in template

  -Return: A string of compiled template, _(*40)