輔助函數(shù)
輔助函數(shù)
輔助函數(shù)
簡介
Laravel 包含各種各樣的「全局」PHP 輔助函數(shù),框架本身也大量的使用了這些功能函數(shù);如果你覺的方便,你可以在你的應(yīng)用中任意使用這些函數(shù)
可用方法
數(shù)組 & 對象
Arr::add
Arr::collapse
Arr::divide
Arr::dot
Arr::except
Arr::first
Arr::flatten
Arr::forget
Arr::get
Arr::has
Arr::last
Arr::only
Arr::pluck
Arr::prepend
Arr::pull
Arr::random
Arr::set
Arr::sort
Arr::sortRecursive
Arr::where
Arr::wrap
data_fill
data_get
data_set
head
last
路徑
字符串
__
Str::camel
class_basename
e
Str::endsWith
Str::kebab
preg_replace_array
Str::snake
Str::startsWith
Str::after
Str::before
Str::contains
Str::finish
Str::is
Str::limit
Str::orderedUuid
Str::plural
Str::random
Str::replaceArray
Str::replaceFirst
Str::replaceLast
Str::singular
Str::slug
Str::start
Str::studly
Str::title
trans
trans_choice
Str::uuid
URLs
其他
abort
abort_if
abort_unless
app
auth
back
bcrypt
blank
broadcast
cache
class_uses_recursive
collect
config
cookie
csrf_field
csrf_token
dd
decrypt
dispatch
dispatch_now
dump
encrypt
env
event
factory
filled
info
logger
method_field
now
old
optional
policy
redirect
report
request
rescue
resolve
response
retry
session
tap
today
throw_if
throw_unless
trait_uses_recursive
transform
validator
value
view
with
方法列表
數(shù)組 & 對象
Arr::add()
如果給定的鍵不存在數(shù)組中,那么 Arr::add
函數(shù)將會把給定的鍵/值對添加到數(shù)組中:
use Illuminate\Support\Arr; $array = Arr::add(['name' => 'Desk'], 'price', 100); // ['name' => 'Desk', 'price' => 100]
Arr::collapse()
Arr::collapse
函數(shù)將多個數(shù)組合并為一個數(shù)組:
use Illuminate\Support\Arr; $array = Arr::collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]); // [1, 2, 3, 4, 5, 6, 7, 8, 9]
Arr::divide()
Arr::divide
函數(shù)返回一個二維數(shù)組,一個值包含原始數(shù)組的鍵,另一個值包含原始數(shù)組的值:
use Illuminate\Support\Arr; [$keys, $values] = Arr::divide(['name' => 'Desk']); // $keys: ['name'] 多維數(shù)組中的第0個值 // $values: ['Desk'] 多維數(shù)組中的第1個值
Arr::dot()
Arr::dot
函數(shù)將多維數(shù)組中所有的鍵平鋪到一維數(shù)組中,新數(shù)組使用「.」符號表示層級包含關(guān)系:
use Illuminate\Support\Arr; $array = ['products' => ['desk' => ['price' => 100]]]; $flattened = Arr::dot($array); // ['products.desk.price' => 100]
Arr::except()
Arr::except
函數(shù)從數(shù)組中刪除給定的鍵/值對:
use Illuminate\Support\Arr; $array = ['name' => 'Desk', 'price' => 100]; $filtered = Arr::except($array, ['price']); // ['name' => 'Desk']
Arr::first()
Arr::first
函數(shù)返回數(shù)組中通過指定測試的第一個元素:
use Illuminate\Support\Arr; $array = [100, 200, 300]; $first = Arr::first($array, function ($value, $key) { return $value >= 150; }); // 200
將默認值作為第三個參數(shù)傳遞給該方法, 如果數(shù)組中沒有值通過測試,則返回默認值:
use Illuminate\Support\Arr; $first = Arr::first($array, $callback, $default);
Arr::flatten()
Arr::flatten
函數(shù)將多維數(shù)組中數(shù)組的值取出平鋪為一維數(shù)組:
use Illuminate\Support\Arr; $array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']]; $flattened = Arr::flatten($array); // ['Joe', 'PHP', 'Ruby']
Arr::forget()
Arr::forget
函數(shù)使用「.」符號從深度嵌套的數(shù)組中刪除給定的鍵/值對:
use Illuminate\Support\Arr; $array = ['products' => ['desk' => ['price' => 100]]]; Arr::forget($array, 'products.desk'); // ['products' => []]
Arr::get()
Arr::get
函數(shù)使用「.」符號從深度嵌套的數(shù)組中根據(jù)指定鍵檢索值:
use Illuminate\Support\Arr; $array = ['products' => ['desk' => ['price' => 100]]]; $price = Arr::get($array, 'products.desk.price'); // 100
Arr::get
函數(shù)也接受一個默認值,如果沒有找到特定的鍵,將返回默認值:
use Illuminate\Support\Arr; $discount = Arr::get($array, 'products.desk.discount', 0); // 0
Arr::has()
Arr::has
函數(shù)使用「.」符號查找數(shù)組中是否存在指定的一個或多個鍵:
use Illuminate\Support\Arr; $array = ['product' => ['name' => 'Desk', 'price' => 100]]; $contains = Arr::has($array, 'product.name'); // true $contains = Arr::has($array, ['product.price', 'product.discount']); // false
Arr::last()
Arr::last
函數(shù)返回數(shù)組中通過指定測試的最后一個元素:
use Illuminate\Support\Arr; $array = [100, 200, 300, 110]; $last = Arr::last($array, function ($value, $key) { return $value >= 150; }); // 300
將默認值作為第三個參數(shù)傳遞給該方法,如果沒有值通過指定測試,則返回該默認值:
use Illuminate\Support\Arr; $last = Arr::last($array, $callback, $default);
Arr::only()
Arr::only
函數(shù)只返回給定數(shù)組中指定的鍵/值對:
use Illuminate\Support\Arr; $array = ['name' => 'Desk', 'price' => 100, 'orders' => 10]; $slice = Arr::only($array, ['name', 'price']); // ['name' => 'Desk', 'price' => 100]
Arr::pluck()
Arr::pluck
函數(shù)從數(shù)組中檢索給定鍵的所有值:
use Illuminate\Support\Arr;$array = [ ['developer' => ['id' => 1, 'name' => 'Taylor']], ['developer' => ['id' => 2, 'name' => 'Abigail']], ]; $names = Arr::pluck($array, 'developer.name'); // ['Taylor', 'Abigail']
你也可以指定獲取的結(jié)果的鍵:
use Illuminate\Support\Arr; $names = Arr::pluck($array, 'developer.name', 'developer.id'); // [1 => 'Taylor', 2 => 'Abigail']
Arr::prepend()
Arr::prepend
函數(shù)將一個值插入到數(shù)組的開始位置:
use Illuminate\Support\Arr; $array = ['one', 'two', 'three', 'four']; $array = Arr::prepend($array, 'zero'); // ['zero', 'one', 'two', 'three', 'four']
如果需要,你可以指定你插入值的鍵:
use Illuminate\Support\Arr; $array = ['price' => 100]; $array = Arr::prepend($array, 'Desk', 'name'); // ['name' => 'Desk', 'price' => 100]
Arr::pull()
Arr::pull
函數(shù)從數(shù)組中返回指定鍵的值并刪除此鍵/值對:
use Illuminate\Support\Arr; $array = ['name' => 'Desk', 'price' => 100]; $name = Arr::pull($array, 'name'); // $name: Desk // $array: ['price' => 100]
默認值可以作為第三個參數(shù)傳遞給該方法,如果鍵不存在,則返回該值:
use Illuminate\Support\Arr; $value = Arr::pull($array, $key, $default);
Arr::random()
Arr::random
函數(shù)從數(shù)組中隨機返回一個值:
use Illuminate\Support\Arr; $array = [1, 2, 3, 4, 5]; $random = Arr::random($array); // 4 - (隨機檢索)
你也可以將返回值的數(shù)量作為可選的第二個參數(shù)傳遞給該方法,請注意,提供這個參數(shù)會返回一個數(shù)組,即便是你只需要一項:
use Illuminate\Support\Arr; $items = Arr::random($array, 2); // [2, 5] - (隨機檢索)
Arr::set()
Arr::set
函數(shù)使用「.」符號在多維數(shù)組中設(shè)置指定鍵的值:
use Illuminate\Support\Arr; $array = ['products' => ['desk' => ['price' => 100]]]; Arr::set($array, 'products.desk.price', 200); // ['products' => ['desk' => ['price' => 200]]]
Arr::sort()
Arr::sort
函數(shù)根據(jù)數(shù)組的值對數(shù)組進行排序:
use Illuminate\Support\Arr;$array = ['Desk', 'Table', 'Chair']; $sorted = Arr::sort($array); // ['Chair', 'Desk', 'Table']
你也可以根據(jù)給定閉包返回的結(jié)果對數(shù)組進行排序:
use Illuminate\Support\Arr;$array = [ ['name' => 'Desk'], ['name' => 'Table'], ['name' => 'Chair'], ]; $sorted = array_values(Arr::sort($array, function ($value) { return $value['name']; }) ); /* [ ['name' => 'Chair'], ['name' => 'Desk'], ['name' => 'Table'], ] */
Arr::sortRecursive()
Arr::sortRecursive
函數(shù)使用 sort
函數(shù)對數(shù)組進行遞歸排序:
use Illuminate\Support\Arr;$array = [ ['Roman', 'Taylor', 'Li'], ['PHP', 'Ruby', 'JavaScript'], ['one' => 1, 'two' => 2, 'three' => 3], ]; $sorted = Arr::sortRecursive($array); /* [ ['JavaScript', 'PHP', 'Ruby'], ['one' => 1, 'three' => 3, 'two' => 2], ['Li', 'Roman', 'Taylor'], ] */
Arr::where()
Arr::where
函數(shù)使用給定閉包返回的結(jié)果過濾數(shù)組:
use Illuminate\Support\Arr; $array = [100, '200', 300, '400', 500]; $filtered = Arr::where($array, function ($value, $key) { return is_string($value); }); // [1 => '200', 3 => '400']
Arr::wrap()
Arr::wrap
函數(shù)將給定的值變?yōu)橐粋€數(shù)組,如果給定的值已經(jīng)是數(shù)組,則不改變:
use Illuminate\Support\Arr; $string = 'Laravel'; $array = Arr::wrap($string); // ['Laravel']
如果給定的值是空,則返回一個空數(shù)組:
use Illuminate\Support\Arr; $nothing = null; $array = Arr::wrap($nothing); // []
data_fill()
data_fill
函數(shù)使用「.」符號在多維數(shù)組或?qū)ο髢?nèi)設(shè)置缺省值:
$data = ['products' => ['desk' => ['price' => 100]]]; data_fill($data, 'products.desk.price', 200); // ['products' => ['desk' => ['price' => 100]]] data_fill($data, 'products.desk.discount', 10); // ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]
這個函數(shù)還接受星號「*」作為通配符,相應(yīng)的填充目標:
$data = [ 'products' => [ ['name' => 'Desk 1', 'price' => 100], ['name' => 'Desk 2'], ], ]; data_fill($data, 'products.*.price', 200); /* [ 'products' => [ ['name' => 'Desk 1', 'price' => 100], ['name' => 'Desk 2', 'price' => 200], ], ] */
data_get()
data_get
函數(shù)使用「.」符號從多維數(shù)組或?qū)ο笾袡z索值
$data = ['products' => ['desk' => ['price' => 100]]]; $price = data_get($data, 'products.desk.price'); // 100
data_get
函數(shù)也可以接收一個默認值,如果找不到指定的鍵,則返回默認值:
$discount = data_get($data, 'products.desk.discount', 0); // 0
這個函數(shù)還接受「*」作為通配符,它可以匹配數(shù)組或?qū)ο蟮娜魏捂I:
$data = [ 'product-one' => ['name' => 'Desk 1', 'price' => 100], 'product-two' => ['name' => 'Desk 2', 'price' => 150], ]; data_get($data, '*.name'); // ['Desk 1', 'Desk 2'];
data_set()
data_set
函數(shù)使用「.」符號在多維數(shù)組或?qū)ο笾性O(shè)置一個值:
$data = ['products' => ['desk' => ['price' => 100]]]; data_set($data, 'products.desk.price', 200); // ['products' => ['desk' => ['price' => 200]]]
該函數(shù)也可以接收「*」通配符,相應(yīng)的在指定鍵上設(shè)置值:
$data = [ 'products' => [ ['name' => 'Desk 1', 'price' => 100], ['name' => 'Desk 2', 'price' => 150], ], ]; data_set($data, 'products.*.price', 200); /* [ 'products' => [ ['name' => 'Desk 1', 'price' => 200], ['name' => 'Desk 2', 'price' => 200], ], ] */
默認情況下,所有現(xiàn)有值都會被覆蓋, 如果你只希望設(shè)置不存在的值,你可以選擇 false
作為第四個參數(shù)傳遞給該方法:
$data = ['products' => ['desk' => ['price' => 100]]]; data_set($data, 'products.desk.price', 200, false); // ['products' => ['desk' => ['price' => 100]]]
head()
head
函數(shù)返回給定數(shù)組中的第一個元素:
$array = [100, 200, 300]; $first = head($array); // 100
last()
last
函數(shù)返回給定數(shù)組中的最后一個元素:
$array = [100, 200, 300]; $last = last($array); // 300
路徑
app_path()
app_path
函數(shù)返回 app
目錄的完整路徑.你也可以使用 app_path
函數(shù)來設(shè)置應(yīng)用程序 app
目錄的完整路徑:
$path = app_path(); $path = app_path('Http/Controllers/Controller.php');
base_path()
base_path
函數(shù)返回項目根目錄的完整路徑.你也可以使用 base_path
函數(shù)設(shè)置項目根目錄的完整路徑:
$path = base_path(); $path = base_path('vendor/bin');
config_path()
config_path
函數(shù)返回 config
目錄的完整路徑.你也可以使用 config_path
函數(shù)設(shè)置應(yīng)用程序 config
目錄中給定文件的完整路徑:
$path = config_path(); $path = config_path('app.php');
database_path()
database_path
函數(shù)返回 database
目錄的完整路徑.你也可以使用 database_path
函數(shù)來設(shè)置 database
目錄中給定文件的完整路徑:
$path = database_path(); $path = database_path('factories/UserFactory.php');
mix()
mix
函數(shù)返回 版本化 Mix 文件 的路徑:
$path = mix('css/app.css');
public_path()
public_path
函數(shù)返回 public
目錄的完整路徑.你也可以使用 public_path
函數(shù)來生成 public
目錄中給定文件的完整路徑:
$path = public_path(); $path = public_path('css/app.css');
resource_path()
resource_path
函數(shù)返回 resources
目錄的完整路徑.你也可以使用 resource_path
函數(shù)來生成資源文件中給定文件的完整路徑
$path = resource_path(); $path = resource_path('sass/app.scss');
storage_path()
storage_path
函數(shù)返回 storage
目錄的完整路徑.你也可以使用 storage_path
函數(shù)來設(shè)置存儲目錄下指定文件的完整路徑 :
$path = storage_path(); $path = storage_path('app/file.txt');
字符串
__()
__
函數(shù)使用你的本地化文件來翻譯給定的翻譯字符串或翻譯鍵:
echo __('Welcome to our application'); echo __('messages.welcome');
如果指定的翻譯字符串或翻譯鍵不存在, __
函數(shù)將返回給定的值.所以,按照上面的例子,如果翻譯鍵 messages.welcome
不存在, __
函數(shù)會將其直接返回.
Str::camel()
The Str::camel
method converts the given string to camelCase
:Str::camel
函數(shù)將給定字符串「蛇式」轉(zhuǎn)化為 camelCase
「駝峰式」:
use Illuminate\Support\Str; $converted = Str::camel('foo_bar'); // fooBar
class_basename()
class_basename
函數(shù)返回被刪除了命名空間的指定類的類名:
$class = class_basename('Foo\Bar\Baz'); // Baz
e()
e
函數(shù)將默認值為 true
的 double_encode
選項值改為 false
來運行 PHP
的 htmlspecialchars
函數(shù) :
echo e('<html>foo</html>'); // <html>foo</html>
Str::endsWith()
Str::endsWith
函數(shù)判斷指定的字符串是否以給定的值結(jié)尾:
$result = Str::endsWith('This is my name', 'name'); // true
Str::kebab()
Str::kebab
函數(shù)將給定的「駝峰式」字符串轉(zhuǎn)化為 kebab-case
「短橫式」字符串:
use Illuminate\Support\Str; $converted = Str::kebab('fooBar'); // foo-bar
preg_replace_array()
preg_replace_array
函數(shù)使用數(shù)組順序替換字符串中的給定模式:
$string = 'The event will take place between :start and :end'; $replaced = preg_replace_array('/:[a-z_]+/', ['8:30', '9:00'], $string); // 活動將在 8:30 至 9:00 之間進行
Str::snake()
Str::snake
函數(shù)將給定的字符串轉(zhuǎn)換為 snake_case
「蛇式」:
use Illuminate\Support\Str; $converted = Str::snake('fooBar'); // foo_bar
Str::startsWith()
Str::startsWith
函數(shù)判斷給定的字符串的開頭是否是指定值:
use Illuminate\Support\Str; $result = Str::startsWith('This is my name', 'This'); // true
Str::after()
Str::after
函數(shù)返回在字符串中指定值之后的所有內(nèi)容:
use Illuminate\Support\Str; $slice = Str::after('This is my name', 'This is'); // ' my name'
Str::before()
Str::before
函數(shù)返回在字符串中指定值之前的所有內(nèi)容:
use Illuminate\Support\Str; $slice = Str::before('This is my name', 'my name'); // 'This is '
Str::contains()
Str::contains
函數(shù)判斷給定的字符串是否包含給定的值(區(qū)分大小寫):
use Illuminate\Support\Str; $contains = Str::contains('This is my name', 'my'); // true
你也可以傳遞一個數(shù)組形式的值來判斷字符串中是否包含任何值:
use Illuminate\Support\Str; $contains = Str::contains('This is my name', ['my', 'foo']); // true
Str::finish()
Str::finish
函數(shù)將給定的字符串以給定的值結(jié)尾返回(如果它尚未以給定值結(jié)尾):
use Illuminate\Support\Str; $adjusted = Str::finish('this/string', '/'); // this/string/ $adjusted = Str::finish('this/string/', '/'); // this/string/
Str::is()
Str::is
函數(shù)判斷給定的字符串是否匹配給定的模式。星號 * 可以用來表示通配符:
use Illuminate\Support\Str; $matches = Str::is('foo*', 'foobar'); // true $matches = Str::is('baz*', 'foobar'); // false
Str::limit()
Str::limit
函數(shù)按給定的長度截斷給定的字符串:
use Illuminate\Support\Str; $truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20); // The quick brown fox...
你也可以傳遞第三個參數(shù)來改變將被追加到最后的字符串:
use Illuminate\Support\Str; $truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20, ' (...)'); // The quick brown fox (...)
Str::orderedUuid()
The Str::orderedUuid
方法高效生成一個可存儲在索引數(shù)據(jù)庫列中的「第一時間」 UUID:
use Illuminate\Support\Str; return (string) Str::orderedUuid();
Str::plural()
Str::plural
函數(shù)將字符串轉(zhuǎn)換為復(fù)數(shù)形式。該函數(shù)目前僅支持英文:
use Illuminate\Support\Str; $plural = Str::plural('car'); // cars $plural = Str::plural('child'); // children
你可以提供一個整數(shù)作為函數(shù)的第二個參數(shù)來檢索字符串的單數(shù)或復(fù)數(shù)形式:
use Illuminate\Support\Str; $plural = Str::plural('child', 2); // children $plural = Str::plural('child', 1); // child
Str::random()
Str::random
函數(shù)生成一個指定長度的隨機字符串。這個函數(shù)用 PHP 的 random_bytes
函數(shù):
use Illuminate\Support\Str; $random = Str::random(40);
Str::replaceArray()
Str::replaceArray
函數(shù)使用數(shù)組順序替換字符串中的給定值:
use Illuminate\Support\Str; $string = 'The event will take place between ? and ?'; $replaced = Str::replaceArray('?', ['8:30', '9:00'], $string); // The event will take place between 8:30 and 9:00
Str::replaceFirst()
Str::replaceFirst
函數(shù)替換字符串中給定值的第一個匹配項:
use Illuminate\Support\Str; $replaced = Str::replaceFirst('the', 'a', 'the quick brown fox jumps over the lazy dog'); // a quick brown fox jumps over the lazy dog
Str::replaceLast()
Str::replaceLast
函數(shù)替換字符串中最后一次出現(xiàn)的給定值:
use Illuminate\Support\Str; $replaced = Str::replaceLast('the', 'a', 'the quick brown fox jumps over the lazy dog'); // the quick brown fox jumps over a lazy dog
Str::singular()
Str::singular
函數(shù)將字符串轉(zhuǎn)換為單數(shù)形式。該函數(shù)目前僅支持英文:
use Illuminate\Support\Str; $singular = Str::singular('cars'); // car $singular = Str::singular('children'); // child
Str::slug()
Str::slug
函數(shù)將給定的字符串生成一個 URL 友好的 「slug」 :
use Illuminate\Support\Str; $slug = Str::slug('Laravel 5 Framework', '-'); // laravel-5-framework
Str::start()
Str::start
函數(shù)將給定值添加到給定字符串的開始位置(如果字符串尚未以給定值開始):
use Illuminate\Support\Str; $adjusted = Str::start('this/string', '/'); // /this/string $adjusted = Str::start('/this/string', '/'); // /this/string
Str::studly()
Str::studly
函數(shù)將給定的字符串轉(zhuǎn)換為 「變種駝峰命名」:
use Illuminate\Support\Str; $converted = Str::studly('foo_bar'); // FooBar
Str::title()
Str::title
函數(shù)將給定的字符串轉(zhuǎn)換為「首字母大寫」:
use Illuminate\Support\Str; $converted = Str::title('a nice title uses the correct case'); // A Nice Title Uses The Correct Case
trans()
trans
函數(shù)使用你的 本地文件 轉(zhuǎn)換給定的翻譯密鑰:
echo trans('messages.welcome');
如果指定的翻譯健不存在,則 trans
方法會簡單地返回給定的健。所以,就上面的例子而言,如果翻譯健不存在, trans
方法會返回 messages.welcome
。
trans_choice()
trans_choice
函數(shù)根據(jù)詞形變化來翻譯給定的翻譯?。?/p>
echo trans_choice('messages.notifications', $unreadCount);
如果指定的翻譯健不存在, trans_choice
方法會簡單地返回給定的健。所以,按照上面的例子,如果翻譯健不存在, trans_choice
方法會返回 messages.notifications
。
Str::uuid()
Str::uuid
方法生成一個 UUID(版本 4):
use Illuminate\Support\Str; return (string) Str::uuid();
URLs
action()
action
函數(shù)為指定的控制器動作生成一個 URL 。你不需要傳遞完整的控制器命名空間。只需要傳遞相對于 App\Http\Controllers
命名空間控制器類名稱:
$url = action('HomeController@index'); $url = action([HomeController::class, 'index']);
如果該方法接受路由參數(shù),則可以將它們作為方法的第二個參數(shù)傳遞:
$url = action('UserController@profile', ['id' => 1]);
asset()
asset
函數(shù)使用當前請求的協(xié)議( HTTP 或 HTTPS )為資源文件生成 URL :
$url = asset('img/photo.jpg');
您可以通過 ASSET_URL
在 .env
文件中設(shè)置變量來配置資產(chǎn) URL 主機。如果您在 Amazon S3 等外部服務(wù)上托管資產(chǎn),這將非常有用:
// ASSET_URL=http://example.com/assets $url = asset('img/photo.jpg'); // http://example.com/assets/img/photo.jpg
secure_asset()
secure_asset
函數(shù)使用 HTTPS 協(xié)議為資源文件生成 URL:
$url = secure_asset('img/photo.jpg');
route()
route
函數(shù)為給定的命名路由生成一個 URL :
$url = route('routeName');
如果路由接受參數(shù),則可以將它們作為方法的第二個參數(shù)傳遞:
$url = route('routeName', ['id' => 1]);
默認情況下, route
函數(shù)生成的是絕對 URL 。如果你想生成一個相對 URL ,你可以傳遞 false
作為第三個參數(shù):
$url = route('routeName', ['id' => 1], false);
secure_url()
secure_url
函數(shù)為給定的路徑生成一個標準的 HTTPS URL :
$url = secure_url('user/profile'); $url = secure_url('user/profile', [1]);
url()
url
函數(shù)生成給定路徑的標準 URL :
$url = url('user/profile'); $url = url('user/profile', [1]);
如果沒有提供路徑,則返回 Illuminate\Routing\UrlGenerator
實例:
$current = url()->current(); $full = url()->full(); $previous = url()->previous();
其他
abort()
abort
函數(shù)拋出 異常處理 程序呈現(xiàn)的 HTTP 異常 :
abort(403);
你也可以提供額外的響應(yīng)文本和自定義響應(yīng)標頭:
abort(403, 'Unauthorized.', $headers);
abort_if()
如果給定的布爾表達式計算結(jié)果為 true
, abort_if
函數(shù)將拋出一個 HTTP 異常:
abort_if(! Auth::user()->isAdmin(), 403);
和 abort
方法一樣,你也可以提供異常的響應(yīng)文本作為第三個參數(shù),并提供一個自定義響應(yīng)頭數(shù)據(jù)作為第四個參數(shù)。
abort_unless()
如果給定的布爾表達式計算結(jié)果為 false
, abort_unless
函數(shù)將拋出一個 HTTP 異常:
abort_unless(Auth::user()->isAdmin(), 403);
和 abort
方法一樣,你也可以提供異常的響應(yīng)文本作為第三個參數(shù),并提供一個自定義響應(yīng)頭數(shù)組作為第四個參數(shù)。
app()
app
函數(shù)返回 服務(wù)容器 實例:
$container = app();
你可以傳遞一個類或接口名稱來從容器中解析它:
$api = app('HelpSpot\API');
auth()
auth
函數(shù)返回一個 認證 實例。為了方便起見,你可以使用它來替代 Auth
Facade :
$user = auth()->user();
如果需要,你可以指定你想要訪問的認證實例:
$user = auth('admin')->user();
back()
back
函數(shù)生成一個 重定向 HTTP 響應(yīng) 到用戶之前的位置:
return back($status = 302, $headers = [], $fallback = false); return back();
bcrypt()
bcrypt
哈希 使用 Bcrypt 對給定的值進行散列。你可以使用它替代 Hash
Facade :
$password = bcrypt('my-secret-password');
broadcast()
broadcast
函數(shù)將 廣播 給定的 事件 到它的監(jiān)聽器:
broadcast(new UserRegistered($user));
blank()
blank
函數(shù)判斷給定的值是否為空:
blank(''); blank(' '); blank(null); blank(collect()); // true blank(0); blank(true); blank(false); // false
如果想使用與 blank
函數(shù)相反的方法,請看 filled
方法。
cache()
cache
函數(shù)可以從 緩存 中獲取值.如果緩存中給定的鍵不存在,將返回一個可選的默認值:
$value = cache('key'); $value = cache('key', 'default');
你可以通過向函數(shù)添加鍵值對數(shù)組來設(shè)置緩存項。與此同時,你還應(yīng)該傳遞有效的分鐘數(shù)或者緩存的持續(xù)時間來設(shè)置緩存過期時間 :
cache(['key' => 'value'], 5); cache(['key' => 'value'], now()->addSeconds(10));
class_uses_recursive()
class_uses_recursive
函數(shù)返回一個類使用的所有 traits , 包括它所有父類使用的 traits:
$traits = class_uses_recursive(App\User::class);
collect()
collect
函數(shù)根據(jù)給定的值創(chuàng)建一個 collection 實例。
$collection = collect(['taylor', 'abigail']);
config()
config
函數(shù)獲取 configuration 變量的值??梢允褂谩更c」語法訪問配置的值,其中包括文件的名稱和訪問的選項,如果訪問的配置選項不存在,你可以指定一個默認值并且返回這個默認值:
$value = config('app.timezone'); $value = config('app.timezone', $default);
你也可以在運行時通過傳遞一個鍵/值對數(shù)組來設(shè)置配置變量:
config(['app.debug' => true]);
cookie()
cookie
函數(shù)創(chuàng)建一個新的 cookie 實例:
$cookie = cookie('name', 'value', $minutes);
csrf_field()
csrf_field
函數(shù)生成一個包含 CSRF 令牌值的 HTML 輸入表單字段 hidden
。例如,使用 Blade 語法:
{{ csrf_field() }}
csrf_token()
csrf_token
函數(shù)獲取當前 CSRF 令牌的值:
$token = csrf_token();
dd()
dd
函數(shù)打印輸出給定的變量并且結(jié)束腳本運行:
dd($value); dd($value1, $value2, $value3, ...);
如果你不停止執(zhí)行腳本,那么可以使用 dump
函數(shù)。
decrypt()
decrypt
函數(shù)可以使用 Laravel 的 加密解密機制:
$decrypted = decrypt($encrypted_value);
dispatch()
dispatch
函數(shù)將給定的 任務(wù) 推送到 Laravel 任務(wù)隊列中:
dispatch(new App\Jobs\SendEmails);
dispatch_now()
dispatch_now
函數(shù)立即運行給定的 任務(wù) 并從 handle
方法返回值:
$result = dispatch_now(new App\Jobs\SendEmails);
dump()
dump
打印給定的變量:
dump($value);dump($value1, $value2, $value3, ...);
如果你想要在打印后停止執(zhí)行腳本,可以使用 dd
函數(shù)。
{提示} 你可以使用 Artisan 中的
dump-server
命令攔截所有的dump
調(diào)用并把它們顯示在控制臺窗口而不是瀏覽器中。
encrypt()
encrypt
函數(shù)使用 Laravel 的加解密機制 對給定的值進行加密:
$encrypted = encrypt($unencrypted_value);
env()
env
函數(shù)可以獲取環(huán)境變量 配置的值或者返回默認值:
$env = env('APP_ENV');// 返回 'production' 如果 APP_ENV 未設(shè)置的話...$env = env('APP_ENV', 'production');
{注意} 如果你在部署過程中執(zhí)行了
config:cache
命令 ,那么你應(yīng)該確保只從配置文件中調(diào)用env
函數(shù).一旦配置被緩存,.env
文件將不再次加載,所有對env
函數(shù)的調(diào)用將返回null
。
event()
event
函數(shù)向監(jiān)聽器派發(fā)給定 事件 :
event(new UserRegistered($user));
factory()
factory
函數(shù)根據(jù)給定的類、名稱和數(shù)量創(chuàng)建模型工廠構(gòu)造器。它能夠被用于 測試 或 數(shù)據(jù)填充:
$user = factory(App\User::class)->make();
filled()
filled
函數(shù)返回是否不為「空」:
filled(0); filled(true); filled(false); // true filled(''); filled(' '); filled(null); filled(collect()); // false
blank
方法與 filled
作用相反。
info()
info
函數(shù)將信息寫入 log:
info('Some helpful information!');
可以將上下文數(shù)據(jù)數(shù)組傳遞給此函數(shù):
info('User login attempt failed.', ['id' => $user->id]);
logger()
logger
函數(shù)可以被用于將 debug
級別的消息寫入 log:
logger('Debug message');
可以將上下文數(shù)據(jù)數(shù)組傳遞給此函數(shù):
logger('User has logged in.', ['id' => $user->id]);
如果不帶參數(shù)調(diào)用此函數(shù),它將返回 logger 實例:
logger()->error('You are not allowed here.');
method_field()
method_field
行數(shù)生成包含模仿表單 HTTP 動作的 HTML hidden
域。下面的例子使用了 Blade 語法:
<form method="POST"> {{ method_field('DELETE') }} </form>
now()
now
函數(shù)根據(jù)當前時間創(chuàng)建一個新的 Illuminate\Support\Carbon
實例:
$now = now();
old()
old
函數(shù) 獲取 刷入 session 的 舊的輸入值 :
$value = old('value'); $value = old('value', 'default');
optional()
optional
函數(shù)接受任何參數(shù),并允許你訪問該對象上的屬性或調(diào)用其方法。如果給定對象為 null
,屬性或方法將返回 null
而不是引發(fā)錯誤:
return optional($user->address)->street; {!! old('name', optional($user)->name) !!}
optional
函數(shù)也接受閉包作為其第二個參數(shù)。如果第一個參數(shù)提供的值不是 null,閉包將被調(diào)用:
return optional(User::find($id), function ($user) { return new DummyUser; });
policy()
policy
方法為給定的類獲取 policy 實例:
$policy = policy(App\User::class);
redirect()
redirect
函數(shù)返回 重定向 HTTP 響應(yīng),如果不帶參數(shù)調(diào)用則返回重定向器實例:
return redirect($to = null, $status = 302, $headers = [], $secure = null); return redirect('/home'); return redirect()->route('route.name');
report()
report
函數(shù)使用 異常處理器 的 report
方法報告異常:
report($e);
request()
request
函數(shù)返回當前 請求 實例,或者獲取一個輸入項:
$request = request(); $value = request('key', $default);
rescue()
rescue
函數(shù)執(zhí)行給定的閉包,并且捕獲其執(zhí)行過程中引發(fā)的任何異常。捕獲的所有異常都將傳遞給 異常處理器 的 report
方法;然后繼續(xù)處理此次請求:
return rescue(function () { return $this->method(); });
還可以為其傳遞第二個參數(shù)。這個參數(shù)將作為執(zhí)行閉包引發(fā)異常時的 「默認」值:
return rescue(function () { return $this->method(); }, false); return rescue(function () { return $this->method();}, function () { return $this->failure(); });
resolve()
resolve
函數(shù)使用 服務(wù)容器 解析給定名稱的類或接口的實例:
$api = resolve('HelpSpot\API');
response()
response
函數(shù)創(chuàng)建 響應(yīng) 實例,或者獲得響應(yīng)工廠的實例:
return response('Hello World', 200, $headers); return response()->json(['foo' => 'bar'], 200, $headers);
retry()
retry
函數(shù)嘗試執(zhí)行給定的回調(diào),直到達到給定的最大嘗試閾值。如果回調(diào)沒有拋出異常,回調(diào)返回值將被返回。如果回調(diào)拋出異常,將自動重試。達到最大嘗試次數(shù),將拋出異常:
return retry(5, function () { // Attempt 5 times while resting 100ms in between attempts... }, 100);
session()
session
函數(shù)用于獲取或設(shè)置 session 值:
$value = session('key');
可以向該函數(shù)傳遞鍵值對數(shù)組來設(shè)置 session 值:
session(['chairs' => 7, 'instruments' => 3]);
不帶參數(shù)調(diào)用此函數(shù),則返回存儲在 session 中的值:
$value = session()->get('key'); session()->put('key', $value);
tap()
tap
函數(shù)接受兩個參數(shù): 任意 $value
和閉包。 $value
將被傳遞給閉包,并被 tap
函數(shù)返回。與閉包的返回值無關(guān):
$user = tap(User::first(), function ($user) { $user->name = 'taylor'; $user->save(); });
如果沒有向 tap
函數(shù)傳遞閉包,可以調(diào)用給定 $value
的任意方法。調(diào)用此方法的返回值永遠是 $value
,無論方法在其定義中返回什么。例如,Eloquent update
方法指定返回一個整數(shù)。但是,我們可以通過 tap
函數(shù)鏈式調(diào)用 update
方法強制其返回模型自身:
$user = tap($user)->update([ 'name' => $name, 'email' => $email, ]);
today()
today
函數(shù)根據(jù)當前日期創(chuàng)建新的 Illuminate\Support\Carbon
實例:
$today = today();
throw_if()
在給定的布爾表達式結(jié)果為 true
時,throw_if
函數(shù)拋出給定的異常:
throw_if(! Auth::user()->isAdmin(), AuthorizationException::class); throw_if( ! Auth::user()->isAdmin(), AuthorizationException::class, 'You are not allowed to access this page' );
throw_unless()
在給定的布爾表達式結(jié)果為 false
時,throw_unless
函數(shù)拋出給定的異常:
throw_unless(Auth::user()->isAdmin(), AuthorizationException::class); throw_unless( Auth::user()->isAdmin(), AuthorizationException::class, 'You are not allowed to access this page' );
trait_uses_recursive()
trait_uses_recursive
返回被 trait 使用的全部 trait:
$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);
transform()
transform
函數(shù)執(zhí)行基于(非 空 )給定值的 閉包
,并返回 閉包
的結(jié)果:
$callback = function ($value) { return $value * 2; }; $result = transform(5, $callback); // 10
還可以傳遞一個默認值或 閉包
作為該函數(shù)的第三個參數(shù)。如果給定的值為空時,返回該值:
$result = transform(null, $callback, 'The value is blank'); // The value is blank
validator()
validator
函數(shù)根據(jù)指定的參數(shù)創(chuàng)建一個新的 驗證器 實例。方便起見可以用它來代替 Validator
facade:
$validator = validator($data, $rules, $messages);
value()
value
函數(shù)返回給定值。如果傳遞 閉包
給此函數(shù),將執(zhí)行 閉包
并返回閉包調(diào)用的結(jié)果:
$result = value(true); // true $result = value(function () { return false; }); // false
view()
view
函數(shù)獲取一個 view 實例:
return view('auth.login');
with()
with
函數(shù)返回給定的值。如果傳遞了一個 Closure
給第二個參數(shù),那么會返回 Closure
執(zhí)行的結(jié)果:
$callback = function ($value) { return (is_numeric($value)) ? $value * 2 : 0; }; $result = with(5, $callback); // 10 $result = with(null, $callback); // 0 $result = with(5, null); // 5