輔助方法

簡介

Laravel 包含一群多樣化的 PHP 輔助方法函式。許多在 Laravel 自身框架中使用；如果覺得實用，也可以在你的應用當中使用。

可用方法

陣列

array_add array_collapse array_divide array_dot array_except array_first array_flatten array_forget array_get array_has array_only array_pluck array_pull array_set array_sort array_sort_recursive array_where head last

路徑

app_path base_path config_path database_path elixir public_path storage_path

字串

camel_case class_basename e ends_with snake_case str_limit starts_with str_contains str_finish str_is str_plural str_random str_singular str_slug studly_case trans trans_choice

網址

action asset secure_asset route url

其他

auth back bcrypt collect config csrf_field csrf_token dd env event factory method_field old redirect request response session value view with

方法列表

陣列

array_add()

如果給定的鍵不存在於該陣列，array_add 函式將給定的鍵值對加到陣列中：

$array = array_add(['name' => 'Desk'], 'price', 100);

// ['name' => 'Desk', 'price' => 100]

array_collapse()

array_collapse 函式將陣列的每一個陣列折成單一陣列：

$array = array_collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);

// [1, 2, 3, 4, 5, 6, 7, 8, 9]

array_divide()

array_divide 函式回傳兩個陣列，一個包含原本陣列的鍵，另一個包含原本陣列的值：

list($keys, $values) = array_divide(['name' => 'Desk']);

// $keys: ['name']

// $values: ['Desk']

array_dot()

array_dot 函式把多維陣列扁平化成一維陣列，並用「點」式語法表示深度：

$array = array_dot(['foo' => ['bar' => 'baz']]);

// ['foo.bar' => 'baz'];

array_except()

array_except 函式從陣列移除給定的鍵值對：

$array = ['name' => 'Desk', 'price' => 100];

$array = array_except($array, ['price']);

// ['name' => 'Desk']

array_first()

array_first 函式回傳陣列中第一個通過為真測試的元素：

$array = [100, 200, 300];

$value = array_first($array, function ($key, $value) {
    return $value >= 150;
});

// 200

可傳遞第三個參數作為預設值。當沒有任何數值通過測試時將回傳該數值：

$value = array_first($array, $callback, $default);

array_flatten()

array_flatten 函式將多維陣列扁平化成一維。

$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];

$array = array_flatten($array);

// ['Joe', 'PHP', 'Ruby'];

array_forget()

array_forget 函式以「點」式語法從深度巢狀陣列移除給定的鍵值對：

$array = ['products' => ['desk' => ['price' => 100]]];

array_forget($array, 'products.desk');

// ['products' => []]

array_get()

array_get 函式使用「點」式語法從深度巢狀陣列取回給定的值：

$array = ['products' => ['desk' => ['price' => 100]]];

$value = array_get($array, 'products.desk');

// ['price' => 100]

array_get 函式同樣接受預設值，當指定的鍵找不到時回傳：

$value = array_get($array, 'names.john', 'default');

array_has()

array_has 函式使用「點」式語法檢查給定的項目是否存在於陣列中：

$array = ['products' => ['desk' => ['price' => 100]]];

$hasDesk = array_has($array, ['products.desk']);

// true

array_only()

array_only 函式從陣列回傳給定的鍵值對：

$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];

$array = array_only($array, ['name', 'price']);

// ['name' => 'Desk', 'price' => 100]

array_pluck()

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'];

array_pull()

array_pull 函式從陣列移除並回傳給定的鍵值對：

$array = ['name' => 'Desk', 'price' => 100];

$name = array_pull($array, 'name');

// $name: Desk

// $array: ['price' => 100]

array_set()

array_set 函式使用「點」式語法在深度巢狀陣列中寫入值：

$array = ['products' => ['desk' => ['price' => 100]]];

array_set($array, 'products.desk.price', 200);

// ['products' => ['desk' => ['price' => 200]]]

array_sort()

array_sort 函式借由給定閉包結果排序陣列：

$array = [
    ['name' => 'Desk'],
    ['name' => 'Chair'],
];

$array = array_values(array_sort($array, function ($value) {
    return $value['name'];
}));

/*
    [
        ['name' => 'Chair'],
        ['name' => 'Desk'],
    ]
*/

array_sort_recursive()

array_sort_recursive 函式使用 sort 函式遞迴排序陣列：

