헬퍼 (Helpers)
소개 (Introduction)
Laravel은 다양한 전역 "헬퍼" PHP 함수를 포함하고 있습니다. 이러한 함수 중 많은 부분은 프레임워크 자체에서 사용되지만, 편리하다고 판단되면 여러분의 애플리케이션에서도 자유롭게 사용할 수 있습니다.
사용 가능한 메서드 (Available Methods)
배열 & 객체
Arr::accessible Arr::add Arr::array Arr::boolean Arr::collapse Arr::crossJoin Arr::divide Arr::dot Arr::every Arr::except Arr::exceptValues Arr::exists Arr::first Arr::flatten Arr::float Arr::forget Arr::from Arr::get Arr::has Arr::hasAll Arr::hasAny Arr::integer Arr::isAssoc Arr::isList Arr::join Arr::keyBy Arr::last Arr::map Arr::mapSpread Arr::mapWithKeys Arr::only Arr::onlyValues Arr::partition Arr::pluck Arr::prepend Arr::prependKeysWith Arr::pull Arr::push Arr::query Arr::random Arr::reject Arr::select Arr::set Arr::shuffle Arr::sole Arr::some Arr::sort Arr::sortDesc Arr::sortRecursive Arr::string Arr::take Arr::toCssClasses Arr::toCssStyles Arr::undot Arr::where Arr::whereNotNull Arr::wrap data_fill data_get data_set data_forget head last
숫자
Number::abbreviate Number::clamp Number::currency Number::defaultCurrency Number::defaultLocale Number::fileSize Number::forHumans Number::format Number::ordinal Number::pairs Number::parseInt Number::parseFloat Number::percentage Number::spell Number::spellOrdinal Number::trim Number::useLocale Number::withLocale Number::useCurrency Number::withCurrency
경로
URL
기타
abort abort_if abort_unless app auth back bcrypt blank broadcast broadcast_if broadcast_unless cache class_uses_recursive collect config context cookie csrf_field csrf_token decrypt dd dispatch dispatch_sync dump encrypt env event fake filled info literal logger method_field now old once optional policy redirect report report_if report_unless request rescue resolve response retry session tap throw_if throw_unless today trait_uses_recursive transform validator value view with when
배열 & 객체 (Arrays & Objects)
Arr::accessible()
Arr::accessible 메서드는 주어진 값이 배열처럼 접근 가능한지 판단합니다.
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
$isAccessible = Arr::accessible(['a' => 1, 'b' => 2]);
// true
$isAccessible = Arr::accessible(new Collection);
// true
$isAccessible = Arr::accessible('abc');
// false
$isAccessible = Arr::accessible(new stdClass);
// false
Arr::add()
Arr::add 메서드는 주어진 키가 배열에 존재하지 않거나 null로 설정되어 있을 때만 해당 키/값 쌍을 배열에 추가합니다.
use Illuminate\Support\Arr;
$array = Arr::add(['name' => 'Desk'], 'price', 100);
// ['name' => 'Desk', 'price' => 100]
$array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);
// ['name' => 'Desk', 'price' => 100]
Arr::array()
Arr::array 메서드는 "dot" 표기법을 사용하여 깊이 중첩된 배열에서 값을 가져옵니다(Arr::get()과 동일). 요청한 값이 array가 아니면 InvalidArgumentException이 발생합니다.
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$value = Arr::array($array, 'languages');
// ['PHP', 'Ruby']
$value = Arr::array($array, 'name');
// throws InvalidArgumentException
Arr::boolean()
Arr::boolean 메서드는 "dot" 표기법을 사용하여 깊이 중첩된 배열에서 값을 가져옵니다(Arr::get()과 동일). 요청한 값이 boolean이 아니면 InvalidArgumentException이 발생합니다.
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'available' => true];
$value = Arr::boolean($array, 'available');
// true
$value = Arr::boolean($array, 'name');
// throws InvalidArgumentException
Arr::collapse()
Arr::collapse 메서드는 배열의 배열(또는 컬렉션)을 하나의 평탄한 배열로 합칩니다.
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::crossJoin()
Arr::crossJoin 메서드는 주어진 배열들을 교차 결합하여 가능한 모든 순열의 데카르트 곱을 반환합니다.
use Illuminate\Support\Arr;
$matrix = Arr::crossJoin([1, 2], ['a', 'b']);
/*
[
[1, 'a'],
[1, 'b'],
[2, 'a'],
[2, 'b'],
]
*/
$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);
/*
[
[1, 'a', 'I'],
[1, 'a', 'II'],
[1, 'b', 'I'],
[1, 'b', 'II'],
[2, 'a', 'I'],
[2, 'a', 'II'],
[2, 'b', 'I'],
[2, 'b', 'II'],
]
*/
Arr::divide()
Arr::divide 메서드는 두 개의 배열을 반환합니다. 하나는 주어진 배열의 키를 포함하고, 다른 하나는 값을 포함합니다.
use Illuminate\Support\Arr;
[$keys, $values] = Arr::divide(['name' => 'Desk']);
// $keys: ['name']
// $values: ['Desk']
Arr::dot()
Arr::dot 메서드는 다차원 배열을 깊이를 나타내는 "dot" 표기법을 사용하는 단일 레벨 배열로 평탄화합니다.
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$flattened = Arr::dot($array);
// ['products.desk.price' => 100]
Arr::every()
Arr::every 메서드는 배열의 모든 값이 주어진 조건 테스트를 통과하는지 확인합니다.
use Illuminate\Support\Arr;
$array = [1, 2, 3];
Arr::every($array, fn ($i) => $i > 0);
// true
Arr::every($array, fn ($i) => $i > 2);
// false
Arr::except()
Arr::except 메서드는 배열에서 주어진 키/값 쌍을 제거합니다.
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100];
$filtered = Arr::except($array, ['price']);
// ['name' => 'Desk']
Arr::exceptValues()
Arr::exceptValues 메서드는 배열에서 지정한 값들을 제거합니다.
use Illuminate\Support\Arr;
$array = ['foo', 'bar', 'baz', 'qux'];
$filtered = Arr::exceptValues($array, ['foo', 'baz']);
// ['bar', 'qux']
strict 인수에 true를 전달하면 필터링 시 엄격한 타입 비교를 사용할 수도 있습니다.
use Illuminate\Support\Arr;
$array = [1, '1', 2, '2'];
$filtered = Arr::exceptValues($array, [1, 2], strict: true);
// ['1', '2']
Arr::exists()
Arr::exists 메서드는 주어진 키가 제공된 배열에 존재하는지 확인합니다.
use Illuminate\Support\Arr;
$array = ['name' => 'John Doe', 'age' => 17];
$exists = Arr::exists($array, 'name');
// true
$exists = Arr::exists($array, 'salary');
// false
Arr::first()
Arr::first 메서드는 주어진 조건 테스트를 통과하는 배열의 첫 번째 요소를 반환합니다.
use Illuminate\Support\Arr;
$array = [100, 200, 300];
$first = Arr::first($array, function (int $value, int $key) {
return $value >= 150;
});
// 200
기본값을 세 번째 인수로 전달할 수도 있습니다. 이 값은 조건 테스트를 통과하는 값이 없을 때 반환됩니다.
use Illuminate\Support\Arr;
$first = Arr::first($array, $callback, $default);
Arr::flatten()
Arr::flatten 메서드는 다차원 배열을 단일 레벨 배열로 평탄화합니다.
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$flattened = Arr::flatten($array);
// ['Joe', 'PHP', 'Ruby']
Arr::float()
Arr::float 메서드는 "dot" 표기법을 사용하여 깊이 중첩된 배열에서 값을 가져옵니다(Arr::get()과 동일). 요청한 값이 float가 아니면 InvalidArgumentException이 발생합니다.
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'balance' => 123.45];
$value = Arr::float($array, 'balance');
// 123.45
$value = Arr::float($array, 'name');
// throws InvalidArgumentException
Arr::forget()
Arr::forget 메서드는 "dot" 표기법을 사용하여 깊이 중첩된 배열에서 주어진 키/값 쌍을 제거합니다.
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::forget($array, 'products.desk');
// ['products' => []]
Arr::from()
Arr::from 메서드는 다양한 입력 타입을 일반 PHP 배열로 변환합니다. 배열, 객체, 그리고 Arrayable, Enumerable, Jsonable, JsonSerializable과 같은 여러 일반적인 Laravel 인터페이스를 지원합니다. 또한 Traversable과 WeakMap 인스턴스도 처리합니다.
use Illuminate\Support\Arr;
Arr::from((object) ['foo' => 'bar']); // ['foo' => 'bar']
class TestJsonableObject implements Jsonable
{
public function toJson($options = 0)
{
return json_encode(['foo' => 'bar']);
}
}
Arr::from(new TestJsonableObject); // ['foo' => 'bar']
Arr::get()
Arr::get 메서드는 "dot" 표기법을 사용하여 깊이 중첩된 배열에서 값을 가져옵니다.
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$price = Arr::get($array, 'products.desk.price');
// 100
Arr::get 메서드는 기본값도 받을 수 있으며, 지정한 키가 배열에 존재하지 않을 때 반환됩니다.
use Illuminate\Support\Arr;
$discount = Arr::get($array, 'products.desk.discount', 0);
// 0
Arr::has()
Arr::has 메서드는 "dot" 표기법을 사용하여 주어진 항목 또는 항목들이 배열에 존재하는지 확인합니다.
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::hasAll()
Arr::hasAll 메서드는 "dot" 표기법을 사용하여 지정한 모든 키가 주어진 배열에 존재하는지 판단합니다.
use Illuminate\Support\Arr;
$array = ['name' => 'Taylor', 'language' => 'PHP'];
Arr::hasAll($array, ['name']); // true
Arr::hasAll($array, ['name', 'language']); // true
Arr::hasAll($array, ['name', 'IDE']); // false
Arr::hasAny()
Arr::hasAny 메서드는 "dot" 표기법을 사용하여 주어진 항목 집합 중 하나라도 배열에 존재하는지 확인합니다.
use Illuminate\Support\Arr;
$array = ['product' => ['name' => 'Desk', 'price' => 100]];
$contains = Arr::hasAny($array, 'product.name');
// true
$contains = Arr::hasAny($array, ['product.name', 'product.discount']);
// true
$contains = Arr::hasAny($array, ['category', 'product.discount']);
// false
Arr::integer()
Arr::integer 메서드는 "dot" 표기법을 사용하여 깊이 중첩된 배열에서 값을 가져옵니다(Arr::get()과 동일). 요청한 값이 int가 아니면 InvalidArgumentException이 발생합니다.
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'age' => 42];
$value = Arr::integer($array, 'age');
// 42
$value = Arr::integer($array, 'name');
// throws InvalidArgumentException
Arr::isAssoc()
Arr::isAssoc 메서드는 주어진 배열이 연관 배열이면 true를 반환합니다. 배열의 키가 0부터 시작하는 순차적인 숫자 키가 아닌 경우 "연관" 배열로 간주됩니다.
use Illuminate\Support\Arr;
$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);
// true
$isAssoc = Arr::isAssoc([1, 2, 3]);
// false
Arr::isList()
Arr::isList 메서드는 주어진 배열의 키가 0부터 시작하는 순차적인 정수이면 true를 반환합니다.
use Illuminate\Support\Arr;
$isList = Arr::isList(['foo', 'bar', 'baz']);
// true
$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);
// false
Arr::join()
Arr::join 메서드는 배열 요소를 문자열로 연결합니다. 이 메서드의 세 번째 인수를 사용하면 배열의 마지막 요소에 대한 연결 문자열을 지정할 수도 있습니다.
use Illuminate\Support\Arr;
$array = ['Tailwind', 'Alpine', 'Laravel', 'Livewire'];
$joined = Arr::join($array, ', ');
// Tailwind, Alpine, Laravel, Livewire
$joined = Arr::join($array, ', ', ', and ');
// Tailwind, Alpine, Laravel, and Livewire
Arr::keyBy()
Arr::keyBy 메서드는 주어진 키를 기준으로 배열의 키를 재구성합니다. 동일한 키를 가진 항목이 여러 개 있으면 마지막 항목만 새 배열에 나타납니다.
use Illuminate\Support\Arr;
$array = [
['product_id' => 'prod-100', 'name' => 'Desk'],
['product_id' => 'prod-200', 'name' => 'Chair'],
];
$keyed = Arr::keyBy($array, 'product_id');
/*
[
'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
]
*/
Arr::last()
Arr::last 메서드는 주어진 조건 테스트를 통과하는 배열의 마지막 요소를 반환합니다.
use Illuminate\Support\Arr;
$array = [100, 200, 300, 110];
$last = Arr::last($array, function (int $value, int $key) {
return $value >= 150;
});
// 300
기본값을 세 번째 인수로 전달할 수 있습니다. 이 값은 조건 테스트를 통과하는 값이 없을 때 반환됩니다.
use Illuminate\Support\Arr;
$last = Arr::last($array, $callback, $default);
Arr::map()
Arr::map 메서드는 배열을 순회하며 각 값과 키를 주어진 콜백에 전달합니다. 배열 값은 콜백이 반환한 값으로 대체됩니다.
use Illuminate\Support\Arr;
$array = ['first' => 'james', 'last' => 'kirk'];
$mapped = Arr::map($array, function (string $value, string $key) {
return ucfirst($value);
});
// ['first' => 'James', 'last' => 'Kirk']
Arr::mapSpread()
Arr::mapSpread 메서드는 배열을 순회하며 각 중첩된 항목의 값을 주어진 클로저에 전달합니다. 클로저에서 항목을 수정하고 반환할 수 있으므로, 수정된 항목으로 구성된 새 배열이 형성됩니다.
use Illuminate\Support\Arr;
$array = [
[0, 1],
[2, 3],
[4, 5],
[6, 7],
[8, 9],
];
$mapped = Arr::mapSpread($array, function (int $even, int $odd) {
return $even + $odd;
});
/*
[1, 5, 9, 13, 17]
*/
Arr::mapWithKeys()
Arr::mapWithKeys 메서드는 배열을 순회하며 각 값을 주어진 콜백에 전달합니다. 콜백은 하나의 키/값 쌍을 포함하는 연관 배열을 반환해야 합니다.
use Illuminate\Support\Arr;
$array = [
[
'name' => 'John',
'department' => 'Sales',
'email' => '[email protected]',
],
[
'name' => 'Jane',
'department' => 'Marketing',
'email' => '[email protected]',
]
];
$mapped = Arr::mapWithKeys($array, function (array $item, int $key) {
return [$item['email'] => $item['name']];
});
/*
[
'[email protected]' => 'John',
'[email protected]' => 'Jane',
]
*/
Arr::only()
Arr::only 메서드는 주어진 배열에서 지정한 키/값 쌍만 반환합니다.
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
$slice = Arr::only($array, ['name', 'price']);
// ['name' => 'Desk', 'price' => 100]
Arr::onlyValues()
Arr::onlyValues 메서드는 배열에서 지정한 값들만 반환합니다.
use Illuminate\Support\Arr;
$array = ['foo', 'bar', 'baz', 'qux'];
$filtered = Arr::onlyValues($array, ['foo', 'baz']);
// ['foo', 'baz']
strict 인수에 true를 전달하면 필터링 시 엄격한 타입 비교를 사용할 수도 있습니다.
use Illuminate\Support\Arr;
$array = [1, '1', 2, '2'];
$filtered = Arr::onlyValues($array, [1, 2], strict: true);
// [1, 2]
Arr::partition()
Arr::partition 메서드는 PHP 배열 구조 분해와 결합하여 주어진 조건 테스트를 통과하는 요소와 통과하지 않는 요소를 분리할 수 있습니다.
<?php
use Illuminate\Support\Arr;
$numbers = [1, 2, 3, 4, 5, 6];
[$underThree, $equalOrAboveThree] = Arr::partition($numbers, function (int $i) {
return $i < 3;
});
dump($underThree);
// [1, 2]
dump($equalOrAboveThree);
// [3, 4, 5, 6]
Arr::pluck()
Arr::pluck 메서드는 배열에서 주어진 키에 해당하는 모든 값을 가져옵니다.
use Illuminate\Support\Arr;
$array = [
['developer' => ['id' => 1, 'name' => 'Taylor']],
['developer' => ['id' => 2, 'name' => 'Abigail']],
];
$names = Arr::pluck($array, 'developer.name');
// ['Taylor', 'Abigail']
결과 리스트의 키를 지정할 수도 있습니다.
use Illuminate\Support\Arr;
$names = Arr::pluck($array, 'developer.name', 'developer.id');
// [1 => 'Taylor', 2 => 'Abigail']
Arr::prepend()
Arr::prepend 메서드는 배열의 시작 부분에 항목을 추가합니다.
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::prependKeysWith()
Arr::prependKeysWith 메서드는 연관 배열의 모든 키 이름 앞에 주어진 접두사를 추가합니다.
use Illuminate\Support\Arr;
$array = [
'name' => 'Desk',
'price' => 100,
];
$keyed = Arr::prependKeysWith($array, 'product.');
/*
[
'product.name' => 'Desk',
'product.price' => 100,
]
*/
Arr::pull()
Arr::pull 메서드는 배열에서 키/값 쌍을 반환하고 제거합니다.
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100];
$name = Arr::pull($array, 'name');
// $name: Desk
// $array: ['price' => 100]
기본값을 세 번째 인수로 전달할 수 있습니다. 이 값은 키가 존재하지 않을 때 반환됩니다.
use Illuminate\Support\Arr;
$value = Arr::pull($array, $key, $default);
Arr::push()
Arr::push 메서드는 "dot" 표기법을 사용하여 배열에 항목을 추가합니다. 주어진 키에 배열이 존재하지 않으면 새로 생성됩니다.
use Illuminate\Support\Arr;
$array = [];
Arr::push($array, 'office.furniture', 'Desk');
// $array: ['office' => ['furniture' => ['Desk']]]
Arr::query()
Arr::query 메서드는 배열을 쿼리 문자열로 변환합니다.
use Illuminate\Support\Arr;
$array = [
'name' => 'Taylor',
'order' => [
'column' => 'created_at',
'direction' => 'desc'
]
];
Arr::query($array);
// name=Taylor&order[column]=created_at&order[direction]=desc
Arr::random()
Arr::random 메서드는 배열에서 임의의 값을 반환합니다.
use Illuminate\Support\Arr;
$array = [1, 2, 3, 4, 5];
$random = Arr::random($array);
// 4 - (retrieved randomly)
반환할 항목 수를 선택적 두 번째 인수로 지정할 수도 있습니다. 이 인수를 제공하면 하나의 항목만 원하더라도 배열이 반환됩니다.
use Illuminate\Support\Arr;
$items = Arr::random($array, 2);
// [2, 5] - (retrieved randomly)
Arr::reject()
Arr::reject 메서드는 주어진 클로저를 사용하여 배열에서 항목을 제거합니다.
use Illuminate\Support\Arr;
$array = [100, '200', 300, '400', 500];
$filtered = Arr::reject($array, function (string|int $value, int $key) {
return is_string($value);
});
// [0 => 100, 2 => 300, 4 => 500]
Arr::select()
Arr::select 메서드는 배열에서 지정한 값들의 배열을 선택합니다.
use Illuminate\Support\Arr;
$array = [
['id' => 1, 'name' => 'Desk', 'price' => 200],
['id' => 2, 'name' => 'Table', 'price' => 150],
['id' => 3, 'name' => 'Chair', 'price' => 300],
];
Arr::select($array, ['name', 'price']);
// [['name' => 'Desk', 'price' => 200], ['name' => 'Table', 'price' => 150], ['name' => 'Chair', 'price' => 300]]
Arr::set()
Arr::set 메서드는 "dot" 표기법을 사용하여 깊이 중첩된 배열 내에 값을 설정합니다.
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::set($array, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]
Arr::shuffle()
Arr::shuffle 메서드는 배열의 항목을 무작위로 섞습니다.
use Illuminate\Support\Arr;
$array = Arr::shuffle([1, 2, 3, 4, 5]);
// [3, 2, 5, 1, 4] - (generated randomly)
Arr::sole()
Arr::sole 메서드는 주어진 클로저를 사용하여 배열에서 단일 값을 가져옵니다. 배열 내에서 주어진 조건 테스트에 맞는 값이 둘 이상이면 Illuminate\Support\MultipleItemsFoundException 예외가 발생합니다. 조건에 맞는 값이 없으면 Illuminate\Support\ItemNotFoundException 예외가 발생합니다.
use Illuminate\Support\Arr;
$array = ['Desk', 'Table', 'Chair'];
$value = Arr::sole($array, fn (string $value) => $value === 'Desk');
// 'Desk'
Arr::some()
Arr::some 메서드는 배열의 값 중 최소 하나가 주어진 조건 테스트를 통과하는지 확인합니다.
use Illuminate\Support\Arr;
$array = [1, 2, 3];
Arr::some($array, fn ($i) => $i > 2);
// true
Arr::sort()
Arr::sort 메서드는 배열을 값 기준으로 정렬합니다.
use Illuminate\Support\Arr;
$array = ['Desk', 'Table', 'Chair'];
$sorted = Arr::sort($array);
// ['Chair', 'Desk', 'Table']
주어진 클로저의 결과를 기준으로 배열을 정렬할 수도 있습니다.
use Illuminate\Support\Arr;
$array = [
['name' => 'Desk'],
['name' => 'Table'],
['name' => 'Chair'],
];
$sorted = array_values(Arr::sort($array, function (array $value) {
return $value['name'];
}));
/*
[
['name' => 'Chair'],
['name' => 'Desk'],
['name' => 'Table'],
]
*/
Arr::sortDesc()
Arr::sortDesc 메서드는 배열을 값 기준으로 내림차순 정렬합니다.
use Illuminate\Support\Arr;
$array = ['Desk', 'Table', 'Chair'];
$sorted = Arr::sortDesc($array);
// ['Table', 'Desk', 'Chair']
주어진 클로저의 결과를 기준으로 배열을 정렬할 수도 있습니다.
use Illuminate\Support\Arr;
$array = [
['name' => 'Desk'],
['name' => 'Table'],
['name' => 'Chair'],
];
$sorted = array_values(Arr::sortDesc($array, function (array $value) {
return $value['name'];
}));
/*
[
['name' => 'Table'],
['name' => 'Desk'],
['name' => 'Chair'],
]
*/
Arr::sortRecursive()
Arr::sortRecursive 메서드는 숫자 인덱스 하위 배열에는 sort 함수를, 연관 하위 배열에는 ksort 함수를 사용하여 배열을 재귀적으로 정렬합니다.
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::sortRecursiveDesc 메서드를 사용할 수 있습니다.
$sorted = Arr::sortRecursiveDesc($array);
Arr::string()
Arr::string 메서드는 "dot" 표기법을 사용하여 깊이 중첩된 배열에서 값을 가져옵니다(Arr::get()과 동일). 요청한 값이 string이 아니면 InvalidArgumentException이 발생합니다.
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$value = Arr::string($array, 'name');
// Joe
$value = Arr::string($array, 'languages');
// throws InvalidArgumentException
Arr::take()
Arr::take 메서드는 지정한 수의 항목을 가진 새 배열을 반환합니다.
use Illuminate\Support\Arr;
$array = [0, 1, 2, 3, 4, 5];
$chunk = Arr::take($array, 3);
// [0, 1, 2]
음수 정수를 전달하면 배열 끝에서 지정한 수의 항목을 가져올 수도 있습니다.
$array = [0, 1, 2, 3, 4, 5];
$chunk = Arr::take($array, -2);
// [4, 5]
Arr::toCssClasses()
Arr::toCssClasses 메서드는 조건에 따라 CSS 클래스 문자열을 컴파일합니다. 이 메서드는 클래스 배열을 받으며, 배열 키에는 추가하려는 클래스를, 값에는 불리언 표현식을 지정합니다. 배열 요소가 숫자 키를 가지면 렌더링된 클래스 목록에 항상 포함됩니다.
use Illuminate\Support\Arr;
$isActive = false;
$hasError = true;
$array = ['p-4', 'font-bold' => $isActive, 'bg-red' => $hasError];
$classes = Arr::toCssClasses($array);
/*
'p-4 bg-red'
*/
Arr::toCssStyles()
Arr::toCssStyles 메서드는 조건에 따라 CSS 스타일 문자열을 컴파일합니다. 이 메서드는 CSS 선언 배열을 받으며, 배열 키에는 추가하려는 CSS 선언을, 값에는 불리언 표현식을 지정합니다. 배열 요소가 숫자 키를 가지면 컴파일된 CSS 스타일 문자열에 항상 포함됩니다.
use Illuminate\Support\Arr;
$hasColor = true;
$array = ['background-color: blue', 'color: blue' => $hasColor];
$classes = Arr::toCssStyles($array);
/*
'background-color: blue; color: blue;'
*/
이 메서드는 Blade 컴포넌트의 속성 백과 클래스를 병합하는 기능과 @class Blade 디렉티브를 지원하는 Laravel의 기능을 구동합니다.
Arr::undot()
Arr::undot 메서드는 "dot" 표기법을 사용하는 단일 차원 배열을 다차원 배열로 확장합니다.
use Illuminate\Support\Arr;
$array = [
'user.name' => 'Kevin Malone',
'user.occupation' => 'Accountant',
];
$array = Arr::undot($array);
// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]
Arr::where()
Arr::where 메서드는 주어진 클로저를 사용하여 배열을 필터링합니다.
use Illuminate\Support\Arr;
$array = [100, '200', 300, '400', 500];
$filtered = Arr::where($array, function (string|int $value, int $key) {
return is_string($value);
});
// [1 => '200', 3 => '400']
Arr::whereNotNull()
Arr::whereNotNull 메서드는 주어진 배열에서 모든 null 값을 제거합니다.
use Illuminate\Support\Arr;
$array = [0, null];
$filtered = Arr::whereNotNull($array);
// [0 => 0]
Arr::wrap()
Arr::wrap 메서드는 주어진 값을 배열로 감쌉니다. 주어진 값이 이미 배열이면 수정 없이 반환됩니다.
use Illuminate\Support\Arr;
$string = 'Laravel';
$array = Arr::wrap($string);
// ['Laravel']
주어진 값이 null이면 빈 배열이 반환됩니다.
use Illuminate\Support\Arr;
$array = Arr::wrap(null);
// []
data_fill()
data_fill 함수는 "dot" 표기법을 사용하여 중첩된 배열이나 객체 내에 누락된 값을 설정합니다.
$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]]]
이 함수는 와일드카드로 별표(*)도 받으며 대상을 그에 맞게 채웁니다.
$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 함수는 "dot" 표기법을 사용하여 중첩된 배열이나 객체에서 값을 가져옵니다.
$data = ['products' => ['desk' => ['price' => 100]]];
$price = data_get($data, 'products.desk.price');
// 100
data_get 함수는 기본값도 받으며, 지정한 키를 찾지 못하면 반환됩니다.
$discount = data_get($data, 'products.desk.discount', 0);
// 0
이 함수는 별표를 사용한 와일드카드도 받으며, 배열이나 객체의 모든 키를 대상으로 할 수 있습니다.
$data = [
'product-one' => ['name' => 'Desk 1', 'price' => 100],
'product-two' => ['name' => 'Desk 2', 'price' => 150],
];
data_get($data, '*.name');
// ['Desk 1', 'Desk 2'];
{first}와 {last} 플레이스홀더를 사용하여 배열의 첫 번째 또는 마지막 항목을 가져올 수 있습니다.
$flight = [
'segments' => [
['from' => 'LHR', 'departure' => '9:00', 'to' => 'IST', 'arrival' => '15:00'],
['from' => 'IST', 'departure' => '16:00', 'to' => 'PKX', 'arrival' => '20:00'],
],
];
data_get($flight, 'segments.{first}.arrival');
// 15:00
data_set()
data_set 함수는 "dot" 표기법을 사용하여 중첩된 배열이나 객체 내에 값을 설정합니다.
$data = ['products' => ['desk' => ['price' => 100]]];
data_set($data, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]
이 함수는 별표를 사용한 와일드카드도 받으며 대상에 값을 설정합니다.
$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],
],
]
*/
기본적으로 기존 값은 덮어씁니다. 값이 존재하지 않을 때만 설정하려면 네 번째 인수에 false를 전달하면 됩니다.
$data = ['products' => ['desk' => ['price' => 100]]];
data_set($data, 'products.desk.price', 200, overwrite: false);
// ['products' => ['desk' => ['price' => 100]]]
data_forget()
data_forget 함수는 "dot" 표기법을 사용하여 중첩된 배열이나 객체 내의 값을 제거합니다.
$data = ['products' => ['desk' => ['price' => 100]]];
data_forget($data, 'products.desk.price');
// ['products' => ['desk' => []]]
이 함수는 별표를 사용한 와일드카드도 받으며 대상에서 값을 제거합니다.
$data = [
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2', 'price' => 150],
],
];
data_forget($data, 'products.*.price');
/*
[
'products' => [
['name' => 'Desk 1'],
['name' => 'Desk 2'],
],
]
*/
head()
head 함수는 주어진 배열의 첫 번째 요소를 반환합니다. 배열이 비어 있으면 false가 반환됩니다.
$array = [100, 200, 300];
$first = head($array);
// 100
last()
last 함수는 주어진 배열의 마지막 요소를 반환합니다. 배열이 비어 있으면 false가 반환됩니다.
$array = [100, 200, 300];
$last = last($array);
// 300
숫자 (Numbers)
Number::abbreviate()
Number::abbreviate 메서드는 제공된 숫자 값을 단위 약어와 함께 사람이 읽기 쉬운 형식으로 반환합니다.
use Illuminate\Support\Number;
$number = Number::abbreviate(1000);
// 1K
$number = Number::abbreviate(489939);
// 490K
$number = Number::abbreviate(1230000, precision: 2);
// 1.23M
Number::clamp()
Number::clamp 메서드는 주어진 숫자가 지정된 범위 내에 있도록 보장합니다. 숫자가 최솟값보다 작으면 최솟값이 반환됩니다. 숫자가 최댓값보다 크면 최댓값이 반환됩니다.
use Illuminate\Support\Number;
$number = Number::clamp(105, min: 10, max: 100);
// 100
$number = Number::clamp(5, min: 10, max: 100);
// 10
$number = Number::clamp(10, min: 10, max: 100);
// 10
$number = Number::clamp(20, min: 10, max: 100);
// 20
Number::currency()
Number::currency 메서드는 주어진 값의 통화 표현을 문자열로 반환합니다.
use Illuminate\Support\Number;
$currency = Number::currency(1000);
// $1,000.00
$currency = Number::currency(1000, in: 'EUR');
// €1,000.00
$currency = Number::currency(1000, in: 'EUR', locale: 'de');
// 1.000,00 €
$currency = Number::currency(1000, in: 'EUR', locale: 'de', precision: 0);
// 1.000 €
Number::defaultCurrency()
Number::defaultCurrency 메서드는 Number 클래스에서 사용 중인 기본 통화를 반환합니다.
use Illuminate\Support\Number;
$currency = Number::defaultCurrency();
// USD
Number::defaultLocale()
Number::defaultLocale 메서드는 Number 클래스에서 사용 중인 기본 로케일을 반환합니다.
use Illuminate\Support\Number;
$locale = Number::defaultLocale();
// en
Number::fileSize()
Number::fileSize 메서드는 주어진 바이트 값의 파일 크기 표현을 문자열로 반환합니다.
use Illuminate\Support\Number;
$size = Number::fileSize(1024);
// 1 KB
$size = Number::fileSize(1024 * 1024);
// 1 MB
$size = Number::fileSize(1024, precision: 2);
// 1.00 KB
Number::forHumans()
Number::forHumans 메서드는 제공된 숫자 값을 사람이 읽기 쉬운 형식으로 반환합니다.
use Illuminate\Support\Number;
$number = Number::forHumans(1000);
// 1 thousand
$number = Number::forHumans(489939);
// 490 thousand
$number = Number::forHumans(1230000, precision: 2);
// 1.23 million
Number::format()
Number::format 메서드는 주어진 숫자를 로케일에 맞는 문자열로 포맷합니다.
use Illuminate\Support\Number;
$number = Number::format(100000);
// 100,000
$number = Number::format(100000, precision: 2);
// 100,000.00
$number = Number::format(100000.123, maxPrecision: 2);
// 100,000.12
$number = Number::format(100000, locale: 'de');
// 100.000
Number::ordinal()
Number::ordinal 메서드는 숫자의 서수 표현을 반환합니다.
use Illuminate\Support\Number;
$number = Number::ordinal(1);
// 1st
$number = Number::ordinal(2);
// 2nd
$number = Number::ordinal(21);
// 21st
Number::pairs()
Number::pairs 메서드는 지정된 범위와 단계 값을 기반으로 숫자 쌍(하위 범위) 배열을 생성합니다. 이 메서드는 페이지네이션이나 배치 작업과 같이 더 큰 숫자 범위를 관리하기 쉬운 작은 하위 범위로 나누는 데 유용합니다. pairs 메서드는 배열의 배열을 반환하며, 각 내부 배열은 숫자 쌍(하위 범위)을 나타냅니다.
use Illuminate\Support\Number;
$result = Number::pairs(25, 10);
// [[0, 9], [10, 19], [20, 25]]
$result = Number::pairs(25, 10, offset: 0);
// [[0, 10], [10, 20], [20, 25]]
Number::parseInt()
Number::parseInt 메서드는 지정된 로케일에 따라 문자열을 정수로 파싱합니다.
use Illuminate\Support\Number;
$result = Number::parseInt('10.123');
// (int) 10
$result = Number::parseInt('10,123', locale: 'fr');
// (int) 10
Number::parseFloat()
Number::parseFloat 메서드는 지정된 로케일에 따라 문자열을 부동 소수점 수로 파싱합니다.
use Illuminate\Support\Number;
$result = Number::parseFloat('10');
// (float) 10.0
$result = Number::parseFloat('10', locale: 'fr');
// (float) 10.0
Number::percentage()
Number::percentage 메서드는 주어진 값의 백분율 표현을 문자열로 반환합니다.
use Illuminate\Support\Number;
$percentage = Number::percentage(10);
// 10%
$percentage = Number::percentage(10, precision: 2);
// 10.00%
$percentage = Number::percentage(10.123, maxPrecision: 2);
// 10.12%
$percentage = Number::percentage(10, precision: 2, locale: 'de');
// 10,00%
Number::spell()
Number::spell 메서드는 주어진 숫자를 단어 문자열로 변환합니다.
use Illuminate\Support\Number;
$number = Number::spell(102);
// one hundred and two
$number = Number::spell(88, locale: 'fr');
// quatre-vingt-huit
after 인수를 사용하면 지정한 값 이후의 숫자만 단어로 표현하도록 할 수 있습니다.
$number = Number::spell(10, after: 10);
// 10
$number = Number::spell(11, after: 10);
// eleven
until 인수를 사용하면 지정한 값 이전의 숫자만 단어로 표현하도록 할 수 있습니다.
$number = Number::spell(5, until: 10);
// five
$number = Number::spell(10, until: 10);
// 10
Number::spellOrdinal()
Number::spellOrdinal 메서드는 숫자의 서수 표현을 단어 문자열로 반환합니다.
use Illuminate\Support\Number;
$number = Number::spellOrdinal(1);
// first
$number = Number::spellOrdinal(2);
// second
$number = Number::spellOrdinal(21);
// twenty-first
Number::trim()
Number::trim 메서드는 주어진 숫자의 소수점 이하 후행 0을 제거합니다.
use Illuminate\Support\Number;
$number = Number::trim(12.0);
// 12
$number = Number::trim(12.30);
// 12.3
Number::useLocale()
Number::useLocale 메서드는 기본 숫자 로케일을 전역으로 설정하며, 이후 Number 클래스의 메서드 호출 시 숫자와 통화의 형식에 영향을 줍니다.
use Illuminate\Support\Number;
/**
* Bootstrap any application services.
*/
public function boot(): void
{
Number::useLocale('de');
}
Number::withLocale()
Number::withLocale 메서드는 지정된 로케일을 사용하여 주어진 클로저를 실행한 후, 콜백 실행이 완료되면 원래 로케일을 복원합니다.
use Illuminate\Support\Number;
$number = Number::withLocale('de', function () {
return Number::format(1500);
});
Number::useCurrency()
Number::useCurrency 메서드는 기본 숫자 통화를 전역으로 설정하며, 이후 Number 클래스의 메서드 호출 시 통화 형식에 영향을 줍니다.
use Illuminate\Support\Number;
/**
* Bootstrap any application services.
*/
public function boot(): void
{
Number::useCurrency('GBP');
}
Number::withCurrency()
Number::withCurrency 메서드는 지정된 통화를 사용하여 주어진 클로저를 실행한 후, 콜백 실행이 완료되면 원래 통화를 복원합니다.
use Illuminate\Support\Number;
$number = Number::withCurrency('GBP', function () {
// ...
});
경로 (Paths)
app_path()
app_path 함수는 애플리케이션의 app 디렉토리에 대한 전체 경로를 반환합니다. app_path 함수를 사용하여 애플리케이션 디렉토리 내 파일의 전체 경로를 생성할 수도 있습니다.
$path = app_path();
$path = app_path('Http/Controllers/Controller.php');
base_path()
base_path 함수는 애플리케이션 루트 디렉토리의 전체 경로를 반환합니다. base_path 함수를 사용하여 프로젝트 루트 디렉토리 내 파일의 전체 경로를 생성할 수도 있습니다.
$path = base_path();
$path = base_path('vendor/bin');
config_path()
config_path 함수는 애플리케이션의 config 디렉토리에 대한 전체 경로를 반환합니다. config_path 함수를 사용하여 애플리케이션 설정 디렉토리 내 파일의 전체 경로를 생성할 수도 있습니다.
$path = config_path();
$path = config_path('app.php');
database_path()
database_path 함수는 애플리케이션의 database 디렉토리에 대한 전체 경로를 반환합니다. database_path 함수를 사용하여 데이터베이스 디렉토리 내 파일의 전체 경로를 생성할 수도 있습니다.
$path = database_path();
$path = database_path('factories/UserFactory.php');
lang_path()
lang_path 함수는 애플리케이션의 lang 디렉토리에 대한 전체 경로를 반환합니다. lang_path 함수를 사용하여 해당 디렉토리 내 파일의 전체 경로를 생성할 수도 있습니다.
$path = lang_path();
$path = lang_path('en/messages.php');
[!NOTE] 기본적으로 Laravel 애플리케이션 스켈레톤에는
lang디렉토리가 포함되어 있지 않습니다. Laravel의 언어 파일을 사용자 지정하려면lang:publishArtisan 명령어를 통해 퍼블리시할 수 있습니다.
public_path()
public_path 함수는 애플리케이션의 public 디렉토리에 대한 전체 경로를 반환합니다. public_path 함수를 사용하여 퍼블릭 디렉토리 내 파일의 전체 경로를 생성할 수도 있습니다.
$path = public_path();
$path = public_path('css/app.css');
resource_path()
resource_path 함수는 애플리케이션의 resources 디렉토리에 대한 전체 경로를 반환합니다. resource_path 함수를 사용하여 리소스 디렉토리 내 파일의 전체 경로를 생성할 수도 있습니다.
$path = resource_path();
$path = resource_path('sass/app.scss');
storage_path()
storage_path 함수는 애플리케이션의 storage 디렉토리에 대한 전체 경로를 반환합니다. storage_path 함수를 사용하여 스토리지 디렉토리 내 파일의 전체 경로를 생성할 수도 있습니다.
$path = storage_path();
$path = storage_path('app/file.txt');
URL (URL)
action()
action 함수는 주어진 컨트롤러 액션에 대한 URL을 생성합니다.
use App\Http\Controllers\HomeController;
$url = action([HomeController::class, 'index']);
메서드가 라우트 파라미터를 받는 경우, 두 번째 인수로 전달할 수 있습니다.
$url = action([UserController::class, 'profile'], ['id' => 1]);
asset()
asset 함수는 현재 요청의 스킴(HTTP 또는 HTTPS)을 사용하여 에셋의 URL을 생성합니다.
$url = asset('img/photo.jpg');
.env 파일에서 ASSET_URL 변수를 설정하여 에셋 URL 호스트를 구성할 수 있습니다. 이는 Amazon S3 또는 다른 CDN과 같은 외부 서비스에서 에셋을 호스팅하는 경우 유용합니다.
// ASSET_URL=http://example.com/assets
$url = asset('img/photo.jpg'); // http://example.com/assets/img/photo.jpg
route()
route 함수는 주어진 이름이 지정된 라우트에 대한 URL을 생성합니다.
$url = route('route.name');
라우트가 파라미터를 받는 경우, 함수의 두 번째 인수로 전달할 수 있습니다.
$url = route('route.name', ['id' => 1]);
기본적으로 route 함수는 절대 URL을 생성합니다. 상대 URL을 생성하려면 함수의 세 번째 인수로 false를 전달하면 됩니다.
$url = route('route.name', ['id' => 1], false);
secure_asset()
secure_asset 함수는 HTTPS를 사용하여 에셋의 URL을 생성합니다.
$url = secure_asset('img/photo.jpg');
secure_url()
secure_url 함수는 주어진 경로에 대한 전체 HTTPS URL을 생성합니다. 추가 URL 세그먼트는 함수의 두 번째 인수로 전달할 수 있습니다.
$url = secure_url('user/profile');
$url = secure_url('user/profile', [1]);
to_action()
to_action 함수는 주어진 컨트롤러 액션에 대한 리다이렉트 HTTP 응답을 생성합니다.
use App\Http\Controllers\UserController;
return to_action([UserController::class, 'show'], ['user' => 1]);
필요한 경우, 리다이렉트에 할당할 HTTP 상태 코드와 추가 응답 헤더를 to_action 메서드의 세 번째와 네 번째 인수로 전달할 수 있습니다.
return to_action(
[UserController::class, 'show'],
['user' => 1],
302,
['X-Framework' => 'Laravel']
);
to_route()
to_route 함수는 주어진 이름이 지정된 라우트에 대한 리다이렉트 HTTP 응답을 생성합니다.
return to_route('users.show', ['user' => 1]);
필요한 경우, 리다이렉트에 할당할 HTTP 상태 코드와 추가 응답 헤더를 to_route 메서드의 세 번째와 네 번째 인수로 전달할 수 있습니다.
return to_route('users.show', ['user' => 1], 302, ['X-Framework' => 'Laravel']);
uri()
uri 함수는 주어진 URI에 대한 플루언트 URI 인스턴스를 생성합니다.
$uri = uri('https://example.com')
->withPath('/users')
->withQuery(['page' => 1]);
uri 함수에 호출 가능한 컨트롤러와 메서드 쌍을 포함하는 배열을 전달하면, 해당 컨트롤러 메서드의 라우트 경로에 대한 Uri 인스턴스를 생성합니다.
use App\Http\Controllers\UserController;
$uri = uri([UserController::class, 'show'], ['user' => $user]);
컨트롤러가 인보커블(invokable)인 경우 컨트롤러 클래스명만 전달하면 됩니다.
use App\Http\Controllers\UserIndexController;
$uri = uri(UserIndexController::class);
uri 함수에 전달된 값이 이름이 지정된 라우트의 이름과 일치하면, 해당 라우트의 경로에 대한 Uri 인스턴스가 생성됩니다.
$uri = uri('users.show', ['user' => $user]);
url()
url 함수는 주어진 경로에 대한 전체 URL을 생성합니다.
$url = url('user/profile');
$url = url('user/profile', [1]);
경로가 제공되지 않으면 Illuminate\Routing\UrlGenerator 인스턴스가 반환됩니다.
$current = url()->current();
$full = url()->full();
$previous = url()->previous();
url 함수 사용에 대한 자세한 내용은 URL 생성 문서를 참고하세요.
기타 (Miscellaneous)
abort()
abort 함수는 예외 핸들러에 의해 렌더링될 HTTP 예외를 발생시킵니다.
abort(403);
예외 메시지와 브라우저로 전송할 커스텀 HTTP 응답 헤더를 제공할 수도 있습니다.
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();
필요한 경우, 접근할 가드 인스턴스를 지정할 수 있습니다.
$user = auth('admin')->user();
back()
back 함수는 사용자의 이전 위치로 리다이렉트 HTTP 응답을 생성합니다.
return back($status = 302, $headers = [], $fallback = '/');
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));
broadcast(new UserRegistered($user))->toOthers();
broadcast_if()
broadcast_if 함수는 주어진 불리언 표현식이 true로 평가되면 주어진 이벤트를 리스너에게 브로드캐스트합니다.
broadcast_if($user->isActive(), new UserRegistered($user));
broadcast_if($user->isActive(), new UserRegistered($user))->toOthers();
broadcast_unless()
broadcast_unless 함수는 주어진 불리언 표현식이 false로 평가되면 주어진 이벤트를 리스너에게 브로드캐스트합니다.
broadcast_unless($user->isBanned(), new UserRegistered($user));
broadcast_unless($user->isBanned(), new UserRegistered($user))->toOthers();
cache()
cache 함수는 캐시에서 값을 가져옵니다. 주어진 키가 캐시에 존재하지 않으면 선택적 기본값이 반환됩니다.
$value = cache('key');
$value = cache('key', 'default');
키/값 쌍의 배열을 함수에 전달하여 캐시에 항목을 추가할 수 있습니다. 캐시된 값이 유효한 것으로 간주되는 시간(초) 또는 기간도 전달해야 합니다.
cache(['key' => 'value'], 300);
cache(['key' => 'value'], now()->plus(seconds: 10));
class_uses_recursive()
class_uses_recursive 함수는 모든 부모 클래스가 사용하는 트레이트를 포함하여, 클래스가 사용하는 모든 트레이트를 반환합니다.
$traits = class_uses_recursive(App\Models\User::class);
collect()
collect 함수는 주어진 값으로 컬렉션 인스턴스를 생성합니다.
$collection = collect(['Taylor', 'Abigail']);
config()
config 함수는 설정 변수의 값을 가져옵니다. 설정 값은 파일 이름과 접근하려는 옵션을 포함하는 "점" 구문을 사용하여 접근할 수 있습니다. 설정 옵션이 존재하지 않으면 반환할 기본값을 지정할 수도 있습니다.
$value = config('app.timezone');
$value = config('app.timezone', $default);
런타임에 키/값 쌍의 배열을 전달하여 설정 변수를 설정할 수 있습니다. 그러나 이 함수는 현재 요청의 설정 값에만 영향을 미치며 실제 설정 값을 업데이트하지는 않습니다.
config(['app.debug' => true]);
context()
context 함수는 현재 컨텍스트에서 값을 가져옵니다. 컨텍스트 키가 존재하지 않으면 반환할 기본값을 제공할 수도 있습니다.
$value = context('trace_id');
$value = context('trace_id', $default);
키/값 쌍의 배열을 전달하여 컨텍스트 값을 설정할 수 있습니다.
use Illuminate\Support\Str;
context(['trace_id' => Str::uuid()->toString()]);
cookie()
cookie 함수는 새로운 쿠키 인스턴스를 생성합니다.
$cookie = cookie('name', 'value', $minutes);
csrf_field()
csrf_field 함수는 CSRF 토큰 값을 포함하는 HTML hidden 입력 필드를 생성합니다. 예를 들어, Blade 구문을 사용하면 다음과 같습니다.
{{ csrf_field() }}
csrf_token()
csrf_token 함수는 현재 CSRF 토큰 값을 가져옵니다.
$token = csrf_token();
decrypt()
decrypt 함수는 주어진 값을 복호화합니다. Crypt 파사드 대신 사용할 수 있습니다.
$password = decrypt($value);
decrypt의 반대는 encrypt 함수를 참고하세요.
dd()
dd 함수는 주어진 변수를 덤프하고 스크립트 실행을 종료합니다.
dd($value);
dd($value1, $value2, $value3, ...);
스크립트 실행을 중단하고 싶지 않다면, dump 함수를 대신 사용하세요.
dispatch()
dispatch 함수는 주어진 잡을 Laravel 잡 큐에 푸시합니다.
dispatch(new App\Jobs\SendEmails);
dispatch_sync()
dispatch_sync 함수는 주어진 잡을 sync 큐에 푸시하여 즉시 처리합니다.
dispatch_sync(new App\Jobs\SendEmails);
dump()
dump 함수는 주어진 변수를 덤프합니다.
dump($value);
dump($value1, $value2, $value3, ...);
변수를 덤프한 후 스크립트 실행을 중단하려면, dd 함수를 대신 사용하세요.
encrypt()
encrypt 함수는 주어진 값을 암호화합니다. Crypt 파사드 대신 사용할 수 있습니다.
$secret = encrypt('my-secret-value');
encrypt의 반대는 decrypt 함수를 참고하세요.
env()
env 함수는 환경 변수의 값을 가져오거나 기본값을 반환합니다.
$env = env('APP_ENV');
$env = env('APP_ENV', 'production');
[!WARNING] 배포 과정에서
config:cache명령어를 실행하는 경우, 설정 파일 내에서만env함수를 호출하는지 확인해야 합니다. 설정이 캐시되면.env파일이 로드되지 않으며,env함수의 모든 호출은 서버 수준 또는 시스템 수준 환경 변수와 같은 외부 환경 변수 또는null을 반환합니다.
event()
event 함수는 주어진 이벤트를 리스너에게 디스패치합니다.
event(new UserRegistered($user));
fake()
fake 함수는 컨테이너에서 Faker 싱글톤을 가져옵니다. 이 함수는 모델 팩토리, 데이터베이스 시딩, 테스트 및 프로토타입 뷰에서 가짜 데이터를 생성할 때 유용합니다.
@for ($i = 0; $i < 10; $i++)
<dl>
<dt>Name</dt>
<dd>{{ fake()->name() }}</dd>
<dt>Email</dt>
<dd>{{ fake()->unique()->safeEmail() }}</dd>
</dl>
@endfor
기본적으로 fake 함수는 config/app.php 설정 파일의 app.faker_locale 설정 옵션을 사용합니다. 일반적으로 이 설정 옵션은 APP_FAKER_LOCALE 환경 변수를 통해 설정됩니다. fake 함수에 로케일을 전달하여 로케일을 지정할 수도 있습니다. 각 로케일은 개별 싱글톤을 생성합니다.
fake('nl_NL')->name()
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]);
literal()
literal 함수는 주어진 이름 있는 인수를 프로퍼티로 가지는 새 stdClass 인스턴스를 생성합니다.
$obj = literal(
name: 'Joe',
languages: ['PHP', 'Ruby'],
);
$obj->name; // 'Joe'
$obj->languages; // ['PHP', 'Ruby']
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 입력 필드를 생성합니다. 예를 들어, Blade 구문을 사용하면 다음과 같습니다.
<form method="POST">
{{ method_field('DELETE') }}
</form>
now()
now 함수는 현재 시간에 대한 새 Illuminate\Support\Carbon 인스턴스를 생성합니다.
$now = now();
old()
old 함수는 세션에 플래시된 이전 입력 값을 가져옵니다.
$value = old('value');
$value = old('value', 'default');
old 함수의 두 번째 인수로 제공되는 "기본값"은 종종 Eloquent 모델의 속성이므로, Laravel에서는 Eloquent 모델 전체를 old 함수의 두 번째 인수로 전달할 수 있습니다. 이 경우 Laravel은 old 함수에 제공된 첫 번째 인수가 "기본값"으로 간주되어야 할 Eloquent 속성의 이름이라고 가정합니다.
{{ old('name', $user->name) }}
// Is equivalent to...
{{ old('name', $user) }}
once()
once 함수는 주어진 콜백을 실행하고 요청이 지속되는 동안 결과를 메모리에 캐시합니다. 동일한 콜백으로 once 함수를 이후에 호출하면 이전에 캐시된 결과를 반환합니다.
function random(): int
{
return once(function () {
return random_int(1, 1000);
});
}
random(); // 123
random(); // 123 (cached result)
random(); // 123 (cached result)
once 함수가 객체 인스턴스 내에서 실행되면, 캐시된 결과는 해당 객체 인스턴스에 고유합니다.
<?php
class NumberService
{
public function all(): array
{
return once(fn () => [1, 2, 3]);
}
}
$service = new NumberService;
$service->all();
$service->all(); // (cached result)
$secondService = new NumberService;
$secondService->all();
$secondService->all(); // (cached result)
optional()
optional 함수는 어떤 인수든 받아 해당 객체의 프로퍼티에 접근하거나 메서드를 호출할 수 있게 합니다. 주어진 객체가 null이면, 프로퍼티와 메서드는 에러를 발생시키는 대신 null을 반환합니다.
return optional($user->address)->street;
{!! old('name', optional($user)->name) !!}
optional 함수는 두 번째 인수로 클로저를 받을 수도 있습니다. 첫 번째 인수로 제공된 값이 null이 아닌 경우 클로저가 호출됩니다.
return optional(User::find($id), function (User $user) {
return $user->name;
});
policy()
policy 메서드는 주어진 클래스에 대한 정책 인스턴스를 가져옵니다.
$policy = policy(App\Models\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($e);
report 함수는 문자열을 인수로 받을 수도 있습니다. 문자열이 주어지면 해당 문자열을 메시지로 사용하여 예외를 생성합니다.
report('Something went wrong.');
report_if()
report_if 함수는 주어진 불리언 표현식이 true로 평가되면 예외 핸들러를 사용하여 예외를 보고합니다.
report_if($shouldReport, $e);
report_if($shouldReport, 'Something went wrong.');
report_unless()
report_unless 함수는 주어진 불리언 표현식이 false로 평가되면 예외 핸들러를 사용하여 예외를 보고합니다.
report_unless($reportingDisabled, $e);
report_unless($reportingDisabled, 'Something went wrong.');
request()
request 함수는 현재 요청 인스턴스를 반환하거나, 현재 요청에서 입력 필드의 값을 가져옵니다.
$request = request();
$value = request('key', $default);
rescue()
rescue 함수는 주어진 클로저를 실행하고 실행 중 발생하는 모든 예외를 잡습니다. 잡힌 모든 예외는 예외 핸들러로 전송되지만, 요청은 계속 처리됩니다.
return rescue(function () {
return $this->method();
});
rescue 함수에 두 번째 인수를 전달할 수도 있습니다. 이 인수는 클로저 실행 중 예외가 발생했을 때 반환될 "기본" 값입니다.
return rescue(function () {
return $this->method();
}, false);
return rescue(function () {
return $this->method();
}, function () {
return $this->failure();
});
report 인수를 rescue 함수에 제공하여 report 함수를 통해 예외를 보고할지 여부를 결정할 수 있습니다.
return rescue(function () {
return $this->method();
}, report: function (Throwable $throwable) {
return $throwable instanceof InvalidArgumentException;
});
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 between attempts...
}, 100);
시도 간 대기할 밀리초 수를 수동으로 계산하려면 retry 함수의 세 번째 인수로 클로저를 전달할 수 있습니다.
use Exception;
return retry(5, function () {
// ...
}, function (int $attempt, Exception $exception) {
return $attempt * 100;
});
편의를 위해 retry 함수의 첫 번째 인수로 배열을 제공할 수 있습니다. 이 배열은 이후 시도 간 대기할 밀리초 수를 결정하는 데 사용됩니다.
return retry([100, 200], function () {
// Sleep for 100ms on first retry, 200ms on second retry...
});
특정 조건에서만 재시도하려면 retry 함수의 네 번째 인수로 클로저를 전달할 수 있습니다.
use App\Exceptions\TemporaryException;
use Exception;
return retry(5, function () {
// ...
}, 100, function (Exception $exception) {
return $exception instanceof TemporaryException;
});
session()
session 함수는 세션 값을 가져오거나 설정하는 데 사용할 수 있습니다.
$value = session('key');
키/값 쌍의 배열을 함수에 전달하여 값을 설정할 수 있습니다.
session(['chairs' => 7, 'instruments' => 3]);
함수에 값을 전달하지 않으면 세션 저장소가 반환됩니다.
$value = session()->get('key');
session()->put('key', $value);
tap()
tap 함수는 두 개의 인수를 받습니다: 임의의 $value와 클로저. $value는 클로저에 전달된 후 tap 함수에 의해 반환됩니다. 클로저의 반환값은 무관합니다.
$user = tap(User::first(), function (User $user) {
$user->name = 'Taylor';
$user->save();
});
tap 함수에 클로저가 전달되지 않으면 주어진 $value의 모든 메서드를 호출할 수 있습니다. 호출하는 메서드의 반환값은 메서드가 실제로 정의에서 반환하는 것과 관계없이 항상 $value입니다. 예를 들어, Eloquent의 update 메서드는 일반적으로 정수를 반환하지만, tap 함수를 통해 update 메서드 호출을 체이닝하면 모델 자체를 반환하도록 강제할 수 있습니다.
$user = tap($user)->update([
'name' => $name,
'email' => $email,
]);
클래스에 tap 메서드를 추가하려면 Illuminate\Support\Traits\Tappable 트레이트를 클래스에 추가하면 됩니다. 이 트레이트의 tap 메서드는 클로저를 유일한 인수로 받습니다. 객체 인스턴스 자체가 클로저에 전달된 후 tap 메서드에 의해 반환됩니다.
return $user->tap(function (User $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 함수는 트레이트가 사용하는 모든 트레이트를 반환합니다.
$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);
transform()
transform 함수는 주어진 값이 빈 값이 아닌 경우 클로저를 실행하고 클로저의 반환값을 반환합니다.
$callback = function (int $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
value 함수에 추가 인수를 전달할 수 있습니다. 첫 번째 인수가 클로저인 경우 추가 파라미터가 클로저에 인수로 전달되며, 그렇지 않으면 무시됩니다.
$result = value(function (string $name) {
return $name;
}, 'Taylor');
// 'Taylor'
view()
view 함수는 뷰 인스턴스를 가져옵니다.
return view('auth.login');
with()
with 함수는 주어진 값을 반환합니다. 함수의 두 번째 인수로 클로저가 전달되면, 클로저가 실행되고 그 반환값이 반환됩니다.
$callback = function (mixed $value) {
return is_numeric($value) ? $value * 2 : 0;
};
$result = with(5, $callback);
// 10
$result = with(null, $callback);
// 0
$result = with(5, null);
// 5
when()
when 함수는 주어진 조건이 true로 평가되면 주어진 값을 반환합니다. 그렇지 않으면 null이 반환됩니다. 함수의 두 번째 인수로 클로저가 전달되면, 클로저가 실행되고 그 반환값이 반환됩니다.
$value = when(true, 'Hello World');
$value = when(true, fn () => 'Hello World');
when 함수는 주로 조건부로 HTML 속성을 렌더링할 때 유용합니다.
<div {!! when($condition, 'wire:poll="calculate"') !!}>
...
</div>
기타 유틸리티 (Other Utilities)
벤치마킹
때때로 애플리케이션의 특정 부분의 성능을 빠르게 테스트하고 싶을 수 있습니다. 이런 경우 Benchmark 지원 클래스를 사용하여 주어진 콜백이 완료되는 데 걸리는 밀리초를 측정할 수 있습니다.
<?php
use App\Models\User;
use Illuminate\Support\Benchmark;
Benchmark::dd(fn () => User::find(1)); // 0.1 ms
Benchmark::dd([
'Scenario 1' => fn () => User::count(), // 0.5 ms
'Scenario 2' => fn () => User::all()->count(), // 20.0 ms
]);
기본적으로 주어진 콜백은 한 번(1회 반복) 실행되며, 실행 시간은 브라우저/콘솔에 표시됩니다.
콜백을 두 번 이상 호출하려면 메서드의 두 번째 인수로 반복 횟수를 지정할 수 있습니다. 콜백을 두 번 이상 실행하면 Benchmark 클래스는 모든 반복에서 콜백을 실행하는 데 걸린 평균 밀리초를 반환합니다.
Benchmark::dd(fn () => User::count(), iterations: 10); // 0.5 ms
때때로 콜백의 반환값을 얻으면서 콜백의 실행 시간을 벤치마킹하고 싶을 수 있습니다. value 메서드는 콜백의 반환값과 콜백 실행에 걸린 밀리초를 포함하는 튜플을 반환합니다.
[$count, $duration] = Benchmark::value(fn () => User::count());
날짜와 시간
Laravel에는 강력한 날짜 및 시간 조작 라이브러리인 Carbon이 포함되어 있습니다. 새 Carbon 인스턴스를 생성하려면 now 함수를 호출하면 됩니다. 이 함수는 Laravel 애플리케이션 내에서 전역적으로 사용할 수 있습니다.
$now = now();
또는 Illuminate\Support\Carbon 클래스를 사용하여 새 Carbon 인스턴스를 생성할 수 있습니다.
use Illuminate\Support\Carbon;
$now = Carbon::now();
Laravel은 또한 Carbon 인스턴스에 plus와 minus 메서드를 추가하여 인스턴스의 날짜와 시간을 쉽게 조작할 수 있게 합니다.
return now()->plus(minutes: 5);
return now()->plus(hours: 8);
return now()->plus(weeks: 4);
return now()->minus(minutes: 5);
return now()->minus(hours: 8);
return now()->minus(weeks: 4);
Carbon과 그 기능에 대한 자세한 내용은 공식 Carbon 문서를 참고하세요.
인터벌 함수
Laravel은 PHP의 DateInterval 클래스를 확장하는 CarbonInterval 인스턴스를 반환하는 milliseconds, seconds, minutes, hours, days, weeks, months, years 함수도 제공합니다. 이 함수들은 Laravel이 DateInterval 인스턴스를 받는 곳이면 어디서든 사용할 수 있습니다.
use Illuminate\Support\Facades\Cache;
use function Illuminate\Support\{minutes};
Cache::put('metrics', $metrics, minutes(10));
지연 함수
Laravel의 큐 잡을 사용하면 백그라운드 처리를 위해 작업을 큐에 넣을 수 있지만, 때로는 장기 실행 큐 워커를 구성하거나 유지보수하지 않고도 간단한 작업을 지연시키고 싶을 수 있습니다.
지연 함수를 사용하면 HTTP 응답이 사용자에게 전송된 후까지 클로저의 실행을 미루어 애플리케이션이 빠르고 반응성 있게 느껴지도록 할 수 있습니다. 클로저의 실행을 지연시키려면 클로저를 Illuminate\Support\defer 함수에 전달하면 됩니다.
use App\Services\Metrics;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;
use function Illuminate\Support\defer;
Route::post('/orders', function (Request $request) {
// Create order...
defer(fn () => Metrics::reportOrder($order));
return $order;
});
기본적으로, 지연 함수는 Illuminate\Support\defer가 호출된 HTTP 응답, Artisan 명령어 또는 큐 잡이 성공적으로 완료되었을 때만 실행됩니다. 즉, 요청이 4xx 또는 5xx HTTP 응답을 반환하면 지연 함수는 실행되지 않습니다. 지연 함수가 항상 실행되도록 하려면 지연 함수에 always 메서드를 체이닝하면 됩니다.
defer(fn () => Metrics::reportOrder($order))->always();
[!WARNING] Swoole PHP 확장이 설치되어 있는 경우, Laravel의
defer함수가 Swoole 자체의 전역defer함수와 충돌하여 웹 서버 오류가 발생할 수 있습니다. Laravel의defer헬퍼를 명시적으로 네임스페이스를 지정하여 호출해야 합니다:use function Illuminate\Support\defer;
지연 함수 취소
지연 함수가 실행되기 전에 취소해야 하는 경우, forget 메서드를 사용하여 이름으로 함수를 취소할 수 있습니다. 지연 함수에 이름을 지정하려면 Illuminate\Support\defer 함수에 두 번째 인수를 전달하면 됩니다.
defer(fn () => Metrics::report(), 'reportMetrics');
defer()->forget('reportMetrics');
테스트에서 지연 함수 비활성화
테스트를 작성할 때 지연 함수를 비활성화하는 것이 유용할 수 있습니다. 테스트에서 withoutDefer를 호출하면 Laravel이 모든 지연 함수를 즉시 호출하도록 지시할 수 있습니다.
test('without defer', function () {
$this->withoutDefer();
// ...
});
use Tests\TestCase;
class ExampleTest extends TestCase
{
public function test_without_defer(): void
{
$this->withoutDefer();
// ...
}
}
테스트 케이스 내의 모든 테스트에 대해 지연 함수를 비활성화하려면 기본 TestCase 클래스의 setUp 메서드에서 withoutDefer 메서드를 호출하면 됩니다.
<?php
namespace Tests;
use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
abstract class TestCase extends BaseTestCase
{
protected function setUp(): void// [tl! add:start]
{
parent::setUp();
$this->withoutDefer();
}// [tl! add:end]
}
로터리
Laravel의 로터리 클래스는 주어진 확률에 따라 콜백을 실행하는 데 사용할 수 있습니다. 이는 들어오는 요청의 일정 비율에 대해서만 코드를 실행하고 싶을 때 특히 유용합니다.
use Illuminate\Support\Lottery;
Lottery::odds(1, 20)
->winner(fn () => $user->won())
->loser(fn () => $user->lost())
->choose();
Laravel의 로터리 클래스를 다른 Laravel 기능과 결합할 수 있습니다. 예를 들어, 느린 쿼리의 일부만 예외 핸들러에 보고하고 싶을 수 있습니다. 로터리 클래스는 호출 가능하므로, 콜러블을 받는 모든 메서드에 클래스 인스턴스를 전달할 수 있습니다.
use Carbon\CarbonInterval;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Lottery;
DB::whenQueryingForLongerThan(
CarbonInterval::seconds(2),
Lottery::odds(1, 100)->winner(fn () => report('Querying > 2 seconds.')),
);
로터리 테스트
Laravel은 애플리케이션의 로터리 호출을 쉽게 테스트할 수 있는 간단한 메서드를 제공합니다.
// Lottery will always win...
Lottery::alwaysWin();
// Lottery will always lose...
Lottery::alwaysLose();
// Lottery will win then lose, and finally return to normal behavior...
Lottery::fix([true, false]);
// Lottery will return to normal behavior...
Lottery::determineResultsNormally();
파이프라인
Laravel의 Pipeline 파사드는 주어진 입력을 일련의 인보커블 클래스, 클로저 또는 콜러블을 통해 "파이프"하는 편리한 방법을 제공합니다. 각 클래스에 입력을 검사하거나 수정하고 파이프라인의 다음 콜러블을 호출할 기회를 줍니다.
use Closure;
use App\Models\User;
use Illuminate\Support\Facades\Pipeline;
$user = Pipeline::send($user)
->through([
function (User $user, Closure $next) {
// ...
return $next($user);
},
function (User $user, Closure $next) {
// ...
return $next($user);
},
])
->then(fn (User $user) => $user);
보시다시피, 파이프라인의 각 인보커블 클래스 또는 클로저에는 입력과 $next 클로저가 제공됩니다. $next 클로저를 호출하면 파이프라인의 다음 콜러블이 호출됩니다. 눈치채셨겠지만, 이는 미들웨어와 매우 유사합니다.
파이프라인의 마지막 콜러블이 $next 클로저를 호출하면, then 메서드에 제공된 콜러블이 호출됩니다. 일반적으로 이 콜러블은 주어진 입력을 단순히 반환합니다. 편의를 위해, 입력이 처리된 후 단순히 반환하려면 thenReturn 메서드를 사용할 수 있습니다.
물론 앞서 설명한 것처럼 파이프라인에 클로저만 제공할 필요는 없습니다. 인보커블 클래스도 제공할 수 있습니다. 클래스 이름이 제공되면, Laravel의 서비스 컨테이너를 통해 클래스가 인스턴스화되어 인보커블 클래스에 의존성을 주입할 수 있습니다.
$user = Pipeline::send($user)
->through([
GenerateProfilePhoto::class,
ActivateSubscription::class,
SendWelcomeEmail::class,
])
->thenReturn();
withinTransaction 메서드를 파이프라인에서 호출하면 파이프라인의 모든 단계를 단일 데이터베이스 트랜잭션 내에서 자동으로 래핑할 수 있습니다.
$user = Pipeline::send($user)
->withinTransaction()
->through([
ProcessOrder::class,
TransferFunds::class,
UpdateInventory::class,
])
->thenReturn();
Sleep
Laravel의 Sleep 클래스는 PHP의 네이티브 sleep 및 usleep 함수에 대한 가벼운 래퍼로, 더 나은 테스트 가능성을 제공하면서 시간 작업을 위한 개발자 친화적인 API를 노출합니다.
use Illuminate\Support\Sleep;
$waiting = true;
while ($waiting) {
Sleep::for(1)->second();
$waiting = /* ... */;
}
Sleep 클래스는 다양한 시간 단위로 작업할 수 있는 여러 메서드를 제공합니다.
// Return a value after sleeping...
$result = Sleep::for(1)->second()->then(fn () => 1 + 1);
// Sleep while a given value is true...
Sleep::for(1)->second()->while(fn () => shouldKeepSleeping());
// Pause execution for 90 seconds...
Sleep::for(1.5)->minutes();
// Pause execution for 2 seconds...
Sleep::for(2)->seconds();
// Pause execution for 500 milliseconds...
Sleep::for(500)->milliseconds();
// Pause execution for 5,000 microseconds...
Sleep::for(5000)->microseconds();
// Pause execution until a given time...
Sleep::until(now()->plus(minutes: 1));
// Alias of PHP's native "sleep" function...
Sleep::sleep(2);
// Alias of PHP's native "usleep" function...
Sleep::usleep(5000);
시간 단위를 쉽게 조합하려면 and 메서드를 사용할 수 있습니다.
Sleep::for(1)->second()->and(10)->milliseconds();
Sleep 테스트
Sleep 클래스나 PHP의 네이티브 sleep 함수를 사용하는 코드를 테스트할 때, 테스트 실행이 일시 중지됩니다. 예상하시듯이 이렇게 되면 테스트 스위트가 상당히 느려집니다. 예를 들어, 다음 코드를 테스트한다고 가정해 보겠습니다.
$waiting = /* ... */;
$seconds = 1;
while ($waiting) {
Sleep::for($seconds++)->seconds();
$waiting = /* ... */;
}
일반적으로 이 코드를 테스트하면 최소 1초가 걸립니다. 다행히 Sleep 클래스는 테스트 스위트가 빠르게 유지되도록 sleep을 "페이크"할 수 있습니다.
it('waits until ready', function () {
Sleep::fake();
// ...
});
public function test_it_waits_until_ready()
{
Sleep::fake();
// ...
}
Sleep 클래스를 페이크하면 실제 실행 일시 중지가 우회되어 테스트가 상당히 빨라집니다.
Sleep 클래스가 페이크되면, 발생해야 하는 예상 "sleep"에 대해 어서션을 수행할 수 있습니다. 이를 설명하기 위해, 실행을 세 번 일시 중지하면서 각 일시 중지가 1초씩 증가하는 코드를 테스트한다고 가정해 보겠습니다. assertSequence 메서드를 사용하면, 테스트를 빠르게 유지하면서 코드가 적절한 시간 동안 "sleep"했는지 어서션할 수 있습니다.
it('checks if ready three times', function () {
Sleep::fake();
// ...
Sleep::assertSequence([
Sleep::for(1)->second(),
Sleep::for(2)->seconds(),
Sleep::for(3)->seconds(),
]);
}
public function test_it_checks_if_ready_three_times()
{
Sleep::fake();
// ...
Sleep::assertSequence([
Sleep::for(1)->second(),
Sleep::for(2)->seconds(),
Sleep::for(3)->seconds(),
]);
}
물론, Sleep 클래스는 테스트 시 사용할 수 있는 다양한 어서션을 제공합니다.
use Carbon\CarbonInterval as Duration;
use Illuminate\Support\Sleep;
// Assert that sleep was called 3 times...
Sleep::assertSleptTimes(3);
// Assert against the duration of sleep...
Sleep::assertSlept(function (Duration $duration): bool {
return /* ... */;
}, times: 1);
// Assert that the Sleep class was never invoked...
Sleep::assertNeverSlept();
// Assert that, even if Sleep was called, no execution paused occurred...
Sleep::assertInsomniac();
때때로 페이크 sleep이 발생할 때마다 액션을 수행하는 것이 유용할 수 있습니다. 이를 위해 whenFakingSleep 메서드에 콜백을 제공할 수 있습니다. 다음 예제에서는 Laravel의 시간 조작 헬퍼를 사용하여 각 sleep의 지속 시간만큼 시간을 즉시 진행합니다.
use Carbon\CarbonInterval as Duration;
$this->freezeTime();
Sleep::fake();
Sleep::whenFakingSleep(function (Duration $duration) {
// Progress time when faking sleep...
$this->travel($duration->totalMilliseconds)->milliseconds();
});
시간을 진행하는 것은 일반적인 요구 사항이므로, fake 메서드는 테스트 내에서 sleep할 때 Carbon을 동기화 상태로 유지하는 syncWithCarbon 인수를 받습니다.
Sleep::fake(syncWithCarbon: true);
$start = now();
Sleep::for(1)->second();
$start->diffForHumans(); // 1 second ago
Laravel은 내부적으로 실행을 일시 중지할 때마다 Sleep 클래스를 사용합니다. 예를 들어, retry 헬퍼는 sleep할 때 Sleep 클래스를 사용하므로, 해당 헬퍼를 사용할 때 테스트 가능성이 향상됩니다.
Timebox
Laravel의 Timebox 클래스는 주어진 콜백이 실제 실행이 더 빨리 완료되더라도 항상 고정된 시간 동안 실행되도록 보장합니다. 이는 공격자가 실행 시간의 변동을 악용하여 민감한 정보를 추론할 수 있는 암호화 작업 및 사용자 인증 검사에 특히 유용합니다.
실행이 고정된 시간을 초과하면 Timebox는 효과가 없습니다. 최악의 시나리오를 고려하여 충분히 긴 시간을 고정 시간으로 선택하는 것은 개발자의 몫입니다.
call 메서드는 클로저와 마이크로초 단위의 시간 제한을 받아 클로저를 실행하고 시간 제한에 도달할 때까지 대기합니다.
use Illuminate\Support\Timebox;
(new Timebox)->call(function ($timebox) {
// ...
}, microseconds: 10000);
클로저 내에서 예외가 발생하면, 이 클래스는 정의된 지연을 존중하고 지연 후에 예외를 다시 발생시킵니다.
URI
Laravel의 Uri 클래스는 URI를 생성하고 조작하기 위한 편리하고 플루언트한 인터페이스를 제공합니다. 이 클래스는 기본 League URI 패키지에서 제공하는 기능을 래핑하고 Laravel의 라우팅 시스템과 원활하게 통합됩니다.
정적 메서드를 사용하여 Uri 인스턴스를 쉽게 생성할 수 있습니다.
use App\Http\Controllers\UserController;
use App\Http\Controllers\InvokableController;
use Illuminate\Support\Uri;
// Generate a URI instance from the given string...
$uri = Uri::of('https://example.com/path');
// Generate URI instances to paths, named routes, or controller actions...
$uri = Uri::to('/dashboard');
$uri = Uri::route('users.show', ['user' => 1]);
$uri = Uri::signedRoute('users.show', ['user' => 1]);
$uri = Uri::temporarySignedRoute('user.index', now()->plus(minutes: 5));
$uri = Uri::action([UserController::class, 'index']);
$uri = Uri::action(InvokableController::class);
// Generate a URI instance from the current request URL...
$uri = $request->uri();
URI 인스턴스가 있으면 플루언트하게 수정할 수 있습니다.
$uri = Uri::of('https://example.com')
->withScheme('http')
->withHost('test.com')
->withPort(8000)
->withPath('/users')
->withQuery(['page' => 2])
->withFragment('section-1');
URI 검사
Uri 클래스를 사용하여 기본 URI의 다양한 구성 요소를 쉽게 검사할 수 있습니다.
$scheme = $uri->scheme();
$authority = $uri->authority();
$host = $uri->host();
$port = $uri->port();
$path = $uri->path();
$segments = $uri->pathSegments();
$query = $uri->query();
$fragment = $uri->fragment();
쿼리 스트링 조작
Uri 클래스는 URI의 쿼리 스트링을 조작하는 데 사용할 수 있는 여러 메서드를 제공합니다. withQuery 메서드는 기존 쿼리 스트링에 추가 쿼리 스트링 파라미터를 병합하는 데 사용할 수 있습니다.
$uri = $uri->withQuery(['sort' => 'name']);
withQueryIfMissing 메서드는 주어진 키가 쿼리 스트링에 이미 존재하지 않는 경우에만 추가 쿼리 스트링 파라미터를 기존 쿼리 스트링에 병합하는 데 사용할 수 있습니다.
$uri = $uri->withQueryIfMissing(['page' => 1]);
replaceQuery 메서드는 기존 쿼리 스트링을 새로운 것으로 완전히 교체하는 데 사용할 수 있습니다.
$uri = $uri->replaceQuery(['page' => 1]);
pushOntoQuery 메서드는 배열 값을 가진 쿼리 스트링 파라미터에 추가 파라미터를 푸시하는 데 사용할 수 있습니다.
$uri = $uri->pushOntoQuery('filter', ['active', 'pending']);
withoutQuery 메서드는 쿼리 스트링에서 파라미터를 제거하는 데 사용할 수 있습니다.
$uri = $uri->withoutQuery(['page']);
URI에서 응답 생성
redirect 메서드는 주어진 URI로의 RedirectResponse 인스턴스를 생성하는 데 사용할 수 있습니다.
$uri = Uri::of('https://example.com');
return $uri->redirect();
또는, 라우트나 컨트롤러 액션에서 Uri 인스턴스를 단순히 반환하면 반환된 URI로의 리다이렉트 응답이 자동으로 생성됩니다.
use Illuminate\Support\Facades\Route;
use Illuminate\Support\Uri;
Route::get('/redirect', function () {
return Uri::to('/index')
->withQuery(['sort' => 'name']);
});