헬퍼 함수들
시작하기
라라벨은 다양한 글로벌 "헬퍼" PHP 함수들을 포함하고 있습니다. 그 중 많은 기능은 프레임워크가 스스로 사용하지만 여러분의 애플리케이션에도 자유롭게 사용하실 수 있습니다.
사용 가능한 메소드
배열 & 객체
- 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
경로
문자열
- __
- class_basename
- e
- preg_replace_array
- Str::after
- Str::before
- Str::camel
- Str::contains
- Str::endsWith
- Str::finish
- Str::is
- Str::kebab
- Str::limit
- Str::orderedUuid
- Str::plural
- Str::random
- Str::replaceArray
- Str::replaceFirst
- Str::replaceLast
- Str::singular
- Str::slug
- Str::snake
- Str::start
- Str::startsWith
- Str::studly
- Str::title
- Str::uuid
- trans
- trans_choice
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
- throw_if
- throw_unless
- today
- trait_uses_recursive
- transform
- validator
- value
- view
- with
메소드 목록
배열 & 객체
Arr::add()
{#collection-method .first-collection-method}
Arr::add
메소드는 배열 내에 키가 존재하지 않는 경우 주어진 key/value 쌍을 배열에 추가합니다:
use Illuminate\Support\Arr;
$array = Arr::add(['name' => 'Desk'], 'price', 100);
// ['name' => 'Desk', 'price' => 100]
Arr::collapse()
{#collection-method}
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::divide()
{#collection-method}
Arr::divide
메소드는 주어진 배열에서 키(key)들을 담고 있는 배열과 값(value)들을 담고 있는 배열, 총 2개의 배열들을 반환합니다:
use Illuminate\Support\Arr;
[$keys, $values] = Arr::divide(['name' => 'Desk']);
// $keys: ['name']
// $values: ['Desk']
Arr::dot()
{#collection-method}
Arr::dot
메소드는 다차원 배열을 ‘점(.)’으로 배열 깊이를 표기하면서 단일 레벨의 배열로 만듭니다:
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$flattened = Arr::dot($array);
// ['products.desk.price' => 100]
Arr::except()
{#collection-method}
Arr::except
메소드는 주어진 키 / 값 쌍을 배열에서 제거합니다.
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100];
$filtered = Arr::except($array, ['price']);
// ['name' => 'Desk']
Arr::first()
{#collection-method}
Arr::first
메소드는 넘겨진 배열 중 주어진 조건을 만족하는 첫번째 요소를 반환합니다:
use Illuminate\Support\Arr;
$array = [100, 200, 300];
$first = Arr::first($array, function ($value, $key) {
return $value >= 150;
});
// 200
메소드에 세번째 파라미터로 기본 값을 지정할 수 있습니다. 배열의 어떠한 값도 조건을 통과하지 못했을 때 이 값이 반환됩니다:
use Illuminate\Support\Arr;
$first = Arr::first($array, $callback, $default);
Arr::flatten()
{#collection-method}
Arr::flatten
메소드는 다차원 배열을 단일 레벨의 1차원 배열로 만듭니다:
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$flattened = Arr::flatten($array);
// ['Joe', 'PHP', 'Ruby']
Arr::forget()
{#collection-method}
Arr::forget
메소드는 “점(.)”표기법을 사용하여 중첩 배열로부터 주어진 키/ 값 쌍을 제거합니다:
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::forget($array, 'products.desk');
// ['products' => []]
Arr::get()
{#collection-method}
Arr::get
메소드는 “점(.)”표기법으로 중첩 배열로부터 주어진 값을 찾습니다:
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$price = Arr::get($array, 'products.desk.price');
// 100
Arr::get
메소드는 특정 키를 찾지 못한 경우 반환되는 기본값을 지정할 수도 있습니다.
$discount = Arr::get($array, 'products.desk.discount', 0);
// 0
Arr::has()
{#collection-method}
Arr::has
메소드는 "점(.)" 표기를 이용하여 배열에 주어진 아이템 또는 아이템들이 존재하는지 확인합니다:
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()
{#collection-method}
Arr::last
메소드는 전달된 조건을 통과하는 아이템의 가장 마지막 요소를 반환합니다:
use Illuminate\Support\Arr;
$array = [100, 200, 300, 110];
$last = Arr::last($array, function ($value, $key) {
return $value >= 150;
});
// 300
메소드의 세번째 인자로 기본값을 전달할 수 있습니다. 이 값은 조건을 통과하는 값이 없을 때 반환됩니다:
use Illuminate\Support\Arr;
$last = Arr::last($array, $callback, $default);
Arr::only()
{#collection-method}
Arr::only
메소드는 특정한 키 / 값 쌍만을 배열로부터 반환합니다:
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
$slice = Arr::only($array, ['name', 'price']);
// ['name' => 'Desk', 'price' => 100]
Arr::pluck()
{#collection-method}
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()
{#collection-method}
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::pull()
{#collection-method}
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::random()
{#collection-method}
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::set()
{#collection-method}
Arr::set
메소드는 "점(.)" 표기법을 이용하여 중첩된 배열 내에 값을 설정합니다:
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::set($array, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]
Arr::sort()
{#collection-method}
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 ($value) {
return $value['name'];
}));
/*
[
['name' => 'Chair'],
['name' => 'Desk'],
['name' => 'Table'],
]
*/
Arr::sortRecursive()
{#collection-method}
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::where()
{#collection-method}
Arr::where
메소드는 주어진 클로져를 사용하여 배열을 필터링합니다:
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()
{#collection-method}
Arr::wrap
메소드는 주어진 값을 배열로 만듭니다. 만약 함수에 전달된 값이 배열이라면, 결과에는 변경사항이 없습니다:
use Illuminate\Support\Arr;
$string = 'Laravel';
$array = Arr::wrap($string);
// ['Laravel']
주어진 값이 null인 경우, 빈 배열이 반환됩니다:
use Illuminate\Support\Arr;
$nothing = null;
$array = Arr::wrap($nothing);
// []
data_fill()
{#collection-method}
data_fill
함수는 "점" 표기법을 사용하여 중첩된 배열 또는 객체 내부에 빠진 값을 채워넣습니다:
$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()
{#collection-method}
data_get
함수는 "점" 표기법을 사용하여 중첩된 배열 또는 객체 안에서 값을 조회합니다:
$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'];
data_set()
{#collection-method}
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, false);
// ['products' => ['desk' => ['price' => 100]]]
head()
{#collection-method}
head
함수는 배열의 첫번째 요소를 반환합니다:
$array = [100, 200, 300];
$first = head($array);
// 100
last()
{#collection-method}
last
함수는 배열의 마지막 요소를 반환합니다:
$array = [100, 200, 300];
$last = last($array);
// 300
경로
app_path()
{#collection-method}
app_path
함수는 app
디렉토리에 대한 절대 경로를 반환합니다. app_path
함수를 사용하면 애플리케이션 디렉토리에서 특정 파일의 절대 경로를 생성할 수도 있습니다:
$path = app_path();
$path = app_path('Http/Controllers/Controller.php');
base_path()
{#collection-method}
base_path
함수는 프로젝트의 루트 디렉토리에 대한 절대 경로를 반환합니다. base_path
함수를 사용하여 프로젝트 루트 디렉토리에 대한 특정 파일의 절대 경로를 생성할 수도 있습니다:
$path = base_path();
$path = base_path('vendor/bin');
config_path()
{#collection-method}
config_path
함수는 애플리케이션의 config
디렉토리에 대한 절대 경로를 반환합니다. config_path
함수를 사용하여, 애플리케이션의 설정 디렉토리 안에 있는 파일에 대한 절대 경로를 생성할 수도 있습니다:
$path = config_path();
$path = config_path('app.php');
database_path()
{#collection-method}
database_path
함수는 애플리케이션의 database
디렉토리에 대한 절대 경로를 반환합니다. database_path
함수를 사용하여, 애플리케이션의 데이터베이스 디렉토리 안에 있는 파일에 대한 절대 경로를 생성할 수도 있습니다:
$path = database_path();
$path = database_path('factories/UserFactory.php');
mix()
{#collection-method}
mix
함수는 버전이 지정된 Mix 파일에 대한 경로를 반환합니다:
$path = mix('css/app.css');
public_path()
{#collection-method}
public_path
함수는 public
디렉토리에 대한 절대경로를 반환합니다. public_path
함수를 사용하여, 애플리케이션의 public 디렉토리 안에 있는 파일에 대한 절대 경로를 생성할 수도 있습니다:
$path = public_path();
$path = public_path('css/app.css');
resource_path()
{#collection-method}
resource_path
함수는 resources
디렉토리에 대한 절대경로를 반환합니다. resource_path
함수를 사용하여 리소스 디렉토리 안에 있는 파일에 대한 절대 경로를 생성할 수도 있습니다:
$path = resource_path();
$path = resource_path('sass/app.scss');
storage_path()
{#collection-method}
storage_path
함수는 storage
디렉토리에 대한 절대경로를 반환합니다. storage_path
함수를 사용하여 스토리지 디렉토리 안에 있는 파일에 대한 절대 경로를 생성할 수도 있습니다:
$path = storage_path();
$path = storage_path('app/file.txt');
문자열
__()
{#collection-method}
__
함수는 주어진 다국어 문자열 또는 다국어 키를 다국어 파일을 사용하여 변환합니다:
echo __('Welcome to our application');
echo __('messages.welcome');
지정된 다국어 문자열이나 키가 존재하지 않는 경우, __
함수는 주어진 값을 그대로 반환합니다. 따라서 예제와 같이 __
함수는 다국어 키가 존재하지 않는다면 messages.welcome
를 그대로 반환합니다.
class_basename()
{#collection-method}
class_basename
함수는 클래스의 네임스페이스를 제거한 클래스의 클래스 명을 반환합니다:
$class = class_basename('Foo\Bar\Baz');
// Baz
e()
{#collection-method}
e
함수는 주어진 문자열에 PHP의 htmlspecialchars
함수를 duuble_encode
옵션이 기본적으로 true
인 형태로 실행한 결과를 반환합니다:
echo e('<html>foo</html>');
// <html>foo</html>
preg_replace_array()
{#collection-method}
preg_replace_array
함수는 주어진 패턴에 맞는 문자열을 순차적으로 배열으로 교체합니다:
$string = 'The event will take place between :start and :end';
$replaced = preg_replace_array('/:[a-z_]+/', ['8:30', '9:00'], $string);
// The event will take place between 8:30 and 9:00
Str::after()
{#collection-method}
Str::after
메소드는 문자열에서 주어진 문자열 다음의 모든 값을 반환합니다:
use Illuminate\Support\Str;
$slice = Str::after('This is my name', 'This is');
// ' my name'
Str::before()
{#collection-method}
Str::before
메소드는 문자열에 주어진 문자열 이전의 모든 값을 반환합니다:
use Illuminate\Support\Str;
$slice = Str::before('This is my name', 'my name');
// 'This is '
Str::camel()
{#collection-method}
Str::camel
메소드는 주어진 문자열을 camelCase
형태로 변환합니다:
use Illuminate\Support\Str;
$converted = Str::camel('foo_bar');
// fooBar
Str::contains()
{#collection-method}
Str::contains
메소드는 주어진 문자열이 특정 문자열을 포함하는지 판별합니다 (대소문자를 구분합니다):
$contains = Str::contains('This is my name', 'my');
// true
또한 주어진 문자열이 특정 문자열을 포함하고 있는지 판별하기 위한 배열을 전달할 수도 있습니다:
use Illuminate\Support\Str;
$contains = Str::contains('This is my name', ['my', 'foo']);
// true
Str::containsAll()
{#collection-method}
Str::containsAll
메소드는 주어진 모든 문자열이 배열 값에 포함되어 있는지를 확인합니다.
use Illuminate\Support\Str;
$containsAll = Str::containsAll('This is my name', ['my', 'name']);
// true
Str::endsWith()
{#collection-method}
Str::endsWith
메소드는 주어진 문자열이 특정 값으로 끝나는지 알아냅니다:
$result = Str::endsWith('This is my name', 'name');
// true
Str::finish()
{#collection-method}
Str::finish
메소드는 문자열이 주어진 값으로 끝나지 않는다면 해당 값을 추가합니다:
use Illuminate\Support\Str;
$adjusted = Str::finish('this/string', '/');
// this/string/
$adjusted = Str::finish('this/string/', '/');
// this/string/
Str::is()
{#collection-method}
Str::is
메소드는 주어진 문자열이 주어진 패턴과 대응되는지 확인합니다. 와일드카드를 표시하기 위해 별표를 사용할 수 있습니다:
use Illuminate\Support\Str;
$matches = Str::is('foo*', 'foobar');
// true
$matches = Str::is('baz*', 'foobar');
// false
Str::kebab()
{#collection-method}
Str::kebab
메소드는 주어진 문자열을 kebab-case
로 변환합니다:
(역자주 : 단어와 단어를 '-'로 연결한 형태)
use Illuminate\Support\Str;
$converted = Str::kebab('fooBar');
// foo-bar
Str::limit()
{#collection-method}
Str::limit
메소드는 주어진 문자열을 지정된 길이로 제한합니다:
use Illuminate\Support\Str;
$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20);
// The quick brown fox...
변경될 문자열의 마지막에 덧붙일 문자열을 세번째 인자로 전달할 수도 있습니다:
use Illuminate\Support\Str;
$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20, ' (...)');
// The quick brown fox (...)
Str::orderedUuid()
{#collection-method}
Str::orderedUuid
메소드는 인덱싱된 데이터베이스 컬럼에 효과적으로 저장될 수 있도록 "타임스탬프와 같은 정렬이 가능한" UUID를 생성합니다.
(역자주 : 이 헬퍼 메소드의 결과로 생성되는 UUID의 첫번째 부분은 시간에 따라서 증감하는 형태를 보입니다)
use Illuminate\Support\Str;
return (string) Str::orderedUuid();
Str::plural()
{#collection-method}
Str::plural
메소드는 문자열을 복수형태로 변환합니다. 이 함수는 현재 영어에만 적용 가능합니다:
use Illuminate\Support\Str;
$plural = Str::plural('car');
// cars
$plural = Str::plural('child');
// children
문자열의 단일 혹은 복수 형태를 조회하기 위해서, 함수의 두번째 인자로 정수를 전달할 수 있습니다:
use Illuminate\Support\Str;
$plural = Str::plural('child', 2);
// children
$plural = Str::plural('child', 1);
// child
Str::random()
{#collection-method}
Str::random
메소드는 지정된 길이의 문자열을 무작위로 생성합니다. 이 함수는 PHP의 random_bytes
함수를 사용합니다:
use Illuminate\Support\Str;
$random = Str::random(40);
Str::replaceArray()
{#collection-method}
Str::replaceArray
메소드는 주어진 값을 순차적으로 배열값으로 치환합니다:
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()
{#collection-method}
Str::replaceFirst
메소드는 문자열에서 주어진 값이 발견된 첫번째 부분을 교체합니다:
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()
{#collection-method}
Str::replaceLast
메소드는 문자열에서 주어진 값이 발견된 마지막 부분을 교체합니다:
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()
{#collection-method}
Str::singular
메소드는 문자열을 단수 형태로 변환합니다. 이 기능는 현재 영어에만 적용 가능합니다:
use Illuminate\Support\Str;
$singular = Str::singular('cars');
// car
$singular = Str::singular('children');
// child
Str::slug()
{#collection-method}
Str::slug
메소드는 주어진 문자열로부터 URL에 알맞은 "slug"를 생성합니다:
use Illuminate\Support\Str;
$slug = Str::slug('Laravel 5 Framework', '-');
// laravel-5-framework
Str::snake()
{#collection-method}
Str::snake
메소드는 주어진 문자열을 snake_case
형태로 변환합니다:
use Illuminate\Support\Str;
$converted = Str::snake('fooBar');
// foo_bar
Str::start()
{#collection-method}
Str::start
메소드는 문자열이 주어진 값으로 시작하지 않은 경우에 이를 추가합니다:
use Illuminate\Support\Str;
$adjusted = Str::start('this/string', '/');
// /this/string
$adjusted = Str::start('/this/string', '/');
// /this/string
Str::startsWith()
{#collection-method}
Str::startsWith
메소드는 문자열이 주어진 문자열으로 시작하는지 판별합니다:
use Illuminate\Support\Str;
$result = Str::startsWith('This is my name', 'This');
// true
Str::studly()
{#collection-method}
Str::studly
메소드는 주어진 문자열을 StudlyCase
형태로 변환합니다:
use Illuminate\Support\Str;
$converted = Str::studly('foo_bar');
// FooBar
Str::title()
{#collection-method}
Str::title
메소드는 주어진 문자열을 Title Case
로 변환합니다(단어별로 앞글자를 대문자, 단어 사이를 공백이 포함되는 형태):
use Illuminate\Support\Str;
$converted = Str::title('a nice title uses the correct case');
// A Nice Title Uses The Correct Case
Str::uuid()
{#collection-method}
Str::uuid
메소드는 UUID (version 4)를 생성합니다:
use Illuminate\Support\Str;
return (string) Str::uuid();
trans()
{#collection-method}
trans
함수는 다국어 파일을 이용하여 주어진 다국어 키를 변환합니다:
echo trans('messages.welcome');
지정된 다국어 키가 존재하지 않는다면, trans
함수는 주어진 키를 반환합니다. 따라서 예제에서 다국어 키가 존재하지 않는다면 trans
함수는 messages.welcome
를 그대로 반환합니다.
trans_choice()
{#collection-method}
trans_choice
함수는 주어진, 수량(단수, 복수 처리)을 이용하여 주어진 다국어 키를 번역합니다:
echo trans_choice('messages.notifications', $unreadCount);
지정된 다국어 키가 존재하지 않는다면, trans_choice
함수는 주어진 키를 반환합니다. 따라서 예제에서 다국어 키가 존재하지 않는다면 trans_choice
함수는 messages.notifications
를 그대로 반환합니다.
URLs
action()
{#collection-method}
action
함수는 주어진 컨트롤러 메소드로 URL을 생성합니다. 컨트롤러의 전체 네임스페이스를 전달하지 않아도 됩니다. 대신, App\Http\Controllers
네임스페이스에 따른 컨트롤러 클래스 이름을 전달하면 됩니다.:
$url = action('HomeController@index');
$url = action([HomeController::class, 'index']);
메소드가 라우트 파라미터를 받아들인다면, 두번째 인자로 메소드에 전달하십시오:
$url = action('UserController@profile', ['id' => 1]);
asset()
{#collection-method}
asset
함수는 HTTP요청의 현재 scheme(HTTP나 HTTPS)을 이용하여 asset을 사용하기 위한 URL을 생성합니다:
$url = asset('img/photo.jpg');
.env
파일에 ASSET_URL
변수를 설정하여 asset의 URL 호스트를 설정할 수 있습니다. 이는 Amazon S3와 같은 외부 서비스에서 asset을 호스팅하는 경우 유용 할 수 있습니다.
// ASSET_URL=http://example.com/assets
$url = asset('img/photo.jpg'); // http://example.com/assets/img/photo.jpg
route()
{#collection-method}
route
함수는 주어진 라우트 이름으로 URL을 생성합니다:
$url = route('routeName');
라우트가 파라미터를 가진다면 파라미터를 두번째 인자로 메소드에 전달하세요:
$url = route('routeName', ['id' => 1]);
기본적으로 route
함수는 절대경로 URL을 생성합니다. 만약 상태경로의 URL을 생성하려면 세번째 인자를 false
로 전달하면 됩니다:
$url = route('routeName', ['id' => 1], false);
secure_asset()
{#collection-method}
secure_asset
함수는 HTTPS를 이용하여 asset을 사용하기 위한 URL을 생성합니다:
$url = secure_asset('img/photo.jpg');
secure_url()
{#collection-method}
secure_url
함수는 주어진 경로에 대한 전체 HTTPS URL을 생성합니다:
$url = secure_url('user/profile');
$url = secure_url('user/profile', [1]);
url()
{#collection-method}
url
함수는 주어진 경로에 대한 전체 URL을 생성합니다:
$url = url('user/profile');
$url = url('user/profile', [1]);
경로를 전달하지 않으면, Illuminate\Routing\UrlGenerator
인스턴스가 반환됩니다:
$current = url()->current();
$full = url()->full();
$previous = url()->previous();
기타 함수들
abort()
{#collection-method}
abort
함수는 Exception 핸들러에 의해서 렌더링 될 수 있는 HTTP exception을 발생시킵니다:
abort(403);
exception 의 응답 텍스트를 제공하거나, 커스텀 헤더를 지정할 수도 있습니다:
abort(403, 'Unauthorized.', $headers);
abort_if()
{#collection-method}
abort_if
함수는 주어진 조건식이 true
일때 HTTP exception을 발생시킵니다:
abort_if(! Auth::user()->isAdmin(), 403);
abort
메소드와 같이, exception 의 응답 텍스트를 세번째 인자로 전달할 수 있으며, 네번째 인자로 커스텀 응답 헤더를 전달할 수도 있습니다.
abort_unless()
{#collection-method}
abort_unless
함수는 주어진 조건식이 false
일때 HTTP exception 을 발생시킵니다:
abort_unless(Auth::user()->isAdmin(), 403);
abort
메소드와 같이, exception 의 응답 텍스트를 세번째 인자로 전달할 수 있으며, 네번째 인자로 커스텀 응답 헤더를 전달할 수도 있습니다.
app()
{#collection-method}
app
함수는 서비스 컨테이너 인스턴스를 반환합니다:
$container = app();
컨테이너에 의존성을 해결하고자 하는 클래스나 인터페이스의 이름을 전달할 수도 있습니다:
$api = app('HelpSpot\API');
auth()
{#collection-method}
auth
함수는 authenticator 인스턴스를 반환합니다. 편의를 위하여 Auth
파사드 대신 이용할 수 있습니다:
$user = auth()->user();
필요한 경우, 어떤 guard 인스턴스를 사용할지 지정할 수 있습니다:
$user = auth('admin')->user();
back()
{#collection-method}
back()
함수는 사용자의 이전 위치로 리다이렉트 HTTP response-응답을 생성합니다:
return back($status = 302, $headers = [], $fallback = false);
return back();
bcrypt()
{#collection-method}
bcrypt
함수는 Bcrypt를 이용하여 주어진 값을 해시 처리합니다. Hash
파사드 대신 사용할 수 있습니다:
$password = bcrypt('my-secret-password');
blank()
{#collection-method}
blank
함수는 주어진 값이 "빈값"인지 판단하여 결과를 반환합니다:
blank('');
blank(' ');
blank(null);
blank(collect());
// true
blank(0);
blank(true);
blank(false);
// false
blank
의 반대는, filled
메소드를 참고하십시오.
broadcast()
{#collection-method}
broadcast
함수는 주어진 이벤트를 리스너들에게 broadcasts 합니다:
broadcast(new UserRegistered($user));
cache()
{#collection-method}
cache
함수는 캐시로 부터 값을 가져오는데 사용할 수 있습니다. 캐시에서 주어진 키가 존재하지 않는 경우, 옵션으로 전달된 기본값(두번째인자)가 반환됩니다
$value = cache('key');
$value = cache('key', 'default');
함수에 키 / 값으로 된 배열을 전달하여 캐시에 아이템을 추가할 수 있습니다. 또한 캐시에 값이 얼마나 유지되어야 하는지에 대한 시간(초)을 숫자로 전달할 수도 있습니다.
cache(['key' => 'value'], 300);
cache(['key' => 'value'], now()->addSeconds(10));
class_uses_recursive()
{#collection-method}
class_uses_recursive
함수는 모든 부모 클래스가 사용하는 trait를 포함하여 클래스가 사용하는 모든 trait을 반환합니다:
$traits = class_uses_recursive(App\User::class);
collect()
{#collection-method}
collect
함수는 주어진 값으로부터 collection 인스턴스를 생성합니다:
$collection = collect(['taylor', 'abigail']);
config()
{#collection-method}
config
함수는 설정 변수의 값을 가져옵니다. 설정 값은 파일명과 접근하고자 하는 옵션을 포함하는 "점(.)" 문법(syntax)를 사용하여 접근할 수 있습니다. 설정 옵션이 존재하지 않는다면 지정된 기본값이 반환됩니다:
$value = config('app.timezone');
$value = config('app.timezone', $default);
런타임에 설정 값을 키 / 값 형태로 전달하여 값을 설정할 수도 있습니다:
config(['app.debug' => true]);
cookie()
{#collection-method}
cookie
함수는 새로운 쿠키 인스턴스를 생성합니다:
$cookie = cookie('name', 'value', $minutes);
csrf_field()
{#collection-method}
csrf_field
함수는 CSRF 토큰 값을 포함하는 HTML hidden
Input 필드를 생성합니다. 예를 들어 Blade syntax에서 사용할 수 있습니다:
{{ csrf_field() }}
csrf_token()
{#collection-method}
csrf_token
함수는 현재 CSRF 토큰의 값을 조회합니다:
$token = csrf_token();
dd()
{#collection-method}
dd
함수는 주어진 변수들을 Dump 처리하고 스크립트의 실행을 중단합니다:
dd($value);
dd($value1, $value2, $value3, ...);
스크립트 실행을 중단하고 싶지 않다면, dump
함수를 사용하십시오:
decrypt()
{#collection-method}
decrypt
함수는 라라벨의 encrypter를 사용하여 주어진 값을 복호화 합니다:
$decrypted = decrypt($encrypted_value);
dispatch()
{#collection-method}
dispatch
함수는 라라벨의 job queue에 주어진 job을 추가합니다:
dispatch(new App\Jobs\SendEmails);
dispatch_now()
{#collection-method}
dispatch_now
함수는 주어진 job을 즉시 실행하고 handle
메소드의 값을 반환합니다:
$result = dispatch_now(new App\Jobs\SendEmails);
dump()
{#collection-method}
dump
함수는 주어진 변수의 값을 덤프하여 표시합니다:
dump($value);
dump($value1, $value2, $value3, ...);
변수읙 값을 표시한 다음에 스크립트의 실행을 멈추고자 한다면, dd
함수를 사용하십시오.
{tip} Artisan의
dump-server
명령을 사용하여 모든dump
호출을 차단하고 브라우저 대신 콘솔 창에 표시 할 수 있습니다.
encrypt()
{#collection-method}
encrypt
함수는 라라벨의 encrypter를 사용하여 주어진 값을 암호화합니다:
$encrypted = encrypt($unencrypted_value);
env()
{#collection-method}
env
함수는 환경변수의 값을 가져오거나 기본값을 조회합니다:
$env = env('APP_ENV');
// Returns 'production' if APP_ENV is not set...
$env = env('APP_ENV', 'production');
{note} 배포과정에서
config:cache
명령어를 실행했다면, 설정 파일안에서env
함수를 호출한 부분이 있는지 확인해야 합니다. 설정이 캐싱되고 나면,.env
파일은 로드하지 않고, 모든env
함수는null
을 반환합니다.
event()
{#collection-method}
event
함수는 주어진 event를 리스너들에게 보냅니다:
event(new UserRegistered($user));
factory()
{#collection-method}
factory
함수는 주어진 클래스, 이름, 양을 위한 모델 팩토리 빌더를 생성합니다. testing이나 seeding 중에 이용할 수 있습니다:
$user = factory(App\User::class)->make();
filled()
{#collection-method}
filled
함수는 주어진 값이 "빈값"이 아닌지 판별하여 결과를 반환합니다:
filled(0);
filled(true);
filled(false);
// true
filled('');
filled(' ');
filled(null);
filled(collect());
// false
filled
의 반대는, blank
메소드를 확인하십시오.
info()
{#collection-method}
info
함수는 로그에 정보를 기록합니다:
info('Some helpful information!');
문맥에대한 데이터를 함수에 배열로 전달할 수도 있습니다:
info('User login attempt failed.', ['id' => $user->id]);
logger()
{#collection-method}
logger
함수는 로그에 debug
로그 레벨을 기록하는데 사용합니다:
logger('Debug message');
문맥에대한 데이터를 함수에 배열로 전달할 수도 있습니다:
logger('User has logged in.', ['id' => $user->id]);
함수에 아무런 값이 전달되지 않으면 logger 인스턴스가 반환됩니다:
logger()->error('You are not allowed here.');
method_field()
{#collection-method}
method_field
함수는 HTTP 메소드 형식의 가짜(spoof) 값을 포함하는 HTML hidden
Input 필드를 생성합니다. 예를 들어 Blade syntax에서 사용할 수 있습니다:
<form method="POST">
{{ method_field('DELETE') }}
</form>
now()
{#collection-method}
now
함수는 현재 시간을 기반으로한 Illuminate\Support\Carbon
인스턴스를 생성합니다:
$now = now();
old()
{#collection-method}
old
함수는 세션에 저장된 이전 입력값(flashed)을 조회합니다:
$value = old('value');
$value = old('value', 'default');
optional()
{#collection-method}
optional
함수는 인자를 전달받아 해당 객체의 프로퍼티에 엑세스 하거나, 메소드를 호출할 수 있도록 합니다. 지정된 객체가 null
이라면, 프로퍼티와 메소드는 에러를 유발하는 대신에 null
을 반환합니다:
return optional($user->address)->street;
{!! old('name', optional($user)->name) !!}
optional
함수는 두번째 인자로 클로저를 받을 수 있습니다. 첫번째 인자가 null
이 아닌경우, 클로저가 호출됩니다:
return optional(User::find($id), function ($user) {
return new DummyUser;
});
policy()
{#collection-method}
policy
메소도는 주어진 클래스를 위한 policy 인스턴스를 조회합니다:
$policy = policy(App\User::class);
redirect()
{#collection-method}
redirect
함수는 리다이렉트 HTTP response-응답을 반환하거나, 인자 없이 호출되는 경우 리디렉터 인스턴스를 반환합니다:
return redirect($to = null, $status = 302, $headers = [], $secure = null);
return redirect('/home');
return redirect()->route('route.name');
report()
{#collection-method}
report
함수는 exception 핸들러의 report
메소드를 사용하여 exception-예외를 보고합니다:
report($e);
request()
{#collection-method}
request
함수는 현재의 요청 인스턴스를 반환하거나 입력 아이템을 가져옵니다:
$request = request();
$value = request('key', $default);
rescue()
{#collection-method}
rescue
함수는 주어진 클로저를 실행하고, 실행중 발생하는 예외-exception을 받아냅니다. catch 된 모든 예외-exception은 exception 핸들러의 report
메소드로 전달되지만, request-요청 에 대한 처리는 계속됩니다:
return rescue(function () {
return $this->method();
});
rescue
함수에는 두번째 인자를 전달 할 수 있는데, 이 인자는 클로저를 실행하는 동안 예외-exception가 발생하면 반환된 "기본값" 입니다:
return rescue(function () {
return $this->method();
}, false);
return rescue(function () {
return $this->method();
}, function () {
return $this->failure();
});
resolve()
{#collection-method}
resolve
함수는 서비스 컨테이너를 사용하여 주어진 클래스 또는 인터페이스를 의존성 해결하여 인스턴스를 반환합니다:
$api = resolve('HelpSpot\API');
response()
{#collection-method}
response
함수는 응답 인스턴스를 생성하거나 응답 팩토리의 인스턴스를 가져옵니다:
return response('Hello World', 200, $headers);
return response()->json(['foo' => 'bar'], 200, $headers);
retry()
{#collection-method}
retry
함수는 주어진 최대 횟수가 될 때까지 주어진 콜백을 실행하려고 시도합니다. 콜백이 예외-exception를 던지지 않는다면, 결과 값이 반환됩니다. 콜백이 예외-exception를 던지면 자동으로 다시 시도됩니다. 최대 재시도 횟수를 초과하면 예외가 던져집니다.
return retry(5, function () {
// Attempt 5 times while resting 100ms in between attempts...
}, 100);
session()
{#collection-method}
session
함수는 세션 값을 얻거나 지정하는 데에 사용할 수 있습니다.
$value = session('key');
키 / 값 쌍들의 배열을 함수로 전달하여 값을 설정할 수 있습니다:
session(['chairs' => 7, 'instruments' => 3]);
함수에 아무런 값도 전달되지 않는다면 세션 스토어가 반환됩니다:
$value = session()->get('key');
session()->put('key', $value);
tap()
{#collection-method}
tap
함수는 임의의 $value
와 클로저 두개의 인자를 받아들입니다. $value
는 클로저에 전달되어 tap
함수에 의해서 반환됩니다. 반환되는 값은 클로저와 무관합니다:
$user = tap(User::first(), function ($user) {
$user->name = 'taylor';
$user->save();
});
tap
함수에 클로저를 전달하지 않는다면, 주어진 $value
에 모든 메소드를 호출할 수 있습니다. 메소드에서 반환하는 값은 메소드가 실제로 정의해서 반환하는 $value
와는 관계없이 항상 $value
가 됩니다. 예를 들어 Eloquent update 메소드는 일반적으로 정수값을 반환하지만, tap
메소드를 통해서 update
메소드를 호출을 체이닝하면 메소드가 모델 그 자체를 반환하도록 할 수 있습니다:
$user = tap($user)->update([
'name' => $name,
'email' => $email,
]);
클래스에 tap
메소드를 추가하기 위해서는 Illuminate\Support\Traits\Tappable
Trait을 클래스에 추가하면됩니다. 이 Trait의 tap
메소드는 Closure만 인수로 받아들입니다. 객체 인스턴스 자체는 Closure에 전달되고 tap
메소드에 의해 반환됩니다.
return $user->tap(function ($user) {
//
});
throw_if()
{#collection-method}
throw_if
함수는 주어진 결과가 true
인 경우에 주어진 exception-예외를 던집니다:
throw_if(! Auth::user()->isAdmin(), AuthorizationException::class);
throw_if(
! Auth::user()->isAdmin(),
AuthorizationException::class,
'You are not allowed to access this page'
);
throw_unless()
{#collection-method}
throw_unless
함수는 주어진 결과가 false
인 경우에 주어진 exception-예외를 던집니다:
throw_unless(Auth::user()->isAdmin(), AuthorizationException::class);
throw_unless(
Auth::user()->isAdmin(),
AuthorizationException::class,
'You are not allowed to access this page'
);
today()
{#collection-method}
today
함수는 현재 날짜를 기준으로한 Illuminate\Support\Carbon
인스턴스를 생성합니다:
$today = today();
trait_uses_recursive()
{#collection-method}
trait_uses_recursive
함수는 해당 trait에서 사용된 모든 trait을 반환합니다:
$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);
transform()
{#collection-method}
transform
함수는 주어진 값이 빈값이 아닌 경우에 Closure
를 실행하고 Closure
의 결과를 반환합니다:
$callback = function ($value) {
return $value * 2;
};
$result = transform(5, $callback);
// 10
세번째 인자로 기본값 또는 Closure
가 전달될 수 있습니다. 이 값은 첫번째 인자가 빈값인 경우 반환됩니다:
$result = transform(null, $callback, 'The value is blank');
// The value is blank
validator()
{#collection-method}
validator
함수는 주어진 인자를 통해서 새로운 validator 인스턴스를 생성합니다. 보다 편리하게 Validator
파사드를 사용할 수도 있습니다:
$validator = validator($data, $rules, $messages);
value()
{#collection-method}
value
함수는 자신에게 주어진 값을 그대로 반환합니다. 그렇지만 함수에 Closure
를 전달하면 Closure
가 실행되고 그 결과물이 반환됩니다:
$result = value(true);
// true
$result = value(function () {
return false;
});
// false
view()
{#collection-method}
view
함수는 view 인스턴스를 조회합니다:
return view('auth.login');
with()
{#collection-method}
with
함수는 자신에게 주어진 값을 그대로 반환합니다. 만약 함수에 두번째 인자로 Closure
가 전달되면, Closure
가 실행되어 그 결과를 반환합니다:
$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