$array = [
    [
        'Roman',
        'Taylor',
        'Li',
    ],
    [
        'PHP',
        'Ruby',
        'JavaScript',
    ],
];

$array = array_sort_recursive($array);

/*
    [
        [
            'Li',
            'Roman',
            'Taylor',
        ],
        [
            'JavaScript',
            'PHP',
            'Ruby',
        ]
    ];
*/

array_where()

array_where 函式使用給定的閉包過濾陣列：

$array = [100, '200', 300, '400', 500];

$array = array_where($array, function ($key, $value) {
    return is_string($value);
});

// [1 => 200, 3 => 400]

head()

head 函式回傳給定陣列的第一個元素：

$array = [100, 200, 300];

$first = head($array);

// 100

last()

last 函式回傳給定陣列的最後一個元素：

$array = [100, 200, 300];

$last = last($array);

// 300

路徑

app_path()

app_path 函式取得 app 資料夾的完整路徑：

$path = app_path();

你同樣可以使用 app_path 函式產生針對給定檔案相對於 app 目錄的完整路徑：

$path = app_path('Http/Controllers/Controller.php');

base_path()

base_path 函式取得專案根目錄的完整路徑：

$path = base_path();

你同樣可以使用 base_path 函式產生針對給定檔案相對於專案根目錄的完整路徑：

$path = base_path('vendor/bin');

config_path()

config_path 函式取得應用設定目錄的完整路徑：

$path = config_path();

database_path()

database_path 函式取得應用資料庫目錄的完整路徑：

$path = database_path();

elixir()

elixir 函式取得加上版本號的 Elixir 檔案路徑：

elixir($file);

public_path()

public_path 函式取得 public 目錄的完整路徑：

$path = public_path();

storage_path()

storage_path 函式取得 storage 目錄的完整路徑：

$path = storage_path();

你同樣可以使用 storage_path 函式產生針對給定檔案相對於 storage 目錄的完整路徑：

$path = storage_path('app/file.txt');

字串

camel_case()

camel_case 函式會將給定的字串轉換成 駝峰式命名：

$camel = camel_case('foo_bar');

// fooBar

class_basename()

class_basename 回傳不包含命名空間的類別名稱：

$class = class_basename('Foo\Bar\Baz');

// Baz

e()

e 函式對給定字串執行 htmlentities：

echo e('<html>foo</html>');

// &lt;html&gt;foo&lt;/html&gt;

ends_with()

ends_with 函式判斷給定字串結尾是否為指定內容：

$value = ends_with('This is my name', 'name');

// true

snake_case()

snake_case 函式會將給定的字串轉換成 蛇形命名：

$snake = snake_case('fooBar');

// foo_bar

str_limit()

str_limit 函式限制字串的字元數量。該函式接受一個字串作為第一個參數，以及最大字元數量作為第二參數：

$value = str_limit('The PHP framework for web artisans.', 7);

// The PHP...

starts_with()

starts_with 函式判斷字串開頭是否為給定內容：

$value = starts_with('This is my name', 'This');

// true

str_contains()

str_contains 函式判斷給定字串是否包含指定內容：

$value = str_contains('This is my name', 'my');

// true

str_finish()

str_finish 函式添加給定內容到字串結尾：

$string = str_finish('this/string', '/');

// this/string/

str_is()

str_is 函式判斷給定的字串與給定的格式是否符合。星號可作為萬用字元使用：

$value = str_is('foo*', 'foobar');

// true

$value = str_is('baz*', 'foobar');

// false

str_plural()

str_plural 函式轉換字串成複數形。該函式目前僅支援英文：

$plural = str_plural('car');

// cars

$plural = str_plural('child');

// children

你能提供一整數做為第二參數，取得字串的單數或複數形：

$plural = str_plural('child', 2);

// children

$plural = str_plural('child', 1);

// child

str_random()

str_random 函式產生給定長度的隨機字串：

$string = str_random(40);

str_singular()

str_singular 函式轉換字串成單數形。該函式目前僅支援英文：

$singular = str_singular('cars');

// car

str_slug()

str_slug 函式從給定字串產生網址友善的「slug」：

$title = str_slug("Laravel 5 Framework", "-");

// laravel-5-framework

studly_case()

studly_case 函式將給定字串轉換成 首字大寫命名：

$value = studly_case('foo_bar');

// FooBar

trans()

trans 函式根據你的在地化檔案翻譯給定的語句：

echo trans('validation.required'):

trans_choice()

trans_choice 函式根據字尾變化翻譯給定的語句：

$value = trans_choice('foo.bar', $count);

網址

action()

action 函式產生給定控制器行為網址。你不需要輸入該控制器的完整命名空間。作為替代，請輸入基於 App\Http\Controllers 命名空間的控制器類別名稱：

$url = action('HomeController@getIndex');

如果該方法支援路由參數，你可以作為第二參數傳遞：

$url = action('UserController@profile', ['id' => 1]);

asset()

根據目前請求的協定（HTTP 或 HTTPS）產生資源檔網址：

$url = asset('img/photo.jpg');

secure_asset()

根據 HTTPS 產生資源檔網址：

echo secure_asset('foo/bar.zip', $title, $attributes = []);

route()

route 函式產生給定路由名稱網址：

$url = route('routeName');

如果該路由接受參數，你可以作為第二參數傳遞：

$url = route('routeName', ['id' => 1]);

url()

url 函式產生給定路徑的完整網址：

echo url('user/profile');

echo url('user/profile', [1]);

其他

auth()

auth 函式回傳一個認證器實例。你可以使用它取代 Auth facade：

$user = auth()->user();

back()

back() 函式產生一個重導回應讓使用者回到之前的位置：

return back();

bcrypt()

bcrypt 函式使用 Bcrypt 雜湊給定的數值。你可以使用它替代 Hash facade：

$password = bcrypt('my-secret-password');

collect()

collect 函式從給定的項目產生集合實例：

$collection = collect(['taylor', 'abigail']);

config()

config 取得設定選項的設定值。設定值可透過「點」式語法讀取，其中包含要存取的檔名以及選項名稱。可傳遞一預設值在找不到指定的設定選項時回傳該數值：

$value = config('app.timezone');

$value = config('app.timezone', $default);

config 輔助方法也可以在執行期間，根據給定的鍵值對指定設定值：

config(['app.debug' => true]);

csrf_field()

csrf_field 函式產生包含 CSRF 標記內容的 HTML 表單隱藏欄位。例如，使用 Blade 語法：

{!! csrf_field() !!}

csrf_token()

csrf_token 函式取得當前 CSRF 標記的內容：

$token = csrf_token();

dd()

dd 函式印出給定變數並結束腳本執行：

dd($value);

env()

env 函式取得環境變數值或回傳預設值：

$env = env('APP_ENV');

// Return a default value if the variable doesn't exist...
$env = env('APP_ENV', 'production');

event()

event 函式配送給定事件到所屬的監聽器：

event(new UserRegistered($user));

factory()

factory 函式根據給定類別、名稱以及總數產生模型工廠建構器（model factory builder）。可用於測試或資料填充：

$user = factory(App\User::class)->make();

method_field()

method_field 函式產生擬造 HTTP 表單動作內容的 HTML 表單隱藏欄位。例如，使用 Blade 語法：

<form method="POST">
    {!! method_field('delete') !!}
</form>

old()

old 函式取得快閃到 session 的舊有輸入數值：

$value = old('value');

redirect()

redirect 函式回傳重導器實例以進行 重導：

return redirect('/home');

request()

request 函式取得目前的請求實例或輸入的項目：

$request = request();

$value = request('key', $default = null)

response()

response 函式建立一個回應實例或獲取一個回應工廠（response factory）實例：

return response('Hello World', 200, $headers);

return response()->json(['foo' => 'bar'], 200, $headers);

session()

session 函式可被用於取得或設定單一 session 內容：

$value = session('key');

你可以透過傳遞鍵值對給該函式進行內容設定：

session(['chairs' => 7, 'instruments' => 3]);

該函式在沒有內容傳遞時，將回傳所儲存的 seesion 內容：

$value = session()->get('key');

session()->put('key', $value);

value()

value 函式回傳給定數值。而當你傳遞一個 閉包 給該函式，該 閉包 將被執行並回傳結果：

$value = value(function() { return 'bar'; });

view()

view 函式取得視圖 實例：

return view('auth.login');

with()

with 函式回傳給定的數值。該函式主要用於方法鍊結（method chaining），除此之外不太可能用到：

$value = with(new Foo)->work();