[ Laravel 5.2 ドキュメント ] サービス -- ヘルパー関数

1. はじめに

Laravel には一連の PHP 補助関数が付属しており、それらの多くはフレームワーク自体で使用されており、便利であればコード内で使用することもできます。

2. 配列関数

array_add()

array_add 関数は、指定されたキーが存在しない場合に、指定されたキーと値のペアを配列に追加します:

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

array_collapse()

array_collapse 関数は、複数の配列を結合します。 1 つ:

$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 関数は 2 つの配列を返します。1 つは元の配列のすべてのキーを含み、もう 1 つは元の配列のすべての値を含みます:

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

array_dot()

array_dot 関数は、「.」記号を使用して多次元を変換します。 配列は 1 次元配列に変換されます:

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

array_Except()

array_exc メソッドは、配列から指定されたキーと値のペアを削除します:

$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

デフォルト値は 3 番目のパラメーターとしてこのメ​​ソッドに渡すことができ、テストに合格した値がない場合はデフォルト値が返されます:

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

array_ flatten()

array_ flatten メソッドは、多次元配列を 1 次元配列に変換します。

$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_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' => ['name' => 'Taylor']],    ['developer' => ['name' => 'Abigail']]];$array = array_pluck($array, 'developer.name');// ['Taylor', 'Abigail'];

返された結果のキーを指定することもできます:

$array = array_pluck($array, 'developer.name', 'developer.id');// [1 => 'Taylor', 2 => 'Abigail'];

array_prepend()

array_prepend 関数は、データ項目を配列の先頭にプッシュします:

$array = ['one', 'two', 'three', 'four'];$array = array_prepend($array, 'zero');// $array: ['zero', 'one', 'two', 'three', 'four']

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

3。

app_path( )

app_path 関数は、アプリ ディレクトリへの絶対パスを返します:

$path = app_path();

app_path 関数を使用して、アプリ ディレクトリを基準とした特定のファイルの絶対パスを生成することもできます:

$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 関数は、バージョンへのパスを返します-controlled Elixir ファイル:

elixir($file);

public_path()

public_path 関数はパブリック ディレクトリの絶対パスを返します:

$path = public_path();

storage_path ()

storage_path 関数はストレージ ディレクトリの絶対パスを返します:

$path = storage_path();

また、 storage_path 関数を使用して、ストレージ ディレクトリに対する指定されたファイルの絶対パスを生成します。

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

4. 文字列関数

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>');// <html>foo</html>

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 関数は数を制限しますこのメソッドは、最初のパラメータとして文字列を受け取り、2 番目のパラメータとして文字列内の出力文字の最大数を受け取ります:

$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函数将给定字符串生成URL友好的格式：

$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);

5、URL函数

action()

action函数为给定控制器动作生成URL，你不需要传递完整的命名空间到该控制器，传递相对于命名空间 App\Http\Controllers的类名即可：

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

如果该方法接收路由参数，你可以将其作为第二个参数传递进来：

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

asset()

使用当前请求的 scheme（HTTP或HTTPS）为前端资源生成一个URL：

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

secure_asset()

使用 HTTPS 为前端资源生成一个 URL：

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

route()

route函数为给定命名路由生成一个URL：

$url = route('routeName');

如果该路由接收参数，你可以将其作为第二个参数传递进来：

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

url()

url函数为给定路径生成绝对路径：

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

如果没有提供路径，将会返回 Illuminate\Routing\UrlGenerator实例：

echo url()->current();echo url()->full();echo url()->previous();

6、其它函数

auth()

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

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

back()

back函数生成重定向响应到用户前一个位置：

return back();

bcrypt()

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

$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);

dispatch()

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

dispatch(new App\Jobs\SendEmails);

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函数为给定类、名称和数量创建模型工厂构建器，可用于测试或数据填充：

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

method_field()

method_field函数生成包含HTTP请求方法的HTML隐藏域，例如：

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

old()

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

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

redirect()

redirect函数返回重定向器实例进行重定向：

return redirect('/home');

request()

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

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

response()

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

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

session()

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

$value = session('key');

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

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

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

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

value()

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

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

view()

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

return view('auth.login');

with()

with函数返回给定的值，该函数在方法链中特别有用，别的地方就没什么用了：

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