教程 > Laravel 教程 > Laravel 进阶阅读：23

其他辅助函数

Laravel 辅助函数

abort()

abort 函数会抛出一个被异常处理器渲染的 HTTP 异常：

abort(403);

还可以提供异常响应文本以及自定义响应头：

abort(403, 'Unauthorized.', $headers);

abort_if()

abort_if 函数在给定布尔表达式为 true 时抛出 HTTP 异常：

abort_if(! Auth::user()->isAdmin(), 403);

和 abort 一样，你还可以传递异常响应文本作为第三个参数以及自定义响应头数组作为第四个参数。

abort_unless()

abort_unless 函数在给定布尔表达式为 false 时抛出 HTTP 异常：

abort_unless(Auth::user()->isAdmin(), 403);

和 abort 一样，你还可以传递异常响应文本作为第三个参数以及自定义响应头数组作为第四个参数。

app()

app 函数返回服务容器实例：

$container = app();

还可以传递类或接口名从容器中解析它：

$api = app('HelpSpot\API');

auth()

auth 函数返回一个认证器实例，为方便起见你可以用其取代 Auth 门面：

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

如果需要的话还可以指定你想要使用的 guard 实例：

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

back()

back 函数生成HTTP 重定向响应到用户前一个访问页面：

return back($status = 302, $headers = [], $fallback = false);

return back();

bcrypt()

bcrypt 函数使用 Bcrypt 对给定值进行哈希，你可以用其替代 Hash 门面：

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

blank()

blank 函数返回给定值是否为空：

blank('');
blank('   ');
blank(null);
blank(collect());

// true

blank(0);
blank(true);
blank(false);

// false

与 blank 相对的是 filled 函数。

broadcast()

broadcast 函数广播给定事件到监听器：

broadcast(new UserRegistered($user));

cache()

cache 函数可以用于从缓存中获取值，如果给定 key 在缓存中不存在，可选的默认值会被返回：

$value = cache('key');

$value = cache('key', 'default');

你可以通过传递数组键值对到函数来添加数据项到缓存。还需要传递缓存有效期（秒数）：

cache(['key' => 'value'], 5);

cache(['key' => 'value'], now()->addSeconds(10));

class_uses_recursive()

class_uses_recursive 函数返回某个类所使用的所有 trait，包括子类使用的：

$traits = class_uses_recursive(App\User::class);

collect()

collect 函数会根据提供的数据项创建一个集合：

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

config()

config 函数获取配置变量的值，配置值可以通过使用”.”号访问，包含文件名以及你想要访问的选项。如果配置选项不存在的话默认值将会被指定并返回：

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

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

辅助函数 config 还可以用于在运行时通过传递键值对数组设置配置变量值：

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

cookie 函数可用于创建一个新的 Cookie 实例：

$cookie = cookie('name', 'value', $minutes);

csrf_field()

csrf_field 函数生成一个包含 CSRF 令牌值的 HTML 隐藏字段，例如，使用Blade语法示例如下：

{{ csrf_field() }}

csrf_token()

csrf_token 函数获取当前 CSRF 令牌的值：

$token = csrf_token();

dd()

dd 函数输出给定变量值并终止脚本执行：

dd($value);

dd($value1, $value2, $value3, ...);

如果你不想停止脚本的运行，可以使用 dump 函数。

decrypt()

decrypt 函数使用 Laravel 加密器对给定值进行解密：

$decrypted = decrypt($encrypted_value);

dispatch()

dispatch 函数推送一个新的任务到 Laravel 任务队列：

dispatch(new App\Jobs\SendEmails);

dispatch_now()

dispatch_now 函数会立即运行给定任务并返回 handle 方法处理结果：

$result = dispatch_now(new App\Jobs\SendEmails);

dump()

dump 函数会打印给定变量：

dump($value);

dump($value1, $value2, $value3, ...);

如果你想要在打印变量后终止脚本执行，可以使用 dd 函数替代之。

注：你可以使用 Artisan 的 dump-server 命令拦截所有 dump 调用并在控制台窗口显示它们。

encrypt()

encrypt 函数使用 Laravel 加密器加密给定字符串：

$encrypted = encrypt($unencrypted_value);

env()

env 函数获取环境变量值或返回默认值：

$env = env('APP_ENV');

// 如果变量不存在返回默认值...
$env = env('APP_ENV', 'production');

注：如果你在开发过程中执行了 config:cache 命令，需要确保只在配置文件中调用了 env，一旦配置被缓存起来，.env 文件将不会被加载，因此所有对 env 函数的调用都会返回 null。

event()

event 函数分发给定事件到对应监听器：

event(new UserRegistered($user));

factory()

factory 函数为给定类、名称和数量创建模型工厂构建器，可用于测试或数据填充：

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

filled()

filled 函数会返回给定值是否不为空：

filled(0);
filled(true);
filled(false);

// true

filled('');
filled('   ');
filled(null);
filled(collect());

// false

与 filled 相对的是 blank 函数。

info()

info 函数会记录信息到日志系统：

info('Some helpful information!');

还可以传递上下文数据数组到该函数：

info('User login attempt failed.', ['id' => $user->id]);

logger()

logger 函数可以用于记录 debug 级别的日志消息：

logger('Debug message');

同样，也可以传递上下文数据数组到该函数：

logger('User has logged in.', ['id' => $user->id]);

如果没有值传入该函数的话会返回日志实例：

logger()->error('You are not allowed here.');

method_field()

method_field 函数生成包含 HTTP 请求方法的 HTML hidden 表单字段，例如：

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

now()

now 函数为当前时间创建一个新的 Illuminate\Support\Carbon 实例：

$now = now();

old()

old 函数获取存放在一次性 Session 中上一次输入的值：

$value = old('value');

$value = old('value', 'default');

optional()

optional 函数接收任意参数并允许你访问对象上的属性或调用其方法。如果给定的对象为空，属性或方法调用返回 null 而不是出错：

return optional($user->address)->street;

{!! old('name', optional($user)->name) !!}

optional 函数还可以接收一个闭包作为第二个参数，闭包会在第一个参数值不为空的情况下调用：

return optional(User::find($id), function ($user) {
    return new DummyUser;
});

policy()

policy 函数为给定模型类获取对应策略实例：

$policy = policy(App\User::class);

redirect()

redirect 函数返回 HTTP 重定向响应，如果不带参数的话返回重定向器示例：

return redirect($to = null, $status = 302, $headers = [], $secure = null);

return redirect('/home');

return redirect()->route('route.name');

report()

report 函数会使用异常处理器的 report 方法报告异常：

report($e);

request()

request 函数返回当前请求实例或者获取一个输入项：

$request = request();

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

rescue()

rescue 函数可以执行给定闭包并捕获执行过程中的所有异常。这些捕获的异常会发送给异常处理器的 report 方法，不过，请求会继续执行：

return rescue(function () {
    return $this->method();
});

还可以传递第二个参数到 rescue 函数，作为在执行闭包出现异常的情况下返回的默认值：

return rescue(function () {
    return $this->method();
}, false);

return rescue(function () {
    return $this->method();
}, function () {
    return $this->failure();
});

resolve()

resolve 函数使用服务容器将给定类或接口名解析为对应绑定实例：

$api = resolve('HelpSpot\API');

response()

response 函数创建一个响应实例或者获取响应工厂实例：

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

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

retry()

retry 函数尝试执行给定回调直到达到最大执行次数，如果回调没有抛出异常，会返回对应的返回值。如果回调抛出了异常，会自动重试。如果超出最大执行次数，异常会被抛出：

return retry(5, function () {
    // Attempt 5 times while resting 100ms in between attempts...
}, 100);

session()

session 函数可以用于获取/设置 Session 值：

$value = session('key');

可以通过传递键值对数组到该函数的方式设置 Session 值：

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

如果没有传入参数到 session 函数则返回 Session 存储器对象实例：

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

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

tap()

tap 函数接收两个参数：任意的 $value 和一个闭包。$value 会被传递到闭包然后通过 tap 函数返回。闭包返回值与函数返回值不相关：

$user = tap(User::first(), function ($user) {
    $user->name = 'taylor';

    $user->save();
});

如果没有传入闭包到 tap 函数，那么你可以调用给定 $value 上面的任意方法，调用方法的返回值永远都是 $value，不管在方法中定义的返回值是什么。例如，Eloquent update 方法通常返回一个整型，不过，我们可以通过 tap 函数强制该方法返回模型本身：

$user = tap($user)->update([
    'name' => $name,
    'email' => $email,
]);

要添加 tap 方法到一个类，可以在对应类中使用 Illuminate\Support\Traits\Tappable trait，该 trait 中包含的tap 方法接收一个闭包作为唯一参数，对象实例本身会被传递到该闭包，然后通过 tap 方法返回：

return $user->tap(function ($user) {
    //
});

throw_if()

throw_if 函数会在给定布尔表达式为 true 的情况下抛出给定异常：

throw_if(! Auth::user()->isAdmin(), AuthorizationException::class);

throw_if(
    ! Auth::user()->isAdmin(),
    AuthorizationException::class,
    'You are not allowed to access this page'
);

throw_unless()

throw_unless 函数会在给定布尔表达式为 false 的情况下抛出给定异常：

throw_unless(Auth::user()->isAdmin(), AuthorizationException::class);

throw_unless(
    Auth::user()->isAdmin(),
    AuthorizationException::class,
    'You are not allowed to access this page'
);

today()

today 函数会为当前日期创建一个新的 Illuminate\Support\Carbon 实例：

$today = today();

trait_uses_recursive()

trait_uses_recursive 函数会返回某个 trait 使用的所有 trait：

$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);

transform()

transform 函数会在给定值不为空的情况下执行闭包并返回闭包结果：

$callback = function ($value) {
    return $value * 2;
};
$result = transform(5, $callback);
// 10

默认值或者闭包可以以第三个参数的方式传递给该函数，默认值在给定值为空的情况下返回：

$result = transform(null, $callback, 'The value is blank');
// The value is blank

validator()

validator 函数通过给定参数创建一个新的验证器实例，为方便起见可以使用它代替 Validator 门面：

$validator = validator($data, $rules, $messages);

value()

value 函数返回给定的值，不过，如果你传递一个闭包到该函数，该闭包将会被执行并返回执行结果：

$result = value(true);
// true

$result = value(function () {
    return false;
});

// false

view()

view 函数获取一个视图实例：

return view('auth.login');

with()

with 函数返回给定的值，如果第二个参数是闭包，则返回闭包执行结果：

$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

Laravel 辅助函数

辅助函数 URL 函数 

其他辅助函数

Laravel 辅助函数

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()

throw_if()

throw_unless()

today()

trait_uses_recursive()

transform()

validator()

value()

view()

with()

 查看笔记

查看笔记