輔助函數 · laravel 5.3 中文文檔

# 輔助函數 - [簡介](#introduction) - [可用方法](#available-methods) <a name="introduction"></a> ## 簡介 Laravel 包含有各種各樣的PHP輔助函數，許多都是在 Laravel 自身框架中使用到。如果你覺得實用，也可以在你自己的應用中使用它們。 <a name="available-methods"></a> ## 可用方法 <style> .collection-method-list > p { column-count: 3; -moz-column-count: 3; -webkit-column-count: 3; column-gap: 2em; -moz-column-gap: 2em; -webkit-column-gap: 2em; } .collection-method-list a { display: block; } </style> ### 數組 <div class="collection-method-list" markdown="1"> [array_add](#method-array-add) [array_collapse](#method-array-collapse) [array_divide](#method-array-divide) [array_dot](#method-array-dot) [array_except](#method-array-except) [array_first](#method-array-first) [array_flatten](#method-array-flatten) [array_forget](#method-array-forget) [array_get](#method-array-get) [array_has](#method-array-has) [array_last](#method-array-last) [array_only](#method-array-only) [array_pluck](#method-array-pluck) [array_prepend](#method-array-prepend) [array_pull](#method-array-pull) [array_set](#method-array-set) [array_sort](#method-array-sort) [array_sort_recursive](#method-array-sort-recursive) [array_where](#method-array-where) [head](#method-head) [last](#method-last) </div> ### 路徑 <div class="collection-method-list" markdown="1"> [app_path](#method-app-path) [base_path](#method-base-path) [config_path](#method-config-path) [database_path](#method-database-path) [elixir](#method-elixir) [public_path](#method-public-path) [resource_path](#method-resource-path) [storage_path](#method-storage-path) </div> ### 字符串 <div class="collection-method-list" markdown="1"> [camel_case](#method-camel-case) [class_basename](#method-class-basename) [e](#method-e) [ends_with](#method-ends-with) [snake_case](#method-snake-case) [str_limit](#method-str-limit) [starts_with](#method-starts-with) [str_contains](#method-str-contains) [str_finish](#method-str-finish) [str_is](#method-str-is) [str_plural](#method-str-plural) [str_random](#method-str-random) [str_singular](#method-str-singular) [str_slug](#method-str-slug) [studly_case](#method-studly-case) [title_case](#method-title-case) [trans](#method-trans) [trans_choice](#method-trans-choice) </div> ### URLs <div class="collection-method-list" markdown="1"> [action](#method-action) [asset](#method-asset) [secure_asset](#method-secure-asset) [route](#method-route) [url](#method-url) </div> ### 其他 <div class="collection-method-list" markdown="1"> [abort](#method-abort) [abort_if](#method-abort-if) [abort_unless](#method-abort-unless) [auth](#method-auth) [back](#method-back) [bcrypt](#method-bcrypt) [collect](#method-collect) [config](#method-config) [csrf_field](#method-csrf-field) [csrf_token](#method-csrf-token) [dd](#method-dd) [dispatch](#method-dispatch) [env](#method-env) [event](#method-event) [factory](#method-factory) [method_field](#method-method-field) [old](#method-old) [redirect](#method-redirect) [request](#method-request) [response](#method-response) [session](#method-session) [value](#method-value) [view](#method-view) </div> <a name="method-listing"></a> ## 方法列表 <style> #collection-method code { font-size: 14px; } #collection-method:not(.first-collection-method) { margin-top: 50px; } </style> <a name="arrays"></a> ## 數組 <a name="method-array-add"></a> #### `array_add()` {#collection-method .first-collection-method} 如果指定的鍵不存在于該數組中，`array_add` 函數就會將指定的鍵值對加到數組中： $array = array_add(['name' => 'Desk'], 'price', 100); // ['name' => 'Desk', 'price' => 100] <a name="method-array-collapse"></a> #### `array_collapse()` {#collection-method} `array_collapse` 函數把數組里的每一個數組合并成單個數組： $array = array_collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]); // [1, 2, 3, 4, 5, 6, 7, 8, 9] <a name="method-array-divide"></a> #### `array_divide()` {#collection-method} `array_divide` 函數返回兩個數組，一個包含原本數組的鍵，另一個包含原本數組的值： list($keys, $values) = array_divide(['name' => 'Desk']); // $keys: ['name'] // $values: ['Desk'] <a name="method-array-dot"></a> #### `array_dot()` {#collection-method} `array_dot` 函數把多維數組壓制成一維數組，并用「點」式語法表示深度： $array = array_dot(['foo' => ['bar' => 'baz']]); // ['foo.bar' => 'baz']; <a name="method-array-except"></a> #### `array_except()` {#collection-method} `array_except` 函數從數組移除指定的鍵值對： $array = ['name' => 'Desk', 'price' => 100]; $array = array_except($array, ['price']); // ['name' => 'Desk'] <a name="method-array-first"></a> #### `array_first()` {#collection-method} `array_first` 函數返回數組中第一個通過指定測試的元素： $array = [100, 200, 300]; $value = array_first($array, function ($value, $key) { return $value >= 150; }); // 200 可傳遞第三個參數作為默認值。當沒有元素通過測試時，將會返回該默認值： $value = array_first($array, $callback, $default); <a name="method-array-flatten"></a> #### `array_flatten()` {#collection-method} `array_flatten` 函數將多維數組壓制成一維數組： $array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']]; $array = array_flatten($array); // ['Joe', 'PHP', 'Ruby']; <a name="method-array-forget"></a> #### `array_forget()` {#collection-method} `array_forget` 函數以「點」式語法從深度嵌套的數組中移除指定的鍵值對： $array = ['products' => ['desk' => ['price' => 100]]]; array_forget($array, 'products.desk'); // ['products' => []] <a name="method-array-get"></a> #### `array_get()` {#collection-method} `array_get` 函數使用「點」式語法從深度嵌套的數組中獲取指定的值： $array = ['products' => ['desk' => ['price' => 100]]]; $value = array_get($array, 'products.desk'); // ['price' => 100] `array_get` 函數同樣也接受默認值，如果指定的鍵找不到時，則返回該默認值： $value = array_get($array, 'names.john', 'default'); <a name="method-array-has"></a> #### `array_has()` {#collection-method} `array_has` 函數使用「點」式語法檢查指定的項目是否存在于數組中： $array = ['products' => ['desk' => ['price' => 100]]]; $hasDesk = array_has($array, 'products.desk'); // true <a name="method-array-last"></a> #### `array_last()` {#collection-method} `array_last` 函數返回數組中最后一個通過指定測試的元素： $array = [100, 200, 300, 110]; $value = array_last($array, function ($value, $key) { return $value >= 150; }); // 300 <a name="method-array-only"></a> #### `array_only()` {#collection-method} `array_only` 函數從數組返回指定的鍵值對： $array = ['name' => 'Desk', 'price' => 100, 'orders' => 10]; $array = array_only($array, ['name', 'price']); // ['name' => 'Desk', 'price' => 100] <a name="method-array-pluck"></a> #### `array_pluck()` {#collection-method} `array_pluck` 函數從數組拉出一列指定的鍵值對： $array = [ ['developer' => ['id' => 1, 'name' => 'Taylor']], ['developer' => ['id' => 2, 'name' => 'Abigail']], ]; $array = array_pluck($array, 'developer.name'); // ['Taylor', 'Abigail']; 你也可以指定要以什么作為結果列的鍵名： $array = array_pluck($array, 'developer.name', 'developer.id'); // [1 => 'Taylor', 2 => 'Abigail']; <a name="method-array-prepend"></a> #### `array_prepend()` {#collection-method} `array_prepend` 函數將元素加到數組的頭部： $array = ['one', 'two', 'three', 'four']; $array = array_prepend($array, 'zero'); // $array: ['zero', 'one', 'two', 'three', 'four'] <a name="method-array-pull"></a> #### `array_pull()` {#collection-method} `array_pull` 函數從數組移除指定鍵值對并返回該鍵值對： $array = ['name' => 'Desk', 'price' => 100]; $name = array_pull($array, 'name'); // $name: Desk // $array: ['price' => 100] <a name="method-array-set"></a> #### `array_set()` {#collection-method} `array_set` 函數使用「點」式語法在深度嵌套的數組中寫入值： $array = ['products' => ['desk' => ['price' => 100]]]; array_set($array, 'products.desk.price', 200); // ['products' => ['desk' => ['price' => 200]]] <a name="method-array-sort"></a> #### `array_sort()` {#collection-method} `array_sort` 函數根據指定閉包的結果排序數組： $array = [ ['name' => 'Desk'], ['name' => 'Chair'], ]; $array = array_values(array_sort($array, function ($value) { return $value['name']; })); /* [ ['name' => 'Chair'], ['name' => 'Desk'], ] */ <a name="method-array-sort-recursive"></a> #### `array_sort_recursive()` {#collection-method} `array_sort_recursive` 函數使用 `sort` 函數遞歸排序數組： $array = [ [ 'Roman', 'Taylor', 'Li', ], [ 'PHP', 'Ruby', 'JavaScript', ], ]; $array = array_sort_recursive($array); /* [ [ 'Li', 'Roman', 'Taylor', ], [ 'JavaScript', 'PHP', 'Ruby', ] ]; */ <a name="method-array-where"></a> #### `array_where()` {#collection-method} `array_where` 函數使用指定的閉包過濾數組： $array = [100, '200', 300, '400', 500]; $array = array_where($array, function ($value, $key) { return is_string($value); }); // [1 => 200, 3 => 400] <a name="method-head"></a> #### `head()` {#collection-method} `head` 函數返回指定數組的第一個元素： $array = [100, 200, 300]; $first = head($array); // 100 <a name="method-last"></a> #### `last()` {#collection-method} `last` 函數返回指定數組的最后一個元素： $array = [100, 200, 300]; $last = last($array); // 300 <a name="paths"></a> ## 路徑 <a name="method-app-path"></a> #### `app_path()` {#collection-method} `app_path` 函數返回 `app` 文件夾的完整路徑。你也可以使用 `app_path` 函數生成針對指定文件相對于 app 目錄的完整路徑： $path = app_path(); $path = app_path('Http/Controllers/Controller.php'); <a name="method-base-path"></a> #### `base_path()` {#collection-method} `base_path` 函數返回項目根目錄的完整路徑。你也可以使用 `base_path` 函數生成針對指定文件相對于項目根目錄的完整路徑： $path = base_path(); $path = base_path('vendor/bin'); <a name="method-config-path"></a> #### `config_path()` {#collection-method} `config_path` 函數返回 `config` 目錄的完整路徑： $path = config_path(); <a name="method-database-path"></a> #### `database_path()` {#collection-method} `database_path` 函數返回 `database` 目錄的完整路徑： $path = database_path(); <a name="method-elixir"></a> #### `elixir()` {#collection-method} `elixir` 函數獲取帶有版本號的 [Elixir](/docs/{{version}}/elixir) 文件路徑： elixir($file); <a name="method-public-path"></a> #### `public_path()` {#collection-method} `public_path` 函數返回 `public` 目錄的完整路徑： $path = public_path(); <a name="method-resource-path"></a> #### `resource_path()` {#collection-method} `resource_path` 函數返回 `resource` 目錄的完整路徑。你也可以使用 `resource_path` 函數生成針對指定文件相對于 `resource` 目錄的完整路徑： $path = resource_path(); $path = resource_path('assets/sass/app.scss'); <a name="method-storage-path"></a> #### `storage_path()` {#collection-method} `storage_path` 函數返回 `storage` 目錄的完整路徑。你也可以使用 `resource_path` 函數生成針對指定文件相對于 `storage` 目錄的完整路徑： $path = storage_path(); $path = storage_path('app/file.txt'); <a name="strings"></a> ## 字符串 <a name="method-camel-case"></a> #### `camel_case()` {#collection-method} `camel_case` 函數將指定的字符串轉換成 `駝峰式命名`： $camel = camel_case('foo_bar'); // fooBar <a name="method-class-basename"></a> #### `class_basename()` {#collection-method} `class_basename` 返回不包含命名空間的類名稱： $class = class_basename('Foo\Bar\Baz'); // Baz <a name="method-e"></a> #### `e()` {#collection-method} `e` 函數對指定字符串進行 `htmlentities`： echo e('<html>foo</html>'); // <html>foo</html> <a name="method-ends-with"></a> #### `ends_with()` {#collection-method} `ends_with` 函數判斷指定字符串結尾是否為指定內容： $value = ends_with('This is my name', 'name'); // true <a name="method-snake-case"></a> #### `snake_case()` {#collection-method} `snake_case` 函數將指定的字符串轉換成 `蛇形命名` ： $snake = snake_case('fooBar'); // foo_bar <a name="method-str-limit"></a> #### `str_limit()` {#collection-method} `str_limit` 函數限制字符串的字符個數，該函數接受一個字符串作為第一個參數，第二個參數為允許的最大字符個數： $value = str_limit('The PHP framework for web artisans.', 7); // The PHP... <a name="method-starts-with"></a> #### `starts_with()` {#collection-method} `starts_with` 函數判斷字符串開頭是否為指定內容： $value = starts_with('This is my name', 'This'); // true <a name="method-str-contains"></a> #### `str_contains()` {#collection-method} `str_contains` 函數判斷字符串是否包含有指定內容： $value = str_contains('This is my name', 'my'); // true <a name="method-str-finish"></a> #### `str_finish()` {#collection-method} `str_finish` 函數添加指定內容到字符串末尾： $string = str_finish('this/string', '/'); // this/string/ <a name="method-str-is"></a> #### `str_is()` {#collection-method} `str_is` 函數判斷指定的字符串是否匹配指定的格式，星號可作為通配符使用： $value = str_is('foo*', 'foobar'); // true $value = str_is('baz*', 'foobar'); // false <a name="method-str-plural"></a> #### `str_plural()` {#collection-method} `str_plural` 函數把字符串轉換成復數形式。該函數目前只支持英文： $plural = str_plural('car'); // cars $plural = str_plural('child'); // children 你可以傳入一個整數作為第二個參數，來獲取字符串的單數或復數形式： $plural = str_plural('child', 2); // children $plural = str_plural('child', 1); // child <a name="method-str-random"></a> #### `str_random()` {#collection-method} `str_random` 函數生成指定長度的隨機字符串。該函數使用了 PHP 自帶的 `random_bytes` 函數： $string = str_random(40); <a name="method-str-singular"></a> #### `str_singular()` {#collection-method} `str_singular` 函數把字符串轉換成單數形式。該函數目前只支持英文： $singular = str_singular('cars'); // car <a name="method-str-slug"></a> #### `str_slug()` {#collection-method} `str_slug` 函數根據指定字符串生成 URL 友好的「slug」： $title = str_slug('Laravel 5 Framework', '-'); // laravel-5-framework <a name="method-studly-case"></a> #### `studly_case()` {#collection-method} `studly_case` 函數把指定字符串轉換成 `首字母大寫`： $value = studly_case('foo_bar'); // FooBar <a name="method-title-case"></a> #### `title_case()` {#collection-method} `title_case` 函數把指定字符串轉換成 `每個單詞首字母大寫`： $title = title_case('a nice title uses the correct case'); // A Nice Title Uses The Correct Case <a name="method-trans"></a> #### `trans()` {#collection-method} `trans` 函數根據你的 [本地化文件](/docs/{{version}}/localization) 翻譯指定的語句： echo trans('validation.required'): <a name="method-trans-choice"></a> #### `trans_choice()` {#collection-method} `trans_choice` 函數根據數量翻譯指定的語句： $value = trans_choice('foo.bar', $count); <a name="urls"></a> ## URLs <a name="method-action"></a> #### `action()` {#collection-method} `action` 函數根據指定控制器的方法生成 URL，你不需要傳入該控制器的完整命名空間。只需要傳入相對于 `App\Http\Controllers` 命名空間的控制器類名： $url = action('HomeController@getIndex'); 如果該方法接受路由參數，可以作為第二個參數傳入： $url = action('UserController@profile', ['id' => 1]); <a name="method-asset"></a> #### `asset()` {#collection-method} 根據當前請求的協議（HTTP 或 HTTPS）生成資源文件的 URL： $url = asset('img/photo.jpg'); <a name="method-secure-asset"></a> #### `secure_asset()` {#collection-method} 使用 HTTPS 協議生成資源文件的 URL： echo secure_asset('foo/bar.zip', $title, $attributes = []); <a name="method-route"></a> #### `route()` {#collection-method} `route` 函數生成指定路由名稱的 URL： $url = route('routeName'); 如果該路由接受參數，可以作為第二個參數傳入： $url = route('routeName', ['id' => 1]); <a name="method-url"></a> #### `url()` {#collection-method} `url` 函數生成指定路徑的完整 URL： echo url('user/profile'); echo url('user/profile', [1]); 如果沒有提供路徑參數，將會返回一個 `Illuminate\Routing\UrlGenerator` 實例： echo url()->current(); echo url()->full(); echo url()->previous(); <a name="miscellaneous"></a> ## 其他 <a name="method-abort"></a> #### `abort()` {#collection-method} `abort` 函數拋出一個將被異常處理句柄渲染的 HTTP 異常： abort(401); 你也可以傳入異常的響應消息： abort(401, 'Unauthorized.'); <a name="method-abort-if"></a> #### `abort_if()` {#collection-method} `abort_if` 函數如果指定的布爾表達式值為 `true` 則拋出一個 HTTP 異常： abort_if(! Auth::user()->isAdmin(), 403); <a name="method-abort-unless"></a> #### `abort_unless()` {#collection-method} `abort_unless` 函數如果指定的布爾表達式值為 `false` 則拋出一個 HTTP 異常： abort_unless(Auth::user()->isAdmin(), 403); <a name="method-auth"></a> #### `auth()` {#collection-method} `auth` 函數返回一個 authenticator 實例，可以使用它來代替 `Auth` facade。 $user = auth()->user(); <a name="method-back"></a> #### `back()` {#collection-method} `back` 函數生成一個重定向響應讓用戶返回到之前的位置： return back(); <a name="method-bcrypt"></a> #### `bcrypt()` {#collection-method} `bcrypt` 函數使用 Bcrypt 算法哈希指定的數值。你可以使用它代替 `Hash` facade： $password = bcrypt('my-secret-password'); <a name="method-collect"></a> #### `collect()` {#collection-method} `collect` 函數根據指定的數組生成 [集合](/docs/{{version}}/collections) 實例： $collection = collect(['taylor', 'abigail']); <a name="method-config"></a> #### `config()` {#collection-method} `config` 函數用于獲取配置信息的值，配置信息的值可通過「點」式語法訪問，其中包含要訪問的文件名以及選項名。可傳遞一個默認值作為第二參數，當配置信息不存在時，則返回該默認值： $value = config('app.timezone'); $value = config('app.timezone', $default); `config` 輔助函數也可以在運行期間，根據指定的鍵值對設置指定的配置信息 config(['app.debug' => true]); <a name="method-csrf-field"></a> #### `csrf_field()` {#collection-method} `csrf_field` 函數生成包含 CSRF 令牌內容的 HTML 表單隱藏字段。例如，使用 [Blade 語法](/docs/{{version}}/blade)： {{ csrf_field() }} <a name="method-csrf-token"></a> #### `csrf_token()` {#collection-method} `csrf_token` 函數獲取當前 CSRF 令牌的內容： $token = csrf_token(); <a name="method-dd"></a> #### `dd()` {#collection-method} `dd` 函數輸出指定變量的值并終止腳本運行： dd($value); dd($value1, $value2, $value3, ...); 如果你不想終止腳本運行，使用 `dump` 函數代替： dump($value); <a name="method-dispatch"></a> #### `dispatch()` {#collection-method} `dispatch` 函數把一個新任務推送到 Laravel 的 [任務隊列](/docs/{{version}}/queues) 中： dispatch(new App\Jobs\SendEmails); <a name="method-env"></a> #### `env()` {#collection-method} `env` 函數獲取環境變量值或返回默認值： $env = env('APP_ENV'); // 當變量不存在時返回一個默認值... $env = env('APP_ENV', 'production'); <a name="method-event"></a> #### `event()` {#collection-method} `event` 函數發派指定的 [事件](/docs/{{version}}/events) 到所屬的偵聽器： event(new UserRegistered($user)); <a name="method-factory"></a> #### `factory()` {#collection-method} `factory` 函數根據指定類、名稱以及數量生成模型工廠構造器（model factory builder）。可用于 [測試](/docs/{{version}}/testing#model-factories) 或 [數據填充](/docs/{{version}}/seeding#using-model-factories)： $user = factory(App\User::class)->make(); <a name="method-method-field"></a> #### `method_field()` {#collection-method} `method_field` 函數生成模擬表單 HTTP 動詞的 HTML 表單隱藏字段。例如，使用 [Blade 語法](/docs/{{version}}/blade)： <form method="POST"> {{ method_field('DELETE') }} </form> <a name="method-old"></a> #### `old()` {#collection-method} `old` 函數 [獲取](/docs/{{version}}/requests#retrieving-input) session 內一次性的舊有輸入值： $value = old('value'); $value = old('value', 'default'); <a name="method-redirect"></a> #### `redirect()` {#collection-method} `redirect` 函數返回一個 HTTP 重定向響應，如果調用時沒有傳入參數則返回 redirector 實例： return redirect('/home'); return redirect()->route('route.name'); <a name="method-request"></a> #### `request()` {#collection-method} `request` 函數返回當前 [請求](/docs/{{version}}/requests) 實例或獲取輸入的項目： $request = request(); $value = request('key', $default = null) <a name="method-response"></a> #### `response()` {#collection-method} `response` 函數創建一個 [響應](/docs/{{version}}/responses) 實例或獲取一個 response 工廠實例： return response('Hello World', 200, $headers); return response()->json(['foo' => 'bar'], 200, $headers); <a name="method-session"></a> #### `session()` {#collection-method} `session` 函數可用于獲取或設置單個 session 項： $value = session('key'); 你可以通過傳遞鍵值對數組給該函數設置 session 項： session(['chairs' => 7, 'instruments' => 3]); 該函數在沒有傳遞參數時，將返回 session 實例： $value = session()->get('key'); session()->put('key', $value); <a name="method-value"></a> #### `value()` {#collection-method} `value` 函數返回指定數值。而當你傳遞一個 `閉包` 給該函數時，該 `閉包` 將被運行并返回該 `閉包` 的運行結果： $value = value(function() { return 'bar'; }); <a name="method-view"></a> #### `view()` {#collection-method} `view` 函數獲取 [視圖](/docs/{{version}}/views) 實例： return view('auth.login'); ## 譯者署名 | 用戶名 | 頭像 | 職能 | 簽名 | |---|---|---|---| | [@zjien](https://laravel-china.org/users/2554) | <img class="avatar-66 rm-style" src="https://dn-phphub.qbox.me/uploads/avatars/2554_1445051146.png?imageView2/1/w/200/h/200"> | 翻譯 | 專注于PHP，Laravel并學習設計模式中，[@zjien](https://github.com/zjien/) at Github |