幫助方法
簡介
Laravel 包含了多中“幫手” PHP 函數(shù),很多方法都在框架中進(jìn)行了使用卢肃,如果你發(fā)現(xiàn)他們很方便糙臼,你也可以在自己的應(yīng)用中使用。
方法名單
數(shù)組
array_add()
array_add
方法用來在數(shù)組中添加鍵值對禾怠,它僅會在數(shù)組中不存在所給定的鍵時才會添加:
$array = array_add(['name' => 'Desk'], 'price', 100);
// ['name' => 'Desk', 'price' => 100]
array_collapse()
array_collapse
方法會將坍塌數(shù)組到一個單一的數(shù)組中返奉。
$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
方法將會分列數(shù)組贝搁,它會返回兩個數(shù)組,一個數(shù)組包含了原數(shù)組的所有的鍵芽偏,另一個數(shù)組包含原數(shù)組所有的值:
list($keys, $values) = array_divide(['name' => 'Desk']);
// $keys: ['name']
// $values: ['Desk']
array_dot()
array_dot
方法將數(shù)組從多維降低為一維數(shù)組雷逆,它使用 .
符號來表明其深度:
$array = array_dot(['foo' => ['bar' => 'baz']]);
// ['foo.bar' => 'baz'];
array_except()
array_except
方法從數(shù)組中移除指定的鍵值對:
$array = ['name' => 'Desk', 'price' => 100];
$array = array_except($array, ['price']);
// ['name' => 'Desk']
array_first()
array_first
方法返回數(shù)組回調(diào)迭代中第一個返回真值的元素:
$array = [100, 200, 300];
$value = array_first($array, function ($key, $value) {
return $value >= 150;
});
// 200
你也可以在第三個參數(shù)中傳遞一個默認(rèn)值,如果迭代結(jié)束仍未返回真值污尉,將返回默認(rèn)值:
$value = array_first($array, $callback, $default);
array_flatten()
array_flatten
方法會將多維數(shù)組降為一維數(shù)組:
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$array = array_flatten($array);
// ['Joe', 'PHP', 'Ruby'];
array_forget()
array_forget
方法可以使用 .
語法來刪除數(shù)組中嵌套的鍵值對:
$array = ['products' => ['desk' => ['price' => 100]]];
array_forget($array, 'products.desk');
// ['products' => []]
array_get()
array_get
方法可以使用 .
語法來從數(shù)組中檢索嵌套的值:
$array = ['products' => ['desk' => ['price' => 100]]];
$value = array_get($array, 'products.desk');
// ['price' => 100]
array_get
方法也可以接收第三個參數(shù)膀哲,用來作為默認(rèn)值,如果數(shù)組中并沒有檢索到相應(yīng)的值被碗,將會返回默認(rèn)值:
$value = array_get($array, 'names.john', 'default');
array_has()
array_has
方法允許使用 .
語法來檢查數(shù)組中是否含有給定的項(xiàng):
$array = ['products' => ['desk' => ['price' => 100]]];
$hasDesk = array_has($array, 'products.desk');
// true
array_only()
array_only
方法會給定的數(shù)組中返回指定的鍵值對:
$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
$array = array_only($array, ['name', 'price']);
// ['name' => 'Desk', 'price' => 100]
array_pluck()
array_pluck
方法摘取數(shù)組中所給定的鍵值對:
$array = [
['developer' => ['id' => 1, 'name' => 'Taylor']],
['developer' => ['id' => 2, 'name' => 'Abigail']],
];
$array = array_pluck($array, 'developer.name');
// ['Taylor', 'Abigail'];
你可以可以指定希望返回的結(jié)果如何鍵化:
$array = array_pluck($array, 'developer.name', 'developer.id');
// [1 => 'Taylor', 2 => 'Abigail'];
array_prepend()
array_prepend
方法會在數(shù)組的起始端加入項(xiàng):
$array = ['one', 'two', 'three', 'four'];
$array = array_prepend($array, 'zero');
// $array: ['zero', 'one', 'two', 'three', 'four']
array_pull()
array_pull
方法從數(shù)組中返回鍵值對并將其在數(shù)組中進(jìn)行剔除:
$array = ['name' => 'Desk', 'price' => 100];
$name = array_pull($array, 'name')
// $name: Desk
// $array: ['price' => 100]
array_set()
array_set
方法使用 .
語法對數(shù)組中的項(xiàng)進(jìn)行設(shè)置值:
$array = ['products' => ['desk' => ['price' => 100]]];
array_set($array, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]
array_sort()
array_sort
方法會根據(jù)給定閉包所返回的結(jié)果對數(shù)組進(jìn)行排序:
$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
方法會對數(shù)組進(jìn)行遞歸的使用 sort
方法排序:
$array = [
[
'Roman',
'Taylor',
'Li',
],
[
'PHP',
'Ruby',
'JavaScript',
],
];
$array = array_sort_recursive($array);
/*
[
[
'Li',
'Roman',
'Taylor',
],
[
'JavaScript',
'PHP',
'Ruby',
],
];
*/
array_where()
array_where
方法會根據(jù)給定的閉包對數(shù)組進(jìn)行過濾:
$array = [100, '200', 300, '400', 500];
$array = array_where($array, function ($key, $value) {
return is_string($value);
});
// [1 => 200, 3 => 400]
head()
head
方法簡單的從數(shù)組中返回其首個元素:
$array = [100, 200, 300];
$first = head($array);
// 100
last()
last
方法返回所給定數(shù)組中的最后一個元素:
$array = [100, 200, 300];
$last = last($array);
// 300
Paths
app_path()
app_path
方法返回 app
目錄的完整路徑:
$path = app_path();
你也可以使用 app_path
方法來生成相對于應(yīng)用目錄的完整路徑:
$path = app_path('Http/Controllers/Controller.php');
base_path()
base_path
方法返回項(xiàng)目根目錄的完整路徑:
$path = base_path();
你也可以使用 base_path
方法來返回相對于根目錄的完整路徑:
$path = base_path('vendor/bin');
config_path()
config_path
方法用來返回應(yīng)用的配置文件目錄的完整路徑:
$path = config_path();
database_path()
database_path
方法返回應(yīng)用的數(shù)據(jù)庫目錄的完整路徑:
$path = database_path();
elixir()
elixir
方法返回版本化的文件路徑:
elixir($file);
public_path()
public_path
方法返回 public
目錄的完整路徑:
$path = public_path();
storage_path()
storage_path
方法返回 storage
目錄的完整路徑:
$path = storage_path();
你也可以使用 storage_path
方法來生成相對目錄的完整路徑:
$path = storage_path('app/file.txt');
Strings
camel_case()
camel_case
方法將給定字符串轉(zhuǎn)換成 camelCase
格式:
$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>');
// <html>foo</html>
ends_with()
ends_with
方法用來判斷給定的字符串是否以給定的值結(jié)尾:
$value = ends_with('This is my name', 'name');
// true
snake_case()
snake_case
方法將字符串轉(zhuǎn)換成 snake_case
格式:
$snake = snake_case('fooBar');
// foo_bar
str_limit()
str_limit
方法用來限制字符串的長度某宪。該方法的第一個參數(shù)應(yīng)該是一個字符串,而第二個參數(shù)應(yīng)該是允許返回結(jié)果的最大長度:
$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_finish()
str_finish
方法可以在字符串的結(jié)尾添加獨(dú)特的值(如果字符串不是以該值結(jié)尾):
$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
方法將字符串轉(zhuǎn)換為其相應(yīng)的復(fù)數(shù)形式,該方法目前只支持英語:
$plural = str_plural('car');
// cars
$plural = str_plural('child');
// children
你可以傳遞一個整型值到第二個參數(shù)來表明返回單數(shù)或復(fù)數(shù)形式:
$plural = str_plural('child', 2);
// children
$plural = str_plural('child', 1);
// child
str_random()
str_random
方法根據(jù)指定的長度生成隨機(jī)字符串:
$string = str_random(40);
str_singular()
str_singular
方法將字符串轉(zhuǎn)換為單數(shù)形式焚志,目前只支持英語:
$singular = str_singular('cars');
// car
str_slug()
str_slug
方法使用給定的膠連字符對給定的字符串生成 URL:
$title = str_slug('Laravel 5 Framework', '-');
// laravel-5-framework
studly_case()
studly_case
方法轉(zhuǎn)換給定的字符串到 StudlyCase
格式:
$value = studly_case('foo_bar');
// FooBar
trans()
trans
方法根據(jù)本地文件中的語言來進(jìn)行翻譯:
echo trans('validation.required');
trans_choice()
trans_choice
方法來轉(zhuǎn)義到給定的語言衣迷,并使用相應(yīng)的單復(fù)數(shù)形式:
$value = trans_choice('foo.bar', $count);
URLs
action()
action
方法根據(jù)給定的控制器動作生成相應(yīng)的 URL。你不需要傳遞完整的命名空間酱酬。默認(rèn)的所傳遞的控制器類名是相對于 App\Http\Controllers
的命名空間:
$url = action ('HomeController@getIndex');
如果方法接受路由參數(shù)壶谒,你可以傳遞第二個參數(shù)到該方法:
$url = action('UserController@profile', ['id' => 1]);
asset()
根據(jù)當(dāng)前的請求方式來返回指定資源的地址:
$url = asset('img/photo.jpg');
secure_asset()
使用 HTTPS 生成給定資源的 URL:
echo secure_asset('foo/bar.zip', $title, $attributes = []);
route()
route
方法根據(jù)給定的路由名稱來生成 URL:
$url = route('routeName');
如果路由接受參數(shù),你可以傳遞第二個參數(shù)到方法:
$url = route('routeName', ['id' => 1]);
url()
url
方法根據(jù)指定的路徑生成完整的路徑:
echo url('user/profile');
echo url('user/profile', [1]);
如果沒有路徑指定岳悟,將返回 Illuminate\Routing\UrlGenerator
的實(shí)例:
echo url()->current();
echo url()->full();
echo url()->previous();
Miscellaneous
auth()
auth
方法返回一個認(rèn)證實(shí)例佃迄。你可以方便的替換 Auth
假面:
$user = auth()->user();
back()
back
方法生成重定向響應(yīng)到用戶之前的地址:
return back();
bcrypt()
bcrypt
方法使用 Bcrypt 加密來哈希化給定的值贵少。你也可以通過 Hash
假面來調(diào)用:
$password = bcrypt('my-secret-password');
collect()
collect
方法根據(jù)給定的項(xiàng)目組來生成 collection
實(shí)例:
$collection = collect(['taylor', 'abigail']);
config()
config
根據(jù)給定的值來獲取配置項(xiàng)的值呵俏。你可以使用 .
語法來獲取配置項(xiàng)的值。也可以傳遞第二個參數(shù)作為配置項(xiàng)未找到時的默認(rèn)值:
$value = config('app.timezone');
$value = config('app.timezone', $default);
你也可以在運(yùn)行時使用鍵值對的方式對配置進(jìn)行設(shè)置:
config(['app.debug' => true]);
csrf_field()
csrf_field
方法用來生成一個 hidden
文本框字段來包含 CSRF token滔灶。你可以在 Blade 模板中使用:
{{ csrf_field() }}
csrf_token()
csrf_token
方法返回當(dāng)前的 CSRF token 值:
$token = csrf_token();
dd()
dd
方法打印輸出給定的變量并終止執(zhí)行之后的代碼:
dd($value);
如果你不想停止執(zhí)行之后的代碼普碎,你應(yīng)該使用 dump
方法:
dump($value);
dispatch()
dispatch
方法在 laravel 的任務(wù)對了中添加一個新的任務(wù):
dispatch(new App\Jobs\SendEmails);
env()
env
方法用來獲取環(huán)境變量,也可以在未設(shè)置環(huán)境變量時返回默認(rèn)值:
$env = env('APP_ENV');
// Return a default value if the variable doesn't exist...
$env = env('APP_ENV', 'production');
event()
event
方法分發(fā)給定的事件到它的監(jiān)聽器中:
event(new UserRegistered($user));
factory()
factory
方法創(chuàng)建一個模型工廠構(gòu)造器來生成給定的類名的實(shí)例录平。你可以在寫單元測試或者 seeding 時使用:
$user = factory(App\User::class)->make();
method_field()
method_field
方法生成一個 hidden
文本框來包含一個欺騙性的 HTTP 請求動詞麻车。你可以在 Blade 模板中使用:
<form method="POST">
{{ method_field('DELETE') }}
</form>
old()
old
方法返回 session 中閃存的舊的文本值:
$value = old('value');
$value = old('value', 'default');
redirect()
redirect
方法返回一個重定向的實(shí)例來做重定向響應(yīng):
return redirect('/home');
request()
request
方法返回當(dāng)前的請求實(shí)例或者檢索請求中的輸入項(xiàng):
$request = request();
$value = request('key', $default = null)
response()
response
方法生成一個響應(yīng)實(shí)例或者從響應(yīng)工廠中獲得一個實(shí)例:
return response('Hello World', 200, $headers);
return response()->json(['foo' => 'bar'], 200, $headers);
session()
session
方法可以用來獲取或者設(shè)置 session 值:
$value = session('key');
你可以通過傳遞鍵值對來進(jìn)行 session 值的設(shè)置:
session(['chairs' => 7, 'instruments' => 3]);
如果調(diào)用的是無參數(shù)的 session
方法,將返回 session 存儲器:
$value = session()->get('key');
session()->put('key', $value);
value()
value
方法會簡單的返回所給定的值斗这。但是动猬,如果你傳遞的是一個 Closure
,Closure
將會被執(zhí)行表箭,其結(jié)果將被返回:
$value = value(function () {
return 'bar';
});
view()
view
方法用來檢索 view
實(shí)例:
return view('auth.login');
with()
with
方法返回給定的值赁咙。它主要用于方法的鏈?zhǔn)秸{(diào)用:
$value = with(new Foo)->work();