permafrost-dev / laravel-current-route

Laravel helper functions and classes related to the current/active route.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Laravel Current Route


Helper functions and class to retrieve information about the current route in Laravel.

GitHub tag (latest SemVer)


Installation

You can install the package via composer:

composer require permafrost-dev/laravel-current-route

Helper Functions

// Return a Laravel Route object for the current route.
function current_route();

// Return a class containing information about the current route.
function current_route_info();

// Return the action for the current route.
function current_route_action();

// Return true if one of the specified wildcard patterns matches the name of the current route.
function current_route_matches($patterns);

// Return the name for the current route.
function current_route_name();

// Returns true if $name matches the name of the current route.
function current_route_named($name);

Usage

WIP

Examples

Use current_route_named() to generate conditional css classes in a blade template:

<a class="{{ current_route_named('dashboard') ? 'active' : 'inactive' }}"
    href="{{ route('dashboard') }}">Dashboard
</a>

Testing

$ vendor/bin/phpunit

License

The MIT License (MIT). Please see the License File for more information.

About

Laravel helper functions and classes related to the current/active route.

License:MIT License


Languages

Language:PHP 100.0%