README

Laravel 提供了一些非常棒的 辅助函数 用于生成URL/链接，其自动JSON魔法使得构建API变得超级简单。它是构建单页JS应用的首选，但路由可能会变得有些头疼。

如果我们可以从JavaScript访问我们的Laravel路由会怎么样呢？

这个包允许我们将路由移植到JavaScript，并提供了一堆非常熟悉的辅助函数来使用。

安装

按照常规 composer 方法安装。

composer.json

{
	"require" : {
		"planetadeleste/laroute" : "2.*"
	}
}

注意：Laravel 4.x 用户，请查看 版本 1.3.2

app/config/app.php

	...
	
	'providers' => array(
		...
		PlanetaDelEste\Laroute\LarouteServiceProvider::class,
	],
	
	...

配置（可选）

复制包的配置文件。

php artisan vendor:publish --provider='PlanetaDelEste\Laroute\LarouteServiceProvider'

app/config/packages/planetadeleste/laroute/config.php

return [

    /*
     * The destination path for the javascript file.
     */
    'path' => 'public/js',

    /*
     * The destination filename for the javascript file.
     */
    'filename' => 'laroute',

    /*
     * The namespace for the helper functions. By default this will bind them to
     * `window.laroute`.
     */
    'namespace' => 'laroute',

    /*
     * Generate absolute URLs
     *
     * Set the Application URL in config/app.php
     */
    'absolute' => false,

    /*
     * The Filter Methode
     *
     * 'all' => All routes except "'laroute' => false"
     * 'only' => Only "'laroute' => true" routes
     * 'force' => All routes, ignored "laroute" route parameter
     * 'match' => Match routes by uri "pattern"
     */
    'filter' => 'all',
    
    /**
     * Filter regexp pattern
     */
    'pattern' => '(api).*$',

    /**
     * URL properties to be rendered on laroute.js
     */
    'properties' => ['host', 'methods', 'uri', 'name', 'action'],

    /*
     * Action Namespace
     *
     * Set here your controller namespace (see RouteServiceProvider -> $namespace) for cleaner action calls
     * e.g. 'App\Http\Controllers'
     */
    'action_namespace' => '',

    /*
     * The path to the template `laroute.js` file. This is the file that contains
     * the ported helper Laravel url/route functions and the route data to go
     * with them.
     */
    'template' => 'vendor/lord/laroute/src/templates/laroute.js',
    
    /*
     * Appends a prefix to URLs. By default the prefix is an empty string.
    *
    */
    'prefix' => '',

];

    

生成 laroute.js

为了访问路由，我们需要将它们“移植”到一个JavaScript文件中

php artisan laroute:generate

默认配置下，这将创建一个 public/js/laroute.js 文件，您可以将其包含在您的页面中或构建到项目中。

<script src="/js/laroute.js"></script>

注意：如果您更改了路由，您将需要执行 laroute:generate。

JavaScript 文档

默认情况下，所有函数都在 laroute 命名空间下。本文档将遵循此约定。

action

为给定的控制器动作生成URL。

/** 
 * laroute.action(action, [parameters = {}])
 *
 * action     : The action to route to.
 * parameters : Optional. key:value object literal of route parameters.
 */

laroute.action('HomeController@getIndex');

route

为给定的命名路由生成URL。

/**
 * laroute.route(name, [parameters = {}])
 *
 * name       : The name of the route to route to.
 * parameters : Optional. key:value object literal of route parameters.
 */
 
 laroute.route('Hello.{planet}', { planet : 'world' });

url

为给定的路径生成一个完全限定的URL。

/**
 * laroute.url(name, [parameters = []])
 *
 * name       : The name of the route to route to.
 * parameters : Optional. value array of route parameters.
 */
 
 laroute.url('foo/bar', ['aaa', 'bbb']); // -> /foo/bar/aaa/bbb

link_to

为给定的URL生成一个HTML链接。

/**
 * laroute.link_to(url, [title = url, attributes = {}]])
 *
 * url        : A relative url.
 * title      : Optional. The anchor text to display
 * attributes : Optional. key:value object literal of additional html attributes.
 */
 
 laroute.link_to('foo/bar', 'Foo Bar', { style : "color:#bada55;" });

link_to_route

为给定的路由生成一个HTML链接。

/**
 * laroute.link_to_route(name, [title = url, parameters = {}], attributes = {}]]])
 *
 * name       : The name of the route to route to.
 * title      : Optional. The anchor text to display
 * parameters : Optional. key:value object literal of route parameters.
 * attributes : Optional. key:value object literal of additional html attributes.
 */
 
 laroute.link_to_route('home', 'Home');

link_to_action

为给定的动作生成一个HTML链接。

/**
 * laroute.link_to_action(action, [title = url, parameters = {}], attributes = {}]]])
 *
 * action     : The action to route to.
 * title      : Optional. The anchor text to display
 * parameters : Optional. key:value object literal of route parameters.
 * attributes : Optional. key:value object literal of additional html attributes.
 */
 
 laroute.link_to_action('HelloController@planet', undefined, { planet : 'world' });

PHP 文档

忽略/过滤路由

默认情况下，所有路由在执行 php artisan laroute:generate 后都对laroute可用。然而，有时可能希望laroute忽略某些路由。您可以通过传递一个 laroute 路由选项来实现这一点。

Route::get('/ignore-me', [
    'laroute' => false,
    'as'      => 'ignoreme',
    'uses'    => 'IgnoreController@me'
]);

Route::group(['laroute' => false], function () {
    Route::get('/groups-are-super-useful', 'GroupsController@index');
});

许可协议

在此仓库中查看许可协议。