Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xinix-technology/bono-blade

Laravel Blade Template Engine for Bono PHP Framework
https://github.com/xinix-technology/bono-blade

Last synced: about 1 month ago
JSON representation

Laravel Blade Template Engine for Bono PHP Framework

Awesome Lists containing this project

README 

        
# BonoBlade

Laravel Blade Template Engine for Bono PHP Framework



> **Note:** BonoBlade also use Blade templating for `partial` view



## Installation

Add this line to your `composer.json` file



```

"require": {

    "xinix-technology/bono-blade": "~1.0.0"

},

```



## Configuration

Add these lines to your configuration file



```php

'bono.providers' => array(

    '\\Xinix\\Blade\\Provider\\BladeProvider'

),



// Bono Themeing

'bono.theme' => array(

    'class' => '\\Xinix\\Theme\\BladeTheme', // You can use another theme that extends from bono

),



// Bono Partial (segment of template)

'bono.partial.view' => '\\Xinix\\Blade\\BonoBlade',

```



If you want to change layout file name, templates path, or cache path, you can add options in your provider like this



```php

'bono.providers' => array(

    '\\Xinix\\Blade\\Provider\\BladeProvider' => array(

        'templates.path' => array('pathToTemplatesPath'), // Default is array('../templates')

        'cache.path' => 'pathToCachePath',                // Default is '../cache'

        'layout' => 'customLayoutName',                   // Default is 'layout'

    ),

),

```



> **Note:** You may use any other theme based on `BladeTheme`, such as [blade foundation](https://github.com/xinix-technology/blade-foundation).

Or you can create your own theme.



## Basic usage

```php

use Bono\App;



$app = App::getInstance();



$app->get('/', function () use ($app) {

    $app->render('yourTemplateName', array('var' => 'value'));

});

```



## Layout example



```html



    

    @yield('title', 'Devel')



    


        @yield('content')

    



```



## Template example



```html



@section('title')

New Title

@endsection



@section('content')

Hello, {{ $name }}!


@endsection

```



## Rendering template



Simply, you can render your template by call `render` function in `\Bono\App` instance.

```php

use Bono\App;



$app = App::getInstance();



$app->get('/', function () use ($app) {

    $app->view->setLayout('myLayout');

    $app->render('myTemplate', array('name' => 'Xinix Technology'));

});

```



> **Note:** Be sure you're not adding `.blade.php` or your template will not found



## Result



```html



    

    New Title



    


        
Hello, Xinix Technology!


    



```



## Rendering a page without layout



```php

use Bono\App;



$app = App::getInstance();



$app->get('/', function () use ($app) {

    // This method is same with $app->theme->partial($templateName, $data)

    $app->view->display('myTemplateWithoutLayout', array('name' => 'Xinix Technology'));

});

```



## Working with sections



```html



    

        @section('sidebar')

            This is the master sidebar.

        @show



        


            @yield('content')

        


    



```



```html



@extends('myCustomLayout')



@section('sidebar')

    @parent



    
This is appended to the master sidebar.


@stop



@section('content')

    
This is my body content. Appended to the container.


@stop

```



Note that views which `extend` a Blade layout simply override sections from the layout. Content of the layout can be included in a child view using the `@parent` directive in a section, allowing you to append to the contents of a layout section such as a sidebar or footer.



Sometimes, such as when you are not sure if a section has been defined, you may wish to pass a default value to the `@yield` directive. You may pass the default value as the second argument:



```html

@yield('content', '
Default
')

```



## Including sub-views



```html

@include('view.name')

```



You may also pass an array of data to the included view:



```html

@include('view.name', array('some'=>'data'))

```



## Overwriting sections



By default, sections are appended to any previous content that exists in the section. To overwrite a section entirely, you may use the `overwrite` statement:



```html

@section('test')

   one

@stop

@section('test')

   two

@stop

@yield('test')

```

The outpur is:



```html

one

```



But if you change the second `@stop` to an `@overwrite`.



```html

@section('test')

   one

@stop

@section('test')

   two

@overwrite

@yield('test')

```



Then the following is output.



```html

two

```



- `@overwrite` - End a Section and Overwrite it.

- `@stop` - Stopping Injecting Content Into a Section.

- `@show` - Yielding the Current Section in a Blade Template.

- `@append` - Stopping Injecting Content into a Section and Appending It.



## Extends template to be reuseable



```html



@section('header')

My sexy header

@endsection





    @section('body')

        {{-- some other controll structure to make your page happens --}}

    @endsection



    @section('action')

        


            Edit

            Update

        


    @endsection




@section('footer')

My shiny footer

@endsection

```



```html



@extends('listTemplate')



@section('body')

    {{-- some other controll structure to make your page happens --}}

    {{-- some kind that make this page unique --}}



    
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Rerum eligendi, totam velit earum assumenda optio accusantium magni est maiores ad inventore expedita nisi minus autem, porro adipisci cupiditate in iure!



    


        Some bluish content

    


@overwrite

```



Based on this case, your `body` section will be overriden by `lorem ipsum` and `bluish content`.



## Other blade control structures



### Echoing data



```html

Hello, {{{ $name }}}.



The current UNIX timestamp is {{{ time() }}}.

```



### Echoing data after checking for existence



Sometimes you may wish to echo a variable, but you aren't sure if the variable has been set. Basically, you want to do this:



```html

{{{ isset($name) ? $name : 'Default' }}}

```



However, instead of writing a ternary statement, Blade allows you to use the following convenient short-cut:



```html

{{{ $name or 'Default' }}}

```



### Displaying raw text with curly braces



If you need to display a string that is wrapped in curly braces, you may escape the Blade behavior by prefixing your text with an `@` symbol:



```html

@{{ This will not be processed by Blade }}

```



Of course, all user supplied data should be escaped or purified. To escape the output, you may use the triple curly brace syntax:



```html

Hello, {{{ $name }}}.

```



If you don't want the data to be escaped, you may use double curly-braces:



```html

Hello, {{ $name }}.

```



> **Note:** Be very careful when echoing content that is supplied by users of your application. Always use the triple curly brace syntax to escape any HTML entities in the content.



### If statements



```php

@if (count($records) === 1)

    I have one record!

@elseif (count($records) > 1)

    I have multiple records!

@else

    I don't have any records!

@endif



@unless (App::getInstance()->auth->check())

    You are not signed in.

@endunless

```



> **Note:** Method `@unless` is used when you want to write `@if(! functionReturnBool())`



### Loops



```php

@for ($i = 0; $i < 10; $i++)

    The current value is {{ $i }}

@endfor



@foreach ($users as $user)

    
This is user {{ $user->id }}


@endforeach



@while (true)

    
I'm looping forever.


@endwhile

```



### Comments



```php

{{-- This comment will not be in the rendered HTML --}}

```



##Extending blade



```php

use Bono\App;



$app = App::getInstance();



$app->view->extend(function($view, $compiler) {

    $pattern = $compiler->createMatcher('datetime');



    return preg_replace($pattern, '$1format("m/d/Y H:i:s"); ?>', $view);

});

```



Now you can use `@dateTime($dateValue)` to get your datetime value.



The `createPlainMatcher` method is used for directives with no arguments like `@endif` and `@stop`, while `createMatcher` is used for directives with arguments.



```php

use Bono\App;



$app = App::getInstance();



$app->view->extend(function($view, $compiler) {

    $pattern = $compiler->createPlainMatcher('pre');



    return preg_replace($pattern, '
', $view);

});



$app->view->extend(function($view, $compiler) {

    $pattern = $compiler->createPlainMatcher('endpre');



    return preg_replace($pattern, '
', $view);

});

```



Now you can use `@pre` and `@endpre` whenever you want to `print_r()` your value. Just like this:



```html

@pre

print_r($myPrettyPrintVariable)

@endpre

```



## Setting the content tags blade uses



You know that blade uses `{{` and `}}` to specify content to be output, but this conflicts with Mustache or some other library you're using.

If you want to use other tags, you can use `setContentTags` method. Let's say you want to use `[%` and `%]` for your tags.



```php

use Bono\App;



$app = App::getInstance();



$app->view->setContentTags('[%', '%]');

```



Then your template can contain code like.



```html

The value of $variable is [% $variable %].

```



You can also pass a third argument as `true` to indicate you're setting the tags to **escape** content.



```php

use Bono\App;



$app = App::getInstance();



$app->view->setContentTags('[%', '%]', true);

```



Then instad of using `{{{` and `}}}` you can use `[-%` and `%-]`.



```html

The HTML tags inside this value would be escaped [%- $variable -%].

```



> **Note:** You must call `setContentTags` method before using view. The best options is: make a `Provider` that preparing all of your Blade customization.