Skip to content
This repository has been archived by the owner on Aug 27, 2024. It is now read-only.

Latest commit

 

History

History
85 lines (64 loc) · 3.19 KB

README.md

File metadata and controls

85 lines (64 loc) · 3.19 KB

PHP Blade Directives

PHP CodeSniffer Release PHPv Downloads

Custom Blade directives for Laravel Applications.

See https://laravel.com/docs/blade

Laravel 5.x

Install the saritasa/blade-directives package:

$ composer require saritasa/blade-directives

If you use Laravel 5.4 or less, or 5.5+ with package discovery disabled, add the BladeDirectivesServiceProvider service provider config/app.php:

'providers' => array(
    // ...
    Saritasa\Laravel\BladeDirectivesServiceProvider::class,
)

Available directives

@activeIfRoute(routeName)

Output word 'active' if URL, requested by user, matches provided route name

Example:

<li class="@activeIfRoute('user.settings')">
    <a href="{{ route('user.settings') }}">Settings</a>
</li>

@selectedIf(expression)

Output word 'selected' if passed expression evaluates to true

Example:

<select>
    @foreach($users as $user)
        <option value='{{ $user->id }}' @selectedIf($user->id == $currentUserId)>{{ $user->name }}</option>
    @endforeach
</select>

Contributing

  1. Create fork, checkout it
  2. Develop locally as usual. Code must follow PSR-1, PSR-2 - run PHP_CodeSniffer to ensure, that code follows style guides
  3. Update README.md to describe new or changed functionality
  4. Add changes description to CHANGES.md file. Use Semantic Versioning convention to determine next version number.
  5. When ready, create pull request

Make shortcuts

If you have GNU Make installed, you can use following shortcuts:

  • make cs (instead of php vendor/bin/phpcs) - run static code analysis with PHP_CodeSniffer to check code style
  • make csfix (instead of php vendor/bin/phpcbf) - fix code style violations with PHP_CodeSniffer automatically, where possible (ex. PSR-2 code formatting violations)
  • make install - instead of composer install
  • make all or just make without parameters - invokes described above install, cs tasks sequentially - project will be assembled and checked with linter with one single command

Resources