diff --git a/docs/passport.md b/docs/passport.md
index aaa7c86..fe70607 100644
--- a/docs/passport.md
+++ b/docs/passport.md
@@ -10,6 +10,7 @@
- [Client Secret Hashing](#client-secret-hashing)
- [Token Lifetimes](#token-lifetimes)
- [Overriding Default Models](#overriding-default-models)
+ - [Overriding Routes](#overriding-routes)
- [Issuing Access Tokens](#issuing-access-tokens)
- [Managing Clients](#managing-clients)
- [Requesting Tokens](#requesting-tokens)
@@ -48,7 +49,8 @@
[Laravel Passport](https://github.com/laravel/passport) provides a full OAuth2 server implementation for your Laravel application in a matter of minutes. Passport is built on top of the [League OAuth2 server](https://github.com/thephpleague/oauth2-server) that is maintained by Andy Millington and Simon Hamp.
-> {note} This documentation assumes you are already familiar with OAuth2. If you do not know anything about OAuth2, consider familiarizing yourself with the general [terminology](https://oauth2.thephpleague.com/terminology/) and features of OAuth2 before continuing.
+> **Warning**
+> This documentation assumes you are already familiar with OAuth2. If you do not know anything about OAuth2, consider familiarizing yourself with the general [terminology](https://oauth2.thephpleague.com/terminology/) and features of OAuth2 before continuing.
### Passport Or Sanctum?
@@ -78,7 +80,8 @@ Next, you should execute the `passport:install` Artisan command. This command wi
php artisan passport:install
```
-> {tip} If you would like to use UUIDs as the primary key value of the Passport `Client` model instead of auto-incrementing integers, please install Passport using [the `uuids` option](#client-uuids).
+> **Note**
+> If you would like to use UUIDs as the primary key value of the Passport `Client` model instead of auto-incrementing integers, please install Passport using [the `uuids` option](#client-uuids).
After running the `passport:install` command, add the `Laravel\Passport\HasApiTokens` trait to your `App\Models\User` model. This trait will provide a few helper methods to your model which allow you to inspect the authenticated user's token and scopes. If your model is already using the `Laravel\Sanctum\HasApiTokens` trait, you may remove that trait:
@@ -96,43 +99,7 @@ After running the `passport:install` command, add the `Laravel\Passport\HasApiTo
use HasApiTokens, HasFactory, Notifiable;
}
-Next, you should call the `Passport::routes` method within the `boot` method of your `App\Providers\AuthServiceProvider`. This method will register the routes necessary to issue access tokens and revoke access tokens, clients, and personal access tokens:
-
- 'App\Policies\ModelPolicy',
- ];
-
- /**
- * Register any authentication / authorization services.
- *
- * @return void
- */
- public function boot()
- {
- $this->registerPolicies();
-
- if (! $this->app->routesAreCached()) {
- Passport::routes();
- }
- }
- }
-
-Finally, in your application's `config/auth.php` configuration file, you should set the `driver` option of the `api` authentication guard to `passport`. This will instruct your application to use Passport's `TokenGuard` when authenticating incoming API requests:
+Finally, in your application's `config/auth.php` configuration file, you should define an `api` authentication guard and set the `driver` option to `passport`. This will instruct your application to use Passport's `TokenGuard` when authenticating incoming API requests:
'guards' => [
'web' => [
@@ -175,8 +142,6 @@ If necessary, you may define the path where Passport's keys should be loaded fro
{
$this->registerPolicies();
- Passport::routes();
-
Passport::loadKeysFrom(__DIR__.'/../secrets/oauth');
}
@@ -243,14 +208,13 @@ By default, Passport issues long-lived access tokens that expire after one year.
{
$this->registerPolicies();
- Passport::routes();
-
Passport::tokensExpireIn(now()->addDays(15));
Passport::refreshTokensExpireIn(now()->addDays(30));
Passport::personalAccessTokensExpireIn(now()->addMonths(6));
}
-> {note} The `expires_at` columns on Passport's database tables are read-only and for display purposes only. When issuing tokens, Passport stores the expiration information within the signed and encrypted tokens. If you need to invalidate a token you should [revoke it](#revoking-tokens).
+> **Warning**
+> The `expires_at` columns on Passport's database tables are read-only and for display purposes only. When issuing tokens, Passport stores the expiration information within the signed and encrypted tokens. If you need to invalidate a token you should [revoke it](#revoking-tokens).
### Overriding Default Models
@@ -269,6 +233,7 @@ After defining your model, you may instruct Passport to use your custom model vi
use App\Models\Passport\AuthCode;
use App\Models\Passport\Client;
use App\Models\Passport\PersonalAccessClient;
+ use App\Models\Passport\RefreshToken;
use App\Models\Passport\Token;
/**
@@ -280,14 +245,40 @@ After defining your model, you may instruct Passport to use your custom model vi
{
$this->registerPolicies();
- Passport::routes();
-
Passport::useTokenModel(Token::class);
- Passport::useClientModel(Client::class);
+ Passport::useRefreshTokenModel(RefreshToken::class);
Passport::useAuthCodeModel(AuthCode::class);
+ Passport::useClientModel(Client::class);
Passport::usePersonalAccessClientModel(PersonalAccessClient::class);
}
+
+### Overriding Routes
+
+Sometimes you may wish to customize the routes defined by Passport. To achieve this, you first need to ignore the routes registered by Passport by adding `Passport::ignoreRoutes` to the `register` method of your application's `AppServiceProvider`:
+
+ use Laravel\Passport\Passport;
+
+ /**
+ * Register any application services.
+ *
+ * @return void
+ */
+ public function register()
+ {
+ Passport::ignoreRoutes();
+ }
+
+Then, you may copy the routes defined by Passport in [its routes file](https://github.com/laravel/passport/blob/11.x/routes/web.php) to your application's `routes/web.php` file and modify them to your liking:
+
+ Route::group([
+ 'as' => 'passport.',
+ 'prefix' => config('passport.path', 'oauth'),
+ 'namespace' => 'Laravel\Passport\Http\Controllers',
+ ], function () {
+ // Passport routes...
+ });
+
## Issuing Access Tokens
@@ -410,17 +401,25 @@ Once a client has been created, developers may use their client ID and secret to
'response_type' => 'code',
'scope' => '',
'state' => $state,
+ // 'prompt' => '', // "none", "consent", or "login"
]);
return redirect('http://passport-app.test/oauth/authorize?'.$query);
});
-> {tip} Remember, the `/oauth/authorize` route is already defined by the `Passport::routes` method. You do not need to manually define this route.
+The `prompt` parameter may be used to specify the authentication behavior of the Passport application.
+
+If the `prompt` value is `none`, Passport will always throw an authentication error if the user is not already authenticated with the Passport application. If the value is `consent`, Passport will always display the authorization approval screen, even if all scopes were previously granted to the consuming application. When the value is `login`, the Passport application will always prompt the user to re-login to the application, even if they already have an existing session.
+
+If no `prompt` value is provided, the user will be prompted for authorization only if they have not previously authorized access to the consuming application for the requested scopes.
+
+> **Note**
+> Remember, the `/oauth/authorize` route is already defined by Passport. You do not need to manually define this route.
#### Approving The Request
-When receiving authorization requests, Passport will automatically display a template to the user allowing them to approve or deny the authorization request. If they approve the request, they will be redirected back to the `redirect_uri` that was specified by the consuming application. The `redirect_uri` must match the `redirect` URL that was specified when the client was created.
+When receiving authorization requests, Passport will automatically respond based on the value of `prompt` parameter (if present) and may display a template to the user allowing them to approve or deny the authorization request. If they approve the request, they will be redirected back to the `redirect_uri` that was specified by the consuming application. The `redirect_uri` must match the `redirect` URL that was specified when the client was created.
If you would like to customize the authorization approval screen, you may publish Passport's views using the `vendor:publish` Artisan command. The published views will be placed in the `resources/views/vendor/passport` directory:
@@ -428,7 +427,7 @@ If you would like to customize the authorization approval screen, you may publis
php artisan vendor:publish --tag=passport-views
```
-Sometimes you may wish to skip the authorization prompt, such as when authorizing a first-party client. You may accomplish this by [extending the `Client` model](#overriding-default-models) and defining a `skipsAuthorization` method. If `skipsAuthorization` returns `true` the client will be approved and the user will be redirected back to the `redirect_uri` immediately:
+Sometimes you may wish to skip the authorization prompt, such as when authorizing a first-party client. You may accomplish this by [extending the `Client` model](#overriding-default-models) and defining a `skipsAuthorization` method. If `skipsAuthorization` returns `true` the client will be approved and the user will be redirected back to the `redirect_uri` immediately, unless the consuming application has explicitly set the `prompt` parameter when redirecting for authorization:
{tip} Like the `/oauth/authorize` route, the `/oauth/token` route is defined for you by the `Passport::routes` method. There is no need to manually define this route.
+> **Note**
+> Like the `/oauth/authorize` route, the `/oauth/token` route is defined for you by Passport. There is no need to manually define this route.
#### JSON API
@@ -628,6 +628,7 @@ Once a client has been created, you may use the client ID and the generated code
'state' => $state,
'code_challenge' => $codeChallenge,
'code_challenge_method' => 'S256',
+ // 'prompt' => '', // "none", "consent", or "login"
]);
return redirect('http://passport-app.test/oauth/authorize?'.$query);
@@ -667,7 +668,8 @@ If the state parameter matches, the consumer should issue a `POST` request to yo
## Password Grant Tokens
-> {note} We no longer recommend using password grant tokens. Instead, you should choose [a grant type that is currently recommended by OAuth2 Server](https://oauth2.thephpleague.com/authorization-server/which-grant/).
+> **Warning**
+> We no longer recommend using password grant tokens. Instead, you should choose [a grant type that is currently recommended by OAuth2 Server](https://oauth2.thephpleague.com/authorization-server/which-grant/).
The OAuth2 password grant allows your other first-party clients, such as a mobile application, to obtain an access token using an email address / username and password. This allows you to issue access tokens securely to your first-party clients without requiring your users to go through the entire OAuth2 authorization code redirect flow.
@@ -683,7 +685,7 @@ php artisan passport:client --password
### Requesting Tokens
-Once you have created a password grant client, you may request an access token by issuing a `POST` request to the `/oauth/token` route with the user's email address and password. Remember, this route is already registered by the `Passport::routes` method so there is no need to define it manually. If the request is successful, you will receive an `access_token` and `refresh_token` in the JSON response from the server:
+Once you have created a password grant client, you may request an access token by issuing a `POST` request to the `/oauth/token` route with the user's email address and password. Remember, this route is already registered by Passport so there is no need to define it manually. If the request is successful, you will receive an `access_token` and `refresh_token` in the JSON response from the server:
use Illuminate\Support\Facades\Http;
@@ -698,7 +700,8 @@ Once you have created a password grant client, you may request an access token b
return $response->json();
-> {tip} Remember, access tokens are long-lived by default. However, you are free to [configure your maximum access token lifetime](#configuration) if needed.
+> **Note**
+> Remember, access tokens are long-lived by default. However, you are free to [configure your maximum access token lifetime](#configuration) if needed.
### Requesting All Scopes
@@ -783,7 +786,8 @@ When authenticating using the password grant, Passport will use the `password` a
## Implicit Grant Tokens
-> {note} We no longer recommend using implicit grant tokens. Instead, you should choose [a grant type that is currently recommended by OAuth2 Server](https://oauth2.thephpleague.com/authorization-server/which-grant/).
+> **Warning**
+> We no longer recommend using implicit grant tokens. Instead, you should choose [a grant type that is currently recommended by OAuth2 Server](https://oauth2.thephpleague.com/authorization-server/which-grant/).
The implicit grant is similar to the authorization code grant; however, the token is returned to the client without exchanging an authorization code. This grant is most commonly used for JavaScript or mobile applications where the client credentials can't be securely stored. To enable the grant, call the `enableImplicitGrant` method in the `boot` method of your application's `App\Providers\AuthServiceProvider` class:
@@ -796,8 +800,6 @@ The implicit grant is similar to the authorization code grant; however, the toke
{
$this->registerPolicies();
- Passport::routes();
-
Passport::enableImplicitGrant();
}
@@ -814,12 +816,14 @@ Once the grant has been enabled, developers may use their client ID to request a
'response_type' => 'token',
'scope' => '',
'state' => $state,
+ // 'prompt' => '', // "none", "consent", or "login"
]);
return redirect('http://passport-app.test/oauth/authorize?'.$query);
});
-> {tip} Remember, the `/oauth/authorize` route is already defined by the `Passport::routes` method. You do not need to manually define this route.
+> **Note**
+> Remember, the `/oauth/authorize` route is already defined by Passport. You do not need to manually define this route.
## Client Credentials Grant Tokens
@@ -873,7 +877,8 @@ To retrieve a token using this grant type, make a request to the `oauth/token` e
Sometimes, your users may want to issue access tokens to themselves without going through the typical authorization code redirect flow. Allowing users to issue tokens to themselves via your application's UI can be useful for allowing users to experiment with your API or may serve as a simpler approach to issuing access tokens in general.
-> {tip} If your application is primarily using Passport to issue personal access tokens, consider using [Laravel Sanctum](/docs/{{version}}/sanctum), Laravel's light-weight first-party library for issuing API access tokens.
+> **Note**
+> If your application is primarily using Passport to issue personal access tokens, consider using [Laravel Sanctum](/docs/{{version}}/sanctum), Laravel's light-weight first-party library for issuing API access tokens.
### Creating A Personal Access Client
@@ -978,7 +983,8 @@ Passport includes an [authentication guard](/docs/{{version}}/authentication#add
//
})->middleware('auth:api');
-> {note} If you are using the [client credentials grant](#client-credentials-grant-tokens), you should use [the `client` middleware](#client-credentials-grant-tokens) to protect your routes instead of the `auth:api` middleware.
+> **Warning**
+> If you are using the [client credentials grant](#client-credentials-grant-tokens), you should use [the `client` middleware](#client-credentials-grant-tokens) to protect your routes instead of the `auth:api` middleware.
#### Multiple Authentication Guards
@@ -1001,7 +1007,8 @@ The following route will utilize the `api-customers` guard, which uses the `cust
//
})->middleware('auth:api-customers');
-> {tip} For more information on using multiple user providers with Passport, please consult the [password grant documentation](#customizing-the-user-provider).
+> **Note**
+> For more information on using multiple user providers with Passport, please consult the [password grant documentation](#customizing-the-user-provider).
### Passing The Access Token
@@ -1036,8 +1043,6 @@ You may define your API's scopes using the `Passport::tokensCan` method in the `
{
$this->registerPolicies();
- Passport::routes();
-
Passport::tokensCan([
'place-orders' => 'Place orders',
'check-status' => 'Check order status',
@@ -1061,6 +1066,9 @@ If a client does not request any specific scopes, you may configure your Passpor
'place-orders',
]);
+> **Note**
+> Passport's default scopes do not apply to personal access tokens that are generated by the user.
+
### Assigning Scopes To Tokens
@@ -1159,7 +1167,8 @@ Typically, if you want to consume your API from your JavaScript application, you
\Laravel\Passport\Http\Middleware\CreateFreshApiToken::class,
],
-> {note} You should ensure that the `CreateFreshApiToken` middleware is the last middleware listed in your middleware stack.
+> **Warning**
+> You should ensure that the `CreateFreshApiToken` middleware is the last middleware listed in your middleware stack.
This middleware will attach a `laravel_token` cookie to your outgoing responses. This cookie contains an encrypted JWT that Passport will use to authenticate API requests from your JavaScript application. The JWT has a lifetime equal to your `session.lifetime` configuration value. Now, since the browser will automatically send the cookie with all subsequent requests, you may make requests to your application's API without explicitly passing an access token:
@@ -1182,8 +1191,6 @@ If needed, you can customize the `laravel_token` cookie's name using the `Passpo
{
$this->registerPolicies();
- Passport::routes();
-
Passport::cookie('custom_name');
}
@@ -1192,7 +1199,8 @@ If needed, you can customize the `laravel_token` cookie's name using the `Passpo
When using this method of authentication, you will need to ensure a valid CSRF token header is included in your requests. The default Laravel JavaScript scaffolding includes an Axios instance, which will automatically use the encrypted `XSRF-TOKEN` cookie value to send an `X-XSRF-TOKEN` header on same-origin requests.
-> {tip} If you choose to send the `X-CSRF-TOKEN` header instead of `X-XSRF-TOKEN`, you will need to use the unencrypted token provided by `csrf_token()`.
+> **Note**
+> If you choose to send the `X-CSRF-TOKEN` header instead of `X-XSRF-TOKEN`, you will need to use the unencrypted token provided by `csrf_token()`.
## Events
diff --git a/docs/passwords.md b/docs/passwords.md
index 57c7be0..5b3429b 100644
--- a/docs/passwords.md
+++ b/docs/passwords.md
@@ -15,7 +15,8 @@
Большинство веб-приложений предоставляют пользователям возможность сбросить забытые пароли. Вместо того, чтобы заставлять вас заново реализовывать этот функционал самостоятельно для каждого создаваемого вами приложения, Laravel предлагает удобные сервисы для отправки ссылок для сброса пароля и, собственно, безопасного сброса паролей.
-> {tip} Хотите быстро начать? Установите один из [стартовых комплектов](starter-kits.md) в новое приложение Laravel. Стартовые комплекты позаботятся о построении всей вашей системы аутентификации, включая сброс забытых паролей.
+> **Примечание**\
+> Хотите быстро начать? Установите один из [стартовых комплектов](starter-kits.md) в новое приложение Laravel. Стартовые комплекты позаботятся о построении всей вашей системы аутентификации, включая сброс забытых паролей.
### Подготовка модели
@@ -87,7 +88,8 @@ php artisan migrate
Вам может быть интересно: как Laravel знает о том, как получить запись пользователя из базы данных вашего приложения при вызове метода `sendResetLink` фасада `Password`? Брокер паролей Laravel использует «поставщиков пользователей» вашей системы аутентификации для получения записей из базы данных. Поставщик пользователей, используемый брокером паролей, настраивается в массиве `passwords` вашего файла конфигурации `config/auth.php`. Чтобы узнать больше о создании пользовательских поставщиков служб, обратитесь к [документации по аутентификации](authentication.md#adding-custom-user-providers).
-> {tip} При выполнении сброса пароля самостоятельно, вы должны сами определять содержимое страницы и маршрутов. Если вам необходим каркас, включающий всю необходимую логику аутентификации и проверки, ознакомьтесь со [стартовыми комплектами приложений Laravel](starter-kits.md).
+> **Примечание**\
+> При выполнении сброса пароля самостоятельно, вы должны сами определять содержимое страницы и маршрутов. Если вам необходим каркас, включающий всю необходимую логику аутентификации и проверки, ознакомьтесь со [стартовыми комплектами приложений Laravel](starter-kits.md).
### Сброс пароля
diff --git a/docs/pint.md b/docs/pint.md
new file mode 100644
index 0000000..2c39e38
--- /dev/null
+++ b/docs/pint.md
@@ -0,0 +1,152 @@
+# Laravel 9 · Pint
+
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Running Pint](#running-pint)
+- [Configuring Pint](#configuring-pint)
+ - [Presets](#presets)
+ - [Rules](#rules)
+ - [Excluding Files / Folders](#excluding-files-or-folders)
+
+
+## Introduction
+
+[Laravel Pint](https://github.com/laravel/pint) is an opinionated PHP code style fixer for minimalists. Pint is built on top of PHP-CS-Fixer and makes it simple to ensure that your code style stays clean and consistent.
+
+Pint is automatically installed with all new Laravel applications so you may start using it immediately. By default, Pint does not require any configuration and will fix code style issues in your code by following the opinionated coding style of Laravel.
+
+
+## Installation
+
+Pint is included in recent releases of the Laravel framework, so installation is typically unnecessary. However, for older applications, you may install Laravel Pint via Composer:
+
+```shell
+composer require laravel/pint --dev
+```
+
+
+## Running Pint
+
+You can instruct Pint to fix code style issues by invoking the `pint` binary that is available in your project's `vendor/bin` directory:
+
+```shell
+./vendor/bin/pint
+```
+
+You may also run Pint on specific files or directories:
+
+```shell
+./vendor/bin/pint app/Models
+
+./vendor/bin/pint app/Models/User.php
+```
+
+Pint will display a thorough list of all of the files that it updates. You can view even more detail about Pint's changes by providing the `-v` option when invoking Pint:
+
+```shell
+./vendor/bin/pint -v
+```
+
+If you would like Pint to simply inspect your code for style errors without actually changing the files, you may use the `--test` option:
+
+```shell
+./vendor/bin/pint --test
+```
+
+If you would like Pint to only modify the files that have uncommitted changes according to Git, you may use the `--dirty` option:
+
+```shell
+./vendor/bin/pint --dirty
+```
+
+
+## Configuring Pint
+
+As previously mentioned, Pint does not require any configuration. However, if you wish to customize the presets, rules, or inspected folders, you may do so by creating a `pint.json` file in your project's root directory:
+
+```json
+{
+ "preset": "laravel"
+}
+```
+
+In addition, if you wish to use a `pint.json` from a specific directory, you may provide the `--config` option when invoking Pint:
+
+```shell
+pint --config vendor/my-company/coding-style/pint.json
+```
+
+
+### Presets
+
+Presets defines a set of rules that can be used to fix code style issues in your code. By default, Pint uses the `laravel` preset, which fixes issues by following the opinionated coding style of Laravel. However, you may specify a different preset by providing the `--preset` option to Pint:
+
+```shell
+pint --preset psr12
+```
+
+If you wish, you may also set the preset in your project's `pint.json` file:
+
+```json
+{
+ "preset": "psr12"
+}
+```
+
+Pint's currently supported presets are: `laravel`, `psr12`, and `symfony`.
+
+
+### Rules
+
+Rules are style guidelines that Pint will use to fix code style issues in your code. As mentioned above, presets are predefined groups of rules that should be perfect for most PHP projects, so you typically will not need to worry about the individual rules they contain.
+
+However, if you wish, you may enable or disable specific rules in your `pint.json` file:
+
+```json
+{
+ "preset": "laravel",
+ "rules": {
+ "simplified_null_return": true,
+ "braces": false,
+ "new_with_braces": {
+ "anonymous_class": false,
+ "named_class": false
+ }
+ }
+}
+```
+
+Pint is built on top of [PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer). Therefore, you may use any of its rules to fix code style issues in your project: [PHP-CS-Fixer Configurator](https://mlocati.github.io/php-cs-fixer-configurator).
+
+
+### Excluding Files / Folders
+
+By default, Pint will inspect all `.php` files in your project except those in the `vendor` directory. If you wish to exclude more folders, you may do so using the `exclude` configuration option:
+
+```json
+{
+ "exclude": [
+ "my-specific/folder"
+ ]
+}
+```
+
+If you wish to exclude all files that contain a given name pattern, you may do so using the `notName` configuration option:
+
+```json
+{
+ "notName": [
+ "*-my-file.php"
+ ]
+}
+```
+
+If you would like to exclude a file by providing an exact path to the file, you may do so using the `notPath` configuration option:
+
+```json
+{
+ "notPath": [
+ "path/to/excluded-file.php"
+ ]
+}
+```
diff --git a/docs/providers.md b/docs/providers.md
index 1648fff..a0aa428 100644
--- a/docs/providers.md
+++ b/docs/providers.md
@@ -18,7 +18,8 @@
В этой документации вы узнаете, как писать собственных поставщиков служб и регистрировать их в приложении Laravel.
-> {tip} Если вы хотите узнать больше о том, как Laravel обрабатывает запросы и работает изнутри, ознакомьтесь с нашей документацией по [жизненному циклу запроса](lifecycle.md) Laravel.
+> **Примечание**\
+> Если вы хотите узнать больше о том, как Laravel обрабатывает запросы и работает изнутри, ознакомьтесь с нашей документацией по [жизненному циклу запроса](lifecycle.md) Laravel.
## Написание поставщиков служб
diff --git a/docs/queries.md b/docs/queries.md
index 262d806..43d8fee 100644
--- a/docs/queries.md
+++ b/docs/queries.md
@@ -41,7 +41,8 @@
Построитель запросов Laravel использует связывание параметров PDO для защиты приложения от SQL-инъекций. Нет необходимости чистить строки, передаваемые как связываемые параметры.
-> {note} PDO не поддерживает связывание имен столбцов. Поэтому, вы никогда не должны использовать какие-либо входящие от пользователя данные в качестве имен столбцов, используемые вашими запросами, включая столбцы в запросах `order by` и т.д.
+> **Предупреждение**\
+> PDO не поддерживает связывание имен столбцов. Поэтому, вы никогда не должны использовать какие-либо входящие от пользователя данные в качестве имен столбцов, используемые вашими запросами, включая столбцы в запросах `order by` и т.д.
## Выполнение запросов к базе данных
@@ -83,7 +84,8 @@
echo $user->name;
}
-> {tip} Коллекции Laravel содержат множество чрезвычайно мощных методов для перебора и сокращения данных. Для получения дополнительной информации о коллекциях Laravel ознакомьтесь с [их документацией](collections.md).
+> **Примечание**\
+> Коллекции Laravel содержат множество чрезвычайно мощных методов для перебора и сокращения данных. Для получения дополнительной информации о коллекциях Laravel ознакомьтесь с [их документацией](collections.md).
#### Получение одной строки / столбца из таблицы
@@ -155,7 +157,8 @@
}
});
-> {note} При обновлении или удалении записей внутри замыкания, любые изменения первичного или внешних ключей могут повлиять на запрос очередного фрагмента. Это может потенциально привести к тому, что записи могут не быть включены в последующие результаты выполнения замыкания.
+> **Предупреждение**\
+> При обновлении или удалении записей внутри замыкания, любые изменения первичного или внешних ключей могут повлиять на запрос очередного фрагмента. Это может потенциально привести к тому, что записи могут не быть включены в последующие результаты выполнения замыкания.
### Отложенная потоковая передача результатов
@@ -181,7 +184,8 @@ DB::table('users')->where('active', false)
});
```
-> {note} При обновлении или удалении записей во время их итерации любые изменения первичного ключа или внешних ключей могут повлиять на запрос фрагмента. Это может потенциально привести к тому, что записи не будут включены в результирующий набор.
+> **Предупреждение**\
+> При обновлении или удалении записей во время их итерации любые изменения первичного ключа или внешних ключей могут повлиять на запрос фрагмента. Это может потенциально привести к тому, что записи не будут включены в результирующий набор.
### Извлечение Агрегатов
@@ -248,7 +252,8 @@ DB::table('users')->where('active', false)
->groupBy('status')
->get();
-> {note} Сырые выражения будут вставлены в запрос в виде строк, поэтому следует проявлять особую осторожность, чтобы не создавать уязвимости для SQL-инъекций.
+> **Предупреждение**\
+> Сырые выражения будут вставлены в запрос в виде строк, поэтому следует проявлять особую осторожность, чтобы не создавать уязвимости для SQL-инъекций.
### Необрабатываемые методы
@@ -433,7 +438,8 @@ DB::table('users')->where('active', false)
['subscribed', '<>', '1'],
])->get();
-> {note} PDO не поддерживает связывание имен столбцов. Поэтому, вы никогда не должны использовать какие-либо входящие от пользователя данные в качестве имен столбцов, используемые вашими запросами, включая столбцы в запросах `order by` и т.д.
+> **Предупреждение**\
+> PDO не поддерживает связывание имен столбцов. Поэтому, вы никогда не должны использовать какие-либо входящие от пользователя данные в качестве имен столбцов, используемые вашими запросами, включая столбцы в запросах `order by` и т.д.
### Выражения Or Where
@@ -461,7 +467,8 @@ DB::table('users')->where('active', false)
select * from users where votes > 100 or (name = 'Abigail' and votes > 50)
```
-> {note} Вы всегда должны группировать вызовы `orWhere`, чтобы избежать неожиданного поведения при применении [глобальных областей запроса](eloquent.md#query-scopes).
+> **Предупреждение**\
+> Вы всегда должны группировать вызовы `orWhere`, чтобы избежать неожиданного поведения при применении [глобальных областей запроса](eloquent.md#query-scopes).
### Выражения Where Not
@@ -478,13 +485,13 @@ select * from users where votes > 100 or (name = 'Abigail' and votes > 50)
### Выражения Where и JSON
-Laravel также поддерживает запросы в базах данных, которые обеспечивают поддержку JSON-типов столбцов. В настоящее время это MySQL 5.7+, PostgreSQL, SQL Server 2016 и SQLite 3.9.0 (с [расширением JSON1](https://www.sqlite.org/json1.html)). Чтобы запросить столбец JSON, используйте оператор `->`:
+Laravel также поддерживает запросы в базах данных, которые обеспечивают поддержку JSON-типов столбцов. В настоящее время это MySQL 5.7+, PostgreSQL, SQL Server 2016 и SQLite 3.39.0 (с [расширением JSON1](https://www.sqlite.org/json1.html)). Чтобы запросить столбец JSON, используйте оператор `->`:
$users = DB::table('users')
->where('preferences->dining->meal', 'salad')
->get();
-Вы можете использовать `whereJsonContains` для запроса массивов JSON. Эта функция не поддерживается базой данных SQLite:
+Вы можете использовать `whereJsonContains` для запроса массивов JSON. Эта функция не поддерживается базой данных SQLite ниже 3.38.0:
$users = DB::table('users')
->whereJsonContains('options->languages', 'en')
@@ -525,6 +532,20 @@ Laravel также поддерживает запросы в базах дан
->whereNotBetween('votes', [1, 100])
->get();
+**whereBetweenColumns / whereNotBetweenColumns / orWhereBetweenColumns / orWhereNotBetweenColumns**
+
+Метод `whereBetweenColumns` проверяет, находится ли значение столбца между двумя значениями двух столбцов в одной и той же строке таблицы:
+
+ $patients = DB::table('patients')
+ ->whereBetweenColumns('weight', ['minimum_allowed_weight', 'maximum_allowed_weight'])
+ ->get();
+
+Метод `whereNotBetweenColumns` проверяет, находится ли значение столбца за пределами двух значений двух столбцов в одной и той же строке таблицы:
+
+ $patients = DB::table('patients')
+ ->whereNotBetweenColumns('weight', ['minimum_allowed_weight', 'maximum_allowed_weight'])
+ ->get();
+
**whereIn / whereNotIn / orWhereIn / orWhereNotIn**
Метод `whereIn` проверяет, что значение переданного столбца содержится в указанном массиве:
@@ -539,7 +560,26 @@ Laravel также поддерживает запросы в базах дан
->whereNotIn('id', [1, 2, 3])
->get();
-> {note} Если вы добавляете в свой запрос большой массив связываемых целочисленных параметров, то методы `whereIntegerInRaw` или `whereIntegerNotInRaw` могут использоваться для значительного сокращения потребляемой памяти.
+Вы также можете передать объект запроса в качестве второго аргумента метода `whereIn`:
+
+ $activeUsers = DB::table('users')->select('id')->where('is_active', 1);
+
+ $users = DB::table('comments')
+ ->whereIn('user_id', $activeUsers)
+ ->get();
+
+В приведенном выше примере будет получен следующий SQL:
+
+```sql
+select * from comments where user_id in (
+ select id
+ from users
+ where is_active = 1
+)
+```
+
+> **Предупреждение**\
+> Если вы добавляете в свой запрос большой массив связываемых целочисленных параметров, то методы `whereIntegerInRaw` или `whereIntegerNotInRaw` могут использоваться для значительного сокращения потребляемой памяти.
**whereNull / whereNotNull / orWhereNull / orWhereNotNull**
@@ -628,7 +668,8 @@ Laravel также поддерживает запросы в базах дан
select * from users where name = 'John' and (votes > 100 or title = 'Admin')
```
-> {note} Вы всегда должны группировать вызовы `orWhere`, чтобы избежать неожиданного поведения при применении [глобальных областей запроса](eloquent.md#query-scopes).
+> **Предупреждение**\
+> Вы всегда должны группировать вызовы `orWhere`, чтобы избежать неожиданного поведения при применении [глобальных областей запроса](eloquent.md#query-scopes).
### Расширенные выражения Where
@@ -683,7 +724,8 @@ where exists (
### Полнотекстовый поиск
-> {note} Полнотекстовый поиск в настоящее время поддерживаются MySQL и PostgreSQL.
+> **Предупреждение**\
+> Полнотекстовый поиск в настоящее время поддерживаются MySQL и PostgreSQL.
Методы `whereFullText` и `orWhereFullText` полнотекстового поиска можно использовать для добавления условий `where` в запрос для столбцов, которые имеют [полнотекстовые индексы](migrations.md#available-index-types). Эти методы будут преобразованы Laravel в соответствующий SQL базы данных. Например, предложение `MATCH AGAINST` будет создано для приложений, использующих MySQL:
@@ -861,21 +903,27 @@ where exists (
['email' => 'john@example.com', 'votes' => 0]
);
-> {note} При использовании PostgreSQL метод `insertGetId` ожидает, что автоинкрементный столбец будет называться `id`. Если вы хотите получить идентификатор из другой «последовательности», вы можете передать имя столбца в качестве второго параметра методу `insertGetId`.
+> **Предупреждение**\
+> При использовании PostgreSQL метод `insertGetId` ожидает, что автоинкрементный столбец будет называться `id`. Если вы хотите получить идентификатор из другой «последовательности», вы можете передать имя столбца в качестве второго параметра методу `insertGetId`.
### Обновления-вставки
Метод `upsert` вставляет записи, которые не существуют, и обновляет записи, которые уже существуют, новыми значениями, которые вы можете указать. Первый аргумент метода состоит из значений для вставки или обновления, а второй аргумент перечисляет столбцы, которые однозначно идентифицируют записи в связанной таблице. Третий и последний аргумент метода – это массив столбцов, который следует обновить, если соответствующая запись уже существует в базе данных:
- DB::table('flights')->upsert([
- ['departure' => 'Oakland', 'destination' => 'San Diego', 'price' => 99],
- ['departure' => 'Chicago', 'destination' => 'New York', 'price' => 150]
- ], ['departure', 'destination'], ['price']);
+ DB::table('flights')->upsert(
+ [
+ ['departure' => 'Oakland', 'destination' => 'San Diego', 'price' => 99],
+ ['departure' => 'Chicago', 'destination' => 'New York', 'price' => 150]
+ ],
+ ['departure', 'destination'],
+ ['price']
+ );
В приведенном выше примере Laravel попытается вставить две записи. Если запись уже существует с такими же значениями столбцов `departure` и `destination`, то Laravel обновит столбец `price` этой записи.
-> {note} Все базы данных, кроме SQL Server, требуют, чтобы столбцы во втором аргументе метода `upsert` имели «первичный» или «уникальный» индекс. Вдобавок, драйвер базы данных MySQL игнорирует второй аргумент метода `upsert` и всегда использует «первичный» и «уникальный» индексы таблицы для обнаружения существующих записей.
+> **Предупреждение**\
+> Все базы данных, кроме SQL Server, требуют, чтобы столбцы во втором аргументе метода `upsert` имели «первичный» или «уникальный» индекс. Вдобавок, драйвер базы данных MySQL игнорирует второй аргумент метода `upsert` и всегда использует «первичный» и «уникальный» индексы таблицы для обнаружения существующих записей.
## Обновление
@@ -921,10 +969,17 @@ where exists (
DB::table('users')->decrement('votes', 5);
-Вы также можете указать дополнительные столбцы для обновления во время выполнения запроса:
+Вы также можете указать дополнительные столбцы для обновления во время операции увеличения или уменьшения:
DB::table('users')->increment('votes', 1, ['name' => 'John']);
+Кроме того, вы можете одновременно увеличивать или уменьшать несколько столбцов, используя методы `incrementEach` и `decrementEach`:
+
+ DB::table('users')->incrementEach([
+ 'votes' => 5,
+ 'balance' => 100,
+ ]);
+
## Удаление
diff --git a/docs/queues.md b/docs/queues.md
index 2a8c2e3..353d002 100644
--- a/docs/queues.md
+++ b/docs/queues.md
@@ -55,7 +55,8 @@
Параметры конфигурации очереди Laravel хранятся в файле конфигурации вашего приложения `config/queue.php`. В этом файле вы найдете конфигурации подключения для каждого из драйверов очереди фреймворка: база данных, [Amazon SQS](https://aws.amazon.com/sqs/), [Redis](https://redis.io) и [Beanstalkd](https://beanstalkd.github.io/), а также синхронный драйвер для немедленного выполнения задания (используется во время локальной разработки). Также имеется драйвер очереди `null`, который выбрасывает задания из очереди.
-> {tip} Laravel также предлагает Horizon, красивую панель управления и систему конфигурации для ваших очередей с поддержкой Redis. Дополнительную информацию можно найти в полной [документации Horizon](horizon.md).
+> **Примечание**\
+> Laravel также предлагает Horizon, красивую панель управления и систему конфигурации для ваших очередей с поддержкой Redis. Дополнительную информацию можно найти в полной [документации Horizon](horizon.md).
### Соединения и очереди
@@ -126,7 +127,8 @@ php artisan migrate
'block_for' => 5,
],
-> {note} Установка для `block_for` значения `0` заставит обработчиков очереди блокироваться на неопределенный срок, пока задание не станет доступным. Это также предотвратит обработку таких сигналов, как `SIGTERM`, до тех пор, пока не будет обработано следующее задание.
+> **Предупреждение**\
+> Установка для `block_for` значения `0` заставит обработчиков очереди блокироваться на неопределенный срок, пока задание не станет доступным. Это также предотвратит обработку таких сигналов, как `SIGTERM`, до тех пор, пока не будет обработано следующее задание.
#### Дополнительные зависимости драйверов
@@ -155,7 +157,8 @@ php artisan make:job ProcessPodcast
Сгенерированный класс будет реализовывать интерфейс `Illuminate\Contracts\Queue\ShouldQueue`, указывая Laravel, что задание должно быть поставлено в очередь для асинхронного выполнения.
-> {tip} Заготовки заданий можно настроить с помощью [публикации заготовок](artisan.md#stub-customization).
+> **Примечание**\
+> Заготовки заданий можно настроить с помощью [публикации заготовок](artisan.md#stub-customization).
### Структура класса задания
@@ -226,7 +229,8 @@ php artisan make:job ProcessPodcast
return $job->handle($app->make(AudioProcessor::class));
});
-> {note} Двоичные данные, например, необработанное содержимое изображения, должны быть переданы через функцию `base64_encode` перед передачей заданию. В противном случае задание может неправильно сериализоваться в JSON при отправке в очередь.
+> **Предупреждение**\
+> Двоичные данные, например, необработанное содержимое изображения, должны быть переданы через функцию `base64_encode` перед передачей заданию. В противном случае задание может неправильно сериализоваться в JSON при отправке в очередь.
#### Игнорирование отношений при создании задания
@@ -249,7 +253,8 @@ php artisan make:job ProcessPodcast
### Уникальные задания
-> {note} Для уникальных заданий требуется драйвер кеша, поддерживающий [блокировки](cache.md#atomic-locks). В настоящее время драйверы кеширования `memcached`, `redis`, `dynamodb`, `database`, `file`, и `array` поддерживают атомарные блокировки. Кроме того, уникальность заданий не учитывается при пакетной обработке.
+> **Предупреждение**\
+> Для уникальных заданий требуется драйвер кеша, поддерживающий [блокировки](cache.md#atomic-locks). В настоящее время атомарные блокировки поддерживают драйверы кеширования `memcached`, `redis`, `dynamodb`, `database`, `file` и `array`. Кроме того, уникальность заданий не учитывается при пакетной обработке.
Иногда требуется убедиться, что только один экземпляр определенного задания находится в очереди в любой момент времени. Вы можете сделать это, реализовав интерфейс `ShouldBeUnique` в своем классе задания. Этот интерфейс не требует от вас определения каких-либо дополнительных методов в вашем классе:
@@ -302,7 +307,8 @@ php artisan make:job ProcessPodcast
В приведенном выше примере задание `UpdateSearchIndex` уникально по идентификатору продукта. Таким образом, любые новые отправленные задания с тем же идентификатором продукта будут игнорироваться, пока существующее задание не завершит обработку. Кроме того, если существующее задание не будет обработано в течение одного часа, уникальная блокировка будет снята, и в очередь может быть отправлено другое задание с таким же уникальным ключом.
-> {note} Если ваше приложение отправляет задания с нескольких веб-серверов или контейнеров, то вы должны убедиться, что все ваши серверы взаимодействуют с одним и тем же центральным кэш-сервером, чтобы Laravel мог точно определить, является ли задание уникальным.
+> **Предупреждение**\
+> Если ваше приложение отправляет задания с нескольких веб-серверов или контейнеров, то вы должны убедиться, что все ваши серверы взаимодействуют с одним и тем же центральным кэш-сервером, чтобы Laravel мог точно определить, является ли задание уникальным.
#### Сохранение уникальности задания только до начала обработки
@@ -342,7 +348,8 @@ php artisan make:job ProcessPodcast
}
}
-> {tip} Если вам нужно ограничить только параллельную обработку задания, используйте вместо этого посредник [`WithoutOverlapping`](#preventing-job-overlaps).
+> **Примечание**\
+> Если вам нужно ограничить только параллельную обработку задания, используйте вместо этого посредник [`WithoutOverlapping`](#preventing-job-overlaps).
## Посредник задания
@@ -420,7 +427,8 @@ php artisan make:job ProcessPodcast
return [new RateLimited];
}
-> {tip} Посредник задания также можно назначить слушателям событий в очереди, почтовым отправлениям и уведомлениям.
+> **Примечание**\
+> Посредник задания также можно назначить слушателям событий в очереди, почтовым отправлениям и уведомлениям.
### Ограничение частоты
@@ -478,7 +486,8 @@ php artisan make:job ProcessPodcast
return [(new RateLimited('backups'))->dontRelease()];
}
-> {tip} Если вы используете Redis, то вы можете использовать посредника `Illuminate\Queue\Middleware\RateLimitedWithRedis`, который лучше настроен для Redis и более эффективен, чем базовый посредник с ограничением частоты.
+> **Примечание**\
+> Если вы используете Redis, то вы можете использовать посредника `Illuminate\Queue\Middleware\RateLimitedWithRedis`, который лучше настроен для Redis и более эффективен, чем базовый посредник с ограничением частоты.
### Предотвращение дублирования задания
@@ -499,7 +508,7 @@ Laravel содержит посредника `Illuminate\Queue\Middleware\Witho
return [new WithoutOverlapping($this->user->id)];
}
-Любые перекрывающиеся задания будут возвращены в очередь. Можно также указать время в секундах, которое должно пройти до повторной попытки возвращенного задания:
+Любые перекрывающиеся задания одного и того же типа будут возвращены в очередь. Можно также указать время в секундах, которое должно пройти до повторной попытки возвращенного задания:
/**
* Получить посредника, через которого должно пройти задание.
@@ -535,7 +544,43 @@ Laravel содержит посредника `Illuminate\Queue\Middleware\Witho
return [(new WithoutOverlapping($this->order->id))->expireAfter(180)];
}
-> {note} Для посредника `WithoutOverlapping` требуется драйвер кеша, который поддерживает [блокировки](cache.md#atomic-locks). В настоящее время драйверы кеша `memcached`, `redis`, `dynamodb`, `database`, `file` и `array` поддерживают атомарные блокировки.
+> **Предупреждение**\
+> Для посредника `WithoutOverlapping` требуется драйвер кеша, который поддерживает [блокировки](cache.md#atomic-locks). В настоящее время атомарные блокировки поддерживают драйверы кеширования `memcached`, `redis`, `dynamodb`, `database`, `file` и `array`.
+
+
+#### Совместное использование ключей блокировки для разных классов заданий
+
+По умолчанию посредник `WithoutOverlapping` предотвращает перекрытие заданий только одного класса. Таким образом, хотя два разных класса заданий могут использовать один и тот же ключ блокировки, они не будут защищены от перекрытия. Однако вы можете указать Laravel применять ключ к классам заданий, используя метод `shared`:
+
+```php
+use Illuminate\Queue\Middleware\WithoutOverlapping;
+
+class ProviderIsDown
+{
+ // ...
+
+
+ public function middleware()
+ {
+ return [
+ (new WithoutOverlapping("status:{$this->provider}"))->shared(),
+ ];
+ }
+}
+
+class ProviderIsUp
+{
+ // ...
+
+
+ public function middleware()
+ {
+ return [
+ (new WithoutOverlapping("status:{$this->provider}"))->shared(),
+ ];
+ }
+}
+```
### Ограничение частоты генерации исключений
@@ -596,7 +641,8 @@ Laravel содержит посредника `Illuminate\Queue\Middleware\Throt
return [(new ThrottlesExceptions(10, 10))->by('key')];
}
-> {tip} Если вы используете Redis в качестве драйвера кеша вашего приложения, то вы можете использовать класс `Illuminate\Queue\Middleware\ThrottlesExceptionsWithRedis`. Этот класс более эффективен при управлении ограничениями исключений с помощью Redis.
+> **Примечание**\
+> Если вы используете Redis в качестве драйвера кеша вашего приложения, то вы можете использовать класс `Illuminate\Queue\Middleware\ThrottlesExceptionsWithRedis`. Этот класс более эффективен при управлении ограничениями исключений с помощью Redis.
## Отправка заданий
@@ -636,6 +682,8 @@ Laravel содержит посредника `Illuminate\Queue\Middleware\Throt
ProcessPodcast::dispatchUnless($accountSuspended, $podcast);
+В новых приложениях Laravel драйвер `sync` является драйвером очереди по умолчанию. Этот драйвер выполняет задания синхронно совместно с текущим запросом, что часто удобно при локальной разработке. Если вы действительно хотите начать ставить задания в очередь для фоновой обработки, то вы можете указать другой драйвер очереди в конфигурационном файле `config/queue.php` вашего приложения.
+
### Отложенная отправка
@@ -669,12 +717,13 @@ Laravel содержит посредника `Illuminate\Queue\Middleware\Throt
}
}
-> {note} У сервиса очередей Amazon SQS максимальное время задержки составляет 15 минут.
+> **Предупреждение**\
+> У сервиса очередей Amazon SQS максимальное время задержки составляет 15 минут.
#### Отправка задания после отправки ответа в браузер
-В качестве альтернативы, метод `dispatchAfterResponse` задерживает отправку задания до тех пор, пока HTTP-ответ не будет отправлен в браузер пользователя. Это по-прежнему позволит пользователю начать использовать приложение, даже если задание в очереди все еще выполняется. Обычно это следует использовать только для заданий, которые занимают около секунды, например, для отправки электронного письма. Поскольку они обрабатываются в рамках текущего HTTP-запроса, отправляемые таким образом задания не требуют запуска обработчика очереди для их обработки:
+В качестве альтернативы, метод `dispatchAfterResponse` задерживает отправку задания до тех пор, пока HTTP-ответ не будет отправлен в браузер пользователя, если ваш веб-сервер использует FastCGI. Это по-прежнему позволит пользователю начать использовать приложение, даже если задание в очереди все еще выполняется. Обычно это следует использовать только для заданий, которые занимают около секунды, например, для отправки электронного письма. Поскольку они обрабатываются в рамках текущего HTTP-запроса, отправляемые таким образом задания не требуют запуска обработчика очереди для их обработки:
use App\Jobs\SendNotification;
@@ -738,7 +787,8 @@ Laravel содержит посредника `Illuminate\Queue\Middleware\Throt
Если транзакция откатывается из-за исключения, возникшего во время транзакции, то задания, которые были отправлены во время этой транзакции, будут отброшены.
-> {tip} Установка параметру конфигурации `after_commit` значения `true` также вызовет отправку всех поставленных в очередь слушателей событий, почтовых отправлений, уведомлений и широковещательных событий после того, как все открытые транзакции базы данных были зафиксированы.
+> **Примечание**\
+> Установка параметру конфигурации `after_commit` значения `true` также вызовет отправку всех поставленных в очередь слушателей событий, почтовых отправлений, уведомлений и широковещательных событий после того, как все открытые транзакции базы данных были зафиксированы.
#### Непосредственное указание поведения отправки при фиксации транзакций БД
@@ -779,7 +829,8 @@ Laravel содержит посредника `Illuminate\Queue\Middleware\Throt
},
])->dispatch();
-> {note} Удаление заданий с помощью метода `$this->delete()` внутри задания не остановить обработку связанных заданий. Цепочка прекратит выполнение только в случае сбоя задания в цепочке.
+> **Предупреждение**\
+> Удаление заданий с помощью метода `$this->delete()` внутри задания не остановить обработку связанных заданий. Цепочка прекратит выполнение только в случае сбоя задания в цепочке.
#### Соединения и очередь цепочки заданий
@@ -808,6 +859,8 @@ Laravel содержит посредника `Illuminate\Queue\Middleware\Throt
// Задание в цепочке не выполнено ...
})->dispatch();
+> **Примечание**\ Поскольку замыкания в цепочке заданий сериализуются и выполняются позже очередью Laravel, то вы не должны использовать переменную `$this` в замыканиях цепочек заданий.
+
### Настройка соединения и очереди
@@ -943,13 +996,13 @@ Laravel содержит посредника `Illuminate\Queue\Middleware\Throt
Если в одном из ваших заданий в очереди обнаруживается ошибка, то вы, вероятно, не хотите, чтобы оно продолжало повторять попытки бесконечно. Laravel предлагает различные способы указать, сколько раз и как долго задание может повторно выполняться.
-Один из подходов к указанию максимального количества попыток выполнения задания – это использование переключателя `--tries` в командной строке Artisan. Это будет применяться ко всем заданиям обработчика, если только обрабатываемое задание не указывает более конкретное количество попыток его выполнения:
+Один из подходов к указанию максимального количества попыток выполнения задания – это использование параметра `--tries` в командной строке Artisan. Это будет применяться ко всем заданиям обработчика, если только в обрабатываемом задании не указано количество попыток его выполнения:
```shell
php artisan queue:work --tries=3
```
-Если задание превышает максимальное количество попыток, то оно будет считаться «неудачным». Для получения дополнительной информации об обработке невыполненных заданий обратитесь к [документации по разбору неудачных заданий](#dealing-with-failed-jobs).
+Если задание превышает максимальное количество попыток, то оно будет считаться «неудачным». Для получения дополнительной информации об обработке невыполненных заданий обратитесь к [документации по разбору неудачных заданий](#dealing-with-failed-jobs). Если для команды `queue:work` указан парамет `--tries=0`, то задание будет повторяться неограниченное количество раз.
Вы можете применить более детальный подход, указав максимальное количество попыток выполнения задания для самого класса задания. Если для задания указано максимальное количество попыток, оно будет иметь приоритет над значением `--tries`, указанным в командной строке:
@@ -982,7 +1035,8 @@ php artisan queue:work --tries=3
return now()->addMinutes(10);
}
-> {tip} Вы также можете определить свойство `$tries` или метод `retryUntil` в ваших [слушателях событий](events.md#queued-event-listeners).
+> **Примечание**\
+> Вы также можете определить свойство `$tries` или метод `retryUntil` в ваших [слушателях событий](events.md#queued-event-listeners).
#### Максимальное количество исключений
@@ -1032,9 +1086,10 @@ php artisan queue:work --tries=3
#### Тайм-аут
-> {note} Для указания тайм-аутов задания должно быть установлено расширение `pcntl` PHP.
+> **Предупреждение**\
+> Для указания тайм-аутов задания должно быть установлено расширение `pcntl` PHP.
-Часто вы приблизительно знаете, сколько времени займет выполнение заданий в очереди. По этой причине Laravel позволяет вам указать значение «тайм-аута». Если задание обрабатывается дольше, чем количество секунд, указанное значением тайм-аута, обработчик завершится с ошибкой. Обычно обработчик перезапускается автоматически [диспетчером, настроенным на вашем сервере](#supervisor-configuration).
+Часто вы приблизительно знаете, сколько времени займет выполнение заданий в очереди. По этой причине Laravel позволяет вам указать значение «тайм-аута». По умолчанию значение времени ожидания равно 60 секундам. Если задание обрабатывается дольше, чем количество секунд, указанное значением тайм-аута, обработчик завершится с ошибкой. Обычно обработчик перезапускается автоматически [диспетчером, настроенным на вашем сервере](#supervisor-configuration).
Максимальное количество секунд, в течение которых могут выполняться задания, можно указать с помощью переключателя `--timeout` в командной строке Artisan:
@@ -1119,11 +1174,14 @@ public $failOnTimeout = true;
$this->fail();
}
-Если вы хотите пометить свою работу как неудавшуюся из-за обнаруженного исключения, то вы можете передать исключение методу `fail`:
+Если вы хотите пометить свою работу как неудавшуюся из-за обнаруженного исключения, то вы можете передать исключение методу `fail`. Или, для удобства, вы можете передать строковое сообщение об ошибке, которое будет автоматически преобразовано в исключение:
$this->fail($exception);
-> {tip} Для получения дополнительной информации об обработке невыполненных заданий обратитесь к [документации по разбору неудачных заданий](#dealing-with-failed-jobs).
+ $this->fail('Something went wrong.');
+
+> **Примечание**\
+> Для получения дополнительной информации об обработке невыполненных заданий обратитесь к [документации по разбору неудачных заданий](#dealing-with-failed-jobs).
## Пакетная обработка заданий
@@ -1201,7 +1259,8 @@ php artisan migrate
Идентификатор пакета, к которому можно получить доступ через свойство `$batch->id`, можно использовать для [запроса к командной шине Laravel](#inspecting-batches) для получения информации о пакете после того, как он был отправлен.
-> {note} Поскольку замыкания сериализуются и выполняются позже очередью Laravel, то вам не следует использовать переменную `$this` в замыканиях.
+> **Предупреждение**\
+> Поскольку замыкания в пакете заданий сериализуются и выполняются позже очередью Laravel, то вы не должны использовать переменную `$this` в замыканиях пакета заданий.
#### Именованные пакеты заданий
@@ -1282,7 +1341,8 @@ php artisan migrate
}));
}
-> {note} Вы можете добавлять задания в пакет только из задания, которое принадлежит к тому же пакету.
+> **Предупреждение**\
+> Вы можете добавлять задания в пакет только из задания, которое принадлежит к тому же пакету.
### Инспектирование пакета
@@ -1410,6 +1470,10 @@ php artisan queue:retry-batch 32dbc76c-4f82-4749-b610-a639fe0099b5
$schedule->command('queue:prune-batches --hours=48 --unfinished=72')->daily();
+Так же ваша таблица `jobs_batches` может накапливать записи об отмененных пакетах. Вы можете указать команде `queue:prune-batches` удалять записи об отмененных пакетах, используя опцию `cancelled`:
+
+ $schedule->command('queue:prune-batches --hours=48 --cancelled=72')->daily();
+
## Анонимные очереди
@@ -1431,6 +1495,8 @@ php artisan queue:retry-batch 32dbc76c-4f82-4749-b610-a639fe0099b5
// Это задание завершилось неудачно ...
});
+> **Примечание**\ Поскольку замыкания в `catch` сериализуются и выполняются позже очередью Laravel, то вы не должны использовать переменную `$this` в замыканиях `catch`.
+
## Запуск обработчика очереди
@@ -1443,7 +1509,14 @@ Laravel включает команду Artisan, которая запускае
php artisan queue:work
```
-> {tip} Чтобы процесс `queue:work` постоянно работал в фоновом режиме, вы должны использовать диспетчер процессов, такой как [Supervisor](#supervisor-configuration), чтобы гарантировать, что обработчик очереди не перестанет работать.
+> **Примечание**\
+> Чтобы процесс `queue:work` постоянно работал в фоновом режиме, вы должны использовать диспетчер процессов, такой как [Supervisor](#supervisor-configuration), чтобы гарантировать, что обработчик очереди не перестанет работать.
+
+Вы можете использовать флаг `-v` при вызове команды `queue:work`, если вы хотите, чтобы идентификаторы обработанных заданий были включены в вывод команды:
+
+```shell
+php artisan queue:work -v
+```
Помните, что обработчики очереди – это долгоживущие процессы, которые хранят состояние загруженного приложения в памяти. В результате они не заметят изменений в вашей кодовой базе после их запуска. Итак, во время процесса развертывания обязательно [перезапустите своих обработчиков очереди](#queue-workers-and-deployment). Кроме того, помните, что любое статическое состояние, созданное или измененное вашим приложением, не будет автоматически пробрасываться между заданиями.
@@ -1545,7 +1618,8 @@ php artisan queue:restart
Эта команда укажет всем обработчикам очереди корректно выйти после завершения обработки своего текущего задания, чтобы существующие задания не были потеряны. Поскольку обработчики очереди выйдут при выполнении команды `queue:restart`, вы должны запустить диспетчер процессов, такой как [Supervisor](#supervisor-configuration), для автоматического перезапуска обработчиков очереди.
-> {tip} Очередь использует [кеш](cache.md) для хранения сигналов перезапуска, поэтому перед использованием этой функции необходимо убедиться, что драйвер кеша правильно настроен для приложения.
+> **Примечание**\
+> Очередь использует [кеш](cache.md) для хранения сигналов перезапуска, поэтому перед использованием этой функции необходимо убедиться, что драйвер кеша правильно настроен для приложения.
### Истечение срока и тайм-ауты задания
@@ -1555,12 +1629,13 @@ php artisan queue:restart
В вашем файле конфигурации `config/queue.php` каждое соединение с очередью определяет параметр `retry_after`. Этот параметр указывает, сколько секунд соединение очереди должно ждать перед повторной попыткой выполнения задания, которое обрабатывается. Например, если значение `retry_after` установлено на `90`, задание будет возвращено в очередь, если оно обрабатывалось в течение 90 секунд, но не было высвобождено или удалено. Как правило, вы должны установить значение `retry_after` на максимальное количество секунд, которое может потребоваться вашим заданиям для завершения обработки.
-> {note} Единственное соединение очереди, которое не содержит значения `retry_after` – это Amazon SQS. SQS будет повторять выполнение задания в соответствии с [таймаутом видимости по умолчанию](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html), управляемый консолью AWS.
+> **Предупреждение**\
+> Единственное соединение очереди, которое не содержит значения `retry_after` – это Amazon SQS. SQS будет повторять выполнение задания в соответствии с [таймаутом видимости по умолчанию](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html), управляемый консолью AWS.
#### Тайм-ауты обработчиков
-Команда `queue:work` Artisan также содержит параметр `--timeout`. Если задание обрабатывается дольше, чем количество секунд, указанное значением тайм-аута, Обработчик, выполняющий задание, завершится с ошибкой. Обычно обработчик перезапускается автоматически [диспетчером, настроенным на вашем сервере](#supervisor-configuration):
+Команда `queue:work` Artisan также содержит параметр `--timeout`. По умолчанию значение времени ожидания равно 60 секундам. Если задание обрабатывается дольше, чем количество секунд, указанное значением тайм-аута, Обработчик, выполняющий задание, завершится с ошибкой. Обычно обработчик перезапускается автоматически [диспетчером, настроенным на вашем сервере](#supervisor-configuration):
```shell
php artisan queue:work --timeout=60
@@ -1568,7 +1643,8 @@ php artisan queue:work --timeout=60
Параметр конфигурации `retry_after` и параметр `--timeout` Artisan отличаются, но работают вместе, чтобы гарантировать, что задания не будут потеряны и что задания будут успешно обработаны только один раз.
-> {note} Значение `--timeout` всегда должно быть как минимум на несколько секунд короче, чем ваше значение конфигурации `retry_after`. Это гарантирует, что обрабатывающий замороженное задание обработчик, всегда завершает работу перед повторной попыткой выполнения задания. Если параметр `--timeout` выше значения конфигурации `retry_after`, то ваши задания могут быть обработаны дважды.
+> **Предупреждение**\
+> Значение `--timeout` всегда должно быть как минимум на несколько секунд короче, чем ваше значение конфигурации `retry_after`. Это гарантирует, что обрабатывающий замороженное задание обработчик, всегда завершает работу перед повторной попыткой выполнения задания. Если параметр `--timeout` выше значения конфигурации `retry_after`, то ваши задания могут быть обработаны дважды.
## Конфигурация Supervisor
@@ -1586,7 +1662,8 @@ Supervisor – это диспетчер процессов для операц
sudo apt-get install supervisor
```
-> {tip} Если настройка Supervisor и управление им самостоятельно кажется ошеломляющим, рассмотрите возможность использования [Laravel Forge](https://forge.laravel.com), который автоматически установит и настроит Supervisor для ваших проектов Laravel.
+> **Примечание**\
+> Если настройка Supervisor и управление им самостоятельно кажется ошеломляющим, рассмотрите возможность использования [Laravel Forge](https://forge.laravel.com), который автоматически установит и настроит Supervisor для ваших проектов Laravel.
#### Настройка Supervisor
@@ -1610,7 +1687,8 @@ stopwaitsecs=3600
В этом примере директива `numprocs` укажет Supervisor запустить восемь процессов `queue:work` и отслеживать их все, автоматически перезапуская их в случае сбоя. Вы должны изменить директиву `command` конфигурации, чтобы отразить желаемое соединение с очередью и параметры обработчика.
-> {note} Вы должны убедиться, что значение `stopwaitsecs` больше, чем количество секунд, затраченных на выполнение вашего самого продолжительного задания. В противном случае Supervisor может убить задание до того, как оно завершит обработку.
+> **Предупреждение**\
+> Вы должны убедиться, что значение `stopwaitsecs` больше, чем количество секунд, затраченных на выполнение вашего самого продолжительного задания. В противном случае Supervisor может убить задание до того, как оно завершит обработку.
#### Запуск Supervisor
@@ -1747,7 +1825,8 @@ php artisan queue:work redis --tries=3 --backoff=3
}
}
-> {note} Перед вызовом метода `failed` создается новый экземпляр задания; поэтому любые изменения свойств класса, которые могли произойти в методе `handle`, будут потеряны.
+> **Предупреждение**\
+> Перед вызовом метода `failed` создается новый экземпляр задания; поэтому любые изменения свойств класса, которые могли произойти в методе `handle`, будут потеряны.
### Повторная попытка выполнения неудачных заданий
@@ -1788,7 +1867,8 @@ php artisan queue:retry all
php artisan queue:forget 91401d2c-0784-4f43-824c-34f94a33c24d
```
-> {tip} При использовании [Horizon](horizon.md) вы должны использовать команду `horizon:forget` для удаления неудачного задания вместо команды `queue:forget`.
+> **Примечание**\
+> При использовании [Horizon](horizon.md) вы должны использовать команду `horizon:forget` для удаления неудачного задания вместо команды `queue:forget`.
Чтобы удалить все неудачные задания из таблицы `failed_jobs`, вы можете использовать команду `queue:flush`:
@@ -1813,13 +1893,13 @@ php artisan queue:flush
### Удаление неудачных заданий
-Вы можете удалить все записи в таблице `failed_jobs` вашего приложения, вызвав команду `queue:prune-failed` Artisan:
+Вы можете очистить все записи в таблице `failed_jobs` вашего приложения, вызвав команду `queue:prune-failed` Artisan:
```shell
php artisan queue:prune-failed
```
-Если вы укажете для команды параметр `--hours`, то будут сохранены записи о неудачных заданиях, которые были вставлены только в течение последних `N` часов. Например, следующая команда удалит все записи неудачных заданий, которые были вставлены более 48 часов назад:
+По умолчанию все записи о невыполненных заданиях старше 24 часов будут удалены. Если вы укажете для команды параметр `--hours`, то будут сохранены записи о неудачных заданиях, которые были вставлены только в течение последних `N` часов. Например, следующая команда удалит все записи неудачных заданий, которые были вставлены более 48 часов назад:
```shell
php artisan queue:prune-failed --hours=48
@@ -1902,7 +1982,8 @@ QUEUE_FAILED_DRIVER=null
## Удаление заданий из очередей
-> {tip} При использовании [Horizon](horizon.md) вы должны использовать команду `horizon:clear` для удаления заданий из очереди вместо команды `queue:clear`.
+> **Примечание**\
+> При использовании [Horizon](horizon.md) вы должны использовать команду `horizon:clear` для удаления заданий из очереди вместо команды `queue:clear`.
Если вы хотите удалить все задания, принадлежащие соединению и очереди по умолчанию, вы можете сделать это с помощью команды `queue:clear` Artisan:
@@ -1916,7 +1997,8 @@ php artisan queue:clear
php artisan queue:clear redis --queue=emails
```
-> {note} Удаление заданий из очередей доступно только для драйверов очереди SQS, Redis и базы данных. Кроме того, процесс удаления в SQS занимает до 60 секунд, поэтому задания, отправленные в очередь SQS в течение 60 секунд после очистки очереди, также могут быть удалены.
+> **Предупреждение**\
+> Удаление заданий из очередей доступно только для драйверов очереди SQS, Redis и базы данных. Кроме того, процесс удаления в SQS занимает до 60 секунд, поэтому задания, отправленные в очередь SQS в течение 60 секунд после очистки очереди, также могут быть удалены.
## Мониторинг ваших очередей
diff --git a/docs/rate-limiting.md b/docs/rate-limiting.md
index 6faaea0..3b8e9ef 100644
--- a/docs/rate-limiting.md
+++ b/docs/rate-limiting.md
@@ -11,7 +11,8 @@
Laravel включает простую в использовании абстракцию ограничения частоты, которая в сочетании с [кешем](cache.md) вашего приложения обеспечивает простой способ ограничить любое действие в течение указанного периода времени.
-> {tip} Если вас интересует ограничение частоты входящих HTTP-запросов, обратитесь к [документации посредников](routing.md#rate-limiting).
+> **Примечание**\
+> Если вас интересует ограничение частоты входящих HTTP-запросов, обратитесь к [документации посредников](routing.md#rate-limiting).
### Конфигурация кеша
diff --git a/docs/redis.md b/docs/redis.md
index 276e545..24895cb 100644
--- a/docs/redis.md
+++ b/docs/redis.md
@@ -264,7 +264,8 @@ composer require predis/predis
$redis->incr('total_visits', 1);
});
-> {note} При определении транзакции Redis вы не можете получать какие-либо значения из соединения Redis. Помните, ваша транзакция выполняется как одна атомарная операция, и эта операция не выполнится, пока не завершится выполнение всех команд замыкания.
+> **Предупреждение**\
+> При определении транзакции Redis вы не можете получать какие-либо значения из соединения Redis. Помните, ваша транзакция выполняется как одна атомарная операция, и эта операция не выполнится, пока не завершится выполнение всех команд замыкания.
#### Скрипты Lua
@@ -284,7 +285,8 @@ composer require predis/predis
return counter
LUA, 2, 'first-counter', 'second-counter');
-> {note} Пожалуйста, обратитесь к [документации Redis](https://redis.io/commands/eval) для получения дополнительных сведений о сценариях Redis.
+> **Предупреждение**\
+> Пожалуйста, обратитесь к [документации Redis](https://redis.io/commands/eval) для получения дополнительных сведений о сценариях Redis.
### Конвейерное выполнение команд
diff --git a/docs/releases.md b/docs/releases.md
index d538560..45022f0 100644
--- a/docs/releases.md
+++ b/docs/releases.md
@@ -26,8 +26,8 @@ Laravel и другие его собственные пакеты следую
| 6 (LTS) | 7.2 - 8.0 | 3 сентября 2019 | 25 января 2022 | 6 сентября 2022 |
| 7 | 7.2 - 8.0 | 3 марта 2020 | 6 октября 2020 | 3 марта 2021 |
| 8 | 7.3 - 8.1 | 8 сентября 2020 | 26 июля 2022 | 24 января 2023 |
-| 9 | 8.0 - 8.1 | 8 февраля 2022 | 8 августа 2023 | 8 февраля 2024 |
-| 10 | 8.1 | 7 февраля 2023 | 7 августа 2024 | 7 февраля 2025 |
+| 9 | 8.0 - 8.2 | 8 февраля 2022 | 8 августа 2023 | 6 февраля 2024 |
+| 10 | 8.1 - 8.2 | 7 февраля 2023 | 6 августа 2024 | 4 февраля 2025 |
@@ -260,7 +264,8 @@ Sanctum также обеспечивает простой метод аутен
Во-первых, вы должны настроить, из каких доменов ваш SPA будет делать запросы. Вы можете указать эти домены, используя параметр `stateful` в конфигурационном файле `sanctum`. Этот параметр конфигурации определяет, какие домены будут поддерживать аутентификацию с «фиксацией» на основе файлов cookie сессии Laravel при выполнении запросов к вашему API.
-> {note} Если вы обращаетесь к своему приложению через URL-адрес, содержащий порт (например, `127.0.0.1:8000`), то вы должны убедиться, что указали номер порта вместе с доменом.
+> **Предупреждение**\
+> Если вы обращаетесь к своему приложению через URL-адрес, содержащий порт (например, `127.0.0.1:8000`), то вы должны убедиться, что указали номер порта вместе с доменом.
#### Посредник Sanctum
@@ -315,7 +320,8 @@ axios.get('/sanctum/csrf-cookie').then(response => {
Конечно, если сессия вашего пользователя истекает из-за отсутствия активности, то последующие запросы к приложению Laravel могут получить ответ об ошибках `401` или `419` HTTP. В этом случае вы должны перенаправить пользователя на страницу входа в SPA.
-> {note} Вы можете написать свою собственную конечную точку `/login`; однако, вы должны убедиться, что он аутентифицирует пользователя, используя стандартные [службы аутентификации на основе сессии](authentication.md#authenticating-users), которые предлагает Laravel. Обычно это означает использование охранника аутентификации `web`.
+> **Предупреждение**\
+> Вы можете написать свою собственную конечную точку `/login`; однако, вы должны убедиться, что он аутентифицирует пользователя, используя стандартные [службы аутентификации на основе сессии](authentication.md#authenticating-users), которые предлагает Laravel. Обычно это означает использование охранника аутентификации `web`.
### Защита маршрутов SPA
@@ -340,9 +346,9 @@ axios.get('/sanctum/csrf-cookie').then(response => {
```js
window.Echo = new Echo({
broadcaster: "pusher",
- cluster: process.env.MIX_PUSHER_APP_CLUSTER,
+ cluster: import.meta.env.VITE_PUSHER_APP_CLUSTER,
encrypted: true,
- key: process.env.MIX_PUSHER_APP_KEY,
+ key: import.meta.env.VITE_PUSHER_APP_KEY,
authorizer: (channel, options) => {
return {
authorize: (socketId, callback) => {
@@ -399,7 +405,8 @@ window.Echo = new Echo({
Когда мобильное приложение использует токен для запроса API к вашему приложению, оно должно передать токен в заголовке `Authorization` как `Bearer`-токен.
-> {tip} При выдаче токенов для мобильного приложения вы также можете указать [полномочия токена](#token-abilities).
+> **Примечание**\
+> При выдаче токенов для мобильного приложения вы также можете указать [полномочия токена](#token-abilities).
### Защита маршрутов API мобильного приложения
diff --git a/docs/scheduling.md b/docs/scheduling.md
index 6f94936..55e7daf 100644
--- a/docs/scheduling.md
+++ b/docs/scheduling.md
@@ -117,6 +117,7 @@ php artisan schedule:list
`->everyThirtyMinutes();` | – каждые 30 минут
`->hourly();` | – каждый час
`->hourlyAt(17);` | – в 17 минут каждого часа
+`->everyOddHour();` | – каждый нечетный час
`->everyTwoHours();` | – каждые 2 часа
`->everyThreeHours();` | – каждые 3 часа
`->everyFourHours();` | – каждые 4 часа
@@ -124,6 +125,7 @@ php artisan schedule:list
`->daily();` | – каждый день в полночь
`->dailyAt('13:00');` | – ежедневно в 13:00
`->twiceDaily(1, 13);` | – ежедневно дважды в день: в 1:00 и 13:00
+`->twiceDailyAt(1, 13, 15);` | – ежедневно в 1:15 и 13:15
`->weekly();` | – еженедельно в воскресенье в 00:00
`->weeklyOn(1, '8:00');` | – еженедельно в понедельник в 8:00
`->monthly();` | – ежемесячно первого числа в 00:00
@@ -131,6 +133,7 @@ php artisan schedule:list
`->twiceMonthly(1, 16, '13:00');` | – ежемесячно дважды в месяц: 1 и 16 числа в 13:00
`->lastDayOfMonth('15:00');` | – ежемесячно в последний день месяца в 15:00
`->quarterly();` | – ежеквартально в первый день в 00:00
+`->quarterlyOn(4, '14:00');` | – ежеквартально 4 числа в 14:00
`->yearly();` | – ежегодно в первый день в 00:00
`->yearlyOn(6, 1, '17:00');` | – ежегодно в июне первого числа в 17:00
`->timezone('America/New_York');` | Установить часовой пояс для задачи
@@ -247,7 +250,8 @@ php artisan schedule:list
return 'America/Chicago';
}
-> {note} Помните, что в некоторых часовых поясах используется летнее время. Когда происходит переход на летнее время, ваша запланированная задача может запускаться дважды или даже не запускаться вообще. По этой причине мы рекомендуем по возможности избегать указаний часовых поясов при планировании.
+> **Предупреждение**\
+> Помните, что в некоторых часовых поясах используется летнее время. Когда происходит переход на летнее время, ваша запланированная задача может запускаться дважды или даже не запускаться вообще. По этой причине мы рекомендуем по возможности избегать указаний часовых поясов при планировании.
### Предотвращение дублирования задач
@@ -267,7 +271,8 @@ php artisan schedule:list
### Выполнение задач на одном сервере
-> {note} Чтобы использовать этот функционал, ваше приложение должно использовать по умолчанию один из следующих драйверов кеша: `database`, `memcached`, `dynamodb` или `redis`. Кроме того, все серверы должны взаимодействовать с одним и тем же центральным сервером кеширования.
+> **Предупреждение**\
+> Чтобы использовать этот функционал, ваше приложение должно использовать по умолчанию один из следующих драйверов кеша: `database`, `memcached`, `dynamodb` или `redis`. Кроме того, все серверы должны взаимодействовать с одним и тем же центральным сервером кеширования.
Если планировщик вашего приложения работает на нескольких серверах, то вы можете ограничить выполнение запланированного задания только на одном сервере. Например, предположим, что у вас есть запланированная задача, по которой каждую пятницу вечером создается новый отчет. Если планировщик задач работает на трех рабочих серверах, запланированная задача будет запущена на всех трех серверах и трижды сгенерирует отчет. Не очень хорошо!
@@ -278,6 +283,33 @@ php artisan schedule:list
->at('17:00')
->onOneServer();
+
+#### Именование заданий на одном сервере
+
+Иногда требуется запланировать отправку одного и того же задания с разными параметрами, при этом указывая Laravel выполнять каждое задание на одном сервере. Для этого вы можете присвоить каждому определению расписания уникальное имя с помощью метода `name`:
+
+```php
+$schedule->job(new CheckUptime('https://laravel.com'))
+ ->name('check_uptime:laravel.com')
+ ->everyFiveMinutes()
+ ->onOneServer();
+
+$schedule->job(new CheckUptime('https://vapor.laravel.com'))
+ ->name('check_uptime:vapor.laravel.com')
+ ->everyFiveMinutes()
+ ->onOneServer();
+```
+
+Точно так же анонимным заданиям должно быть присвоено имя, если они предназначены для запуска на одном сервере:
+
+```php
+$schedule->call(fn () => User::resetApiRequestCount())
+ ->name('reset-api-request-count')
+ ->daily()
+ ->onOneServer();
+```
+
+
### Фоновые задачи
@@ -287,7 +319,8 @@ php artisan schedule:list
->daily()
->runInBackground();
-> {note} Метод `runInBackground` может использоваться только при планировании задач с помощью методов `command` и `exec`.
+> **Предупреждение**\
+> Метод `runInBackground` может использоваться только при планировании задач с помощью методов `command` и `exec`.
### Режим технического обслуживания
@@ -344,7 +377,8 @@ php artisan schedule:work
->daily()
->emailOutputOnFailure('taylor@example.com');
-> {note} Методы `emailOutputTo`, `emailOutputOnFailure`, `sendOutputTo`, and `appendOutputTo` могут использоваться только при планировании задач с помощью методов `command` и `exec`.
+> **Предупреждение**\
+> Методы `emailOutputTo`, `emailOutputOnFailure`, `sendOutputTo` и `appendOutputTo` могут использоваться только при планировании задач с помощью методов `command` и `exec`.
## Хуки выполнения задачи
diff --git a/docs/scout.md b/docs/scout.md
index d8cfc08..a042472 100644
--- a/docs/scout.md
+++ b/docs/scout.md
@@ -99,7 +99,8 @@ MEILISEARCH_KEY=masterKey
Кроме того, вам следует убедиться, что вы установили версию `meilisearch/meilisearch-php`, совместимую с вашей версией MeiliSearch, просмотрев [документацию MeiliSearch о совместимости](https://github.com/meilisearch/meilisearch-php#-compatibility-with-meilisearch).
-> {note} При обновлении Scout в приложении, которое использует MeiliSearch, вы всегда должны [просматривать любые дополнительные критические изменения](https://github.com/meilisearch/MeiliSearch/releases) в самой службе MeiliSearch.
+> **Предупреждение**\
+> При обновлении Scout в приложении, которое использует MeiliSearch, вы всегда должны [просматривать любые дополнительные критические изменения](https://github.com/meilisearch/MeiliSearch/releases) в самой службе MeiliSearch.
### Постановка в очередь
@@ -112,6 +113,13 @@ MEILISEARCH_KEY=masterKey
Даже когда для параметра `queue` установлено значение `false`, важно помнить, что некоторые драйверы Scout, такие как Algolia и MeiliSearch, всегда индексируют записи асинхронно. Это означает, что даже если операция индексирования завершена в вашем приложении Laravel, то сама поисковая система может не сразу отображать новые и обновленные записи.
+Чтобы указать соединение и очередь, которые используют ваши задания Scout, вы можете определить параметр конфигурации `queue` как массив:
+
+ 'queue' => [
+ 'connection' => 'redis',
+ 'queue' => 'scout'
+ ],
+
## Конфигурирование
@@ -173,6 +181,59 @@ MEILISEARCH_KEY=masterKey
}
}
+Некоторые поисковые системы, такие как MeiliSearch, будут выполнять операции фильтрации (`>`, `<` и т. д.) только для корректных данных. Итак, при использовании этих поисковых систем и настройке поисковых данных вы должны убедиться, что числовые значения приведены к корректному типу:
+
+ public function toSearchableArray()
+ {
+ return [
+ 'id' => (int) $this->id,
+ 'name' => $this->name,
+ 'price' => (float) $this->price,
+ ];
+ }
+
+
+#### Настройка фильтруемых данных и параметров индекса (MeiliSearch)
+
+В отличие от других драйверов Scout, MeiliSearch требует, чтобы вы предварительно определили параметры поиска по индексу, такие как фильтруемые, сортируемые атрибуты и [другие поддерживаемые поля настроек](https://docs.meilisearch.com/reference/api/settings.html).
+
+Фильтруемые атрибуты — это любые атрибуты, которые вы планируете фильтровать при вызове метода `where` Scout, а сортируемые атрибуты – это любые атрибуты, по которым вы планируете сортировать при вызове метода `orderBy` Scout. Чтобы определить параметры индекса, настройте параметр `index-settings` в конфигурации `meilisearch` в конфигурационном файле `scout` вашего приложения:
+
+```php
+use App\Models\User;
+use App\Models\Flight;
+
+'meilisearch' => [
+ 'host' => env('MEILISEARCH_HOST', 'http://localhost:7700'),
+ 'key' => env('MEILISEARCH_KEY', null),
+ 'index-settings' => [
+ User::class => [
+ 'filterableAttributes'=> ['id', 'name', 'email'],
+ 'sortableAttributes' => ['created_at'],
+ // Другие поля настроек ...
+ ],
+ Flight::class => [
+ 'filterableAttributes'=> ['id', 'destination'],
+ 'sortableAttributes' => ['updated_at'],
+ ],
+ ],
+],
+```
+
+Если индексируемая модель допускает программное удаление и включена в массив `index-settings`, Scout автоматически включит поддержку фильтрации программно удаляемых моделей в этом индексе. Если у вас нет других фильтруемых или сортируемых атрибутов для определения индекса программно удаляемой модели, то вы можете просто добавить пустую запись в массив `index-settings` для этой модели:
+
+```php
+'index-settings' => [
+ Flight::class => []
+],
+```
+
+После настройки параметров индекса вашего приложения вы должны вызвать команду `scout:sync-index-settings` Artisan. Эта команда сообщит MeiliSearch о ваших текущих настройках индекса. Для удобства вы можете сделать эту команду частью процесса развертывания:
+
+```shell
+php artisan scout:sync-index-settings
+```
+
### Настройка идентификатора модели
@@ -255,7 +316,8 @@ SCOUT_IDENTIFY=true
### Поисковая система `database`
-> {note} Поисковая система `database` в настоящее время поддерживает MySQL и PostgreSQL.
+> **Предупреждение**\
+> Поисковая система `database` в настоящее время поддерживает MySQL и PostgreSQL.
Если ваше приложение взаимодействует с базами данных малого и среднего размера или имеет небольшую рабочую нагрузку, то вам может быть удобнее начать работу с поисковой системой `database` Scout. Поисковая система базы данных будет использовать выражения `where like` и полнотекстовые индексы при фильтрации результатов из вашей существующей базы данных, чтобы определить применимые результаты поиска для вашего запроса.
@@ -295,7 +357,8 @@ public function toSearchableArray()
}
```
-> {note} Прежде чем указать, что столбец должен использовать ограничения полнотекстового запроса, убедитесь, что столбцу назначен [полнотекстовый индекс](migrations.ms#available-index-types).
+> **Предупреждение**\
+> Прежде чем указать, что столбец должен использовать ограничения полнотекстового запроса, убедитесь, что столбцу назначен [полнотекстовый индекс](migrations.ms#available-index-types).
### Поисковая система `collection`
@@ -380,7 +443,8 @@ php artisan scout:flush "App\Models\Post"
$orders->searchable();
-> {tip} Метод `searchable` можно считать операцией «обновления-вставки». Другими словами, если запись модели уже есть в вашем индексе, то она будет обновлена. Если записи нет в поисковом индексе, то она будет добавлен в индекс.
+> **Примечание**\
+> Метод `searchable` можно считать операцией «обновления-вставки». Другими словами, если запись модели уже есть в вашем индексе, то она будет обновлена. Если записи нет в поисковом индексе, то она будет добавлен в индекс.
### Обновление записей
@@ -458,7 +522,8 @@ php artisan scout:flush "App\Models\Post"
Метод `shouldBeSearchable` учитывается при манипулировании моделями через запросы, отношения или методы `save` и `create`. Непосредственное указание доступности моделей или коллекций для поиска с помощью метода `searchable` переопределит результат метода `shouldBeSearchable`.
-> {note} Метод `shouldBeSearchable` неприменим при использовании поисковой системы `database` Scout, поскольку все доступные для поиска данные всегда хранятся в базе данных. Чтобы добиться аналогичного поведения при использовании поисковой системы `database`, вместо этого следует использовать [выражения `where`](#where-clauses).
+> **Предупреждение**\
+> Метод `shouldBeSearchable` неприменим при использовании поисковой системы `database` Scout, поскольку все доступные для поиска данные всегда хранятся в базе данных. Чтобы добиться аналогичного поведения при использовании поисковой системы `database`, вместо этого следует использовать [выражения `where`](#where-clauses).
## Поиск
@@ -508,6 +573,9 @@ Scout позволяет добавлять к поисковым запроса
Поскольку поисковый индекс не является реляционной базой данных, более сложные выражения `WHERE` в настоящее время не поддерживаются.
+> **Предупреждение**\
+> Если ваше приложение использует MeiliSearch, то вы должны настроить [фильтруемые атрибуты](#configuring-filterable-data-for-meilisearch) вашего приложения, прежде чем использовать выражения `where` Scout.
+
### Постраничная навигация
@@ -542,6 +610,9 @@ Scout позволяет добавлять к поисковым запроса
return Order::search($request->input('query'))->paginate(15);
});
+> **Предупреждение**\
+> Поскольку поисковые системы не знают об определениях [глобальных областей запроса](eloquent.md#global-scopes) вашей модели Eloquent, вам не следует использовать глобальные области в приложениях, использующих разбиение на страницы Scout. Или вам следует воссоздать ограничения глобальной области запроса при поиске через Scout.
+
### Программное удаление
@@ -559,7 +630,8 @@ Scout позволяет добавлять к поисковым запроса
// Вывести только удаленные записи при получении результатов ...
$orders = Order::search('Star Trek')->onlyTrashed()->get();
-> {tip} Если модель будет окончательно удалена с помощью `forceDelete`, то Scout автоматически удалит ее из поискового индекса.
+> **Примечание**\
+> Если модель будет окончательно удалена с помощью `forceDelete`, то Scout автоматически удалит ее из поискового индекса.
### Изменение техники поиска
diff --git a/docs/seeding.md b/docs/seeding.md
index 37723ca..532c784 100644
--- a/docs/seeding.md
+++ b/docs/seeding.md
@@ -12,7 +12,8 @@
Laravel предлагает возможность наполнения базы данных с использованием классов-наполнителей. Все классы наполнителей хранятся в каталоге `database/seeders`. Класс `DatabaseSeeder` уже определен по умолчанию. В этом классе вы можете использовать метод `call` для запуска других наполнителей, что позволит вам контролировать порядок наполнения БД.
-> {tip} При наполнении базы данных автоматически отключается защита [массового присвоения](eloquent.md#mass-assignment).
+> **Примечание**\
+> При наполнении базы данных автоматически отключается защита [массового присвоения](eloquent.md#mass-assignment).
## Написание наполнителей
@@ -23,7 +24,7 @@ Laravel предлагает возможность наполнения баз
php artisan make:seeder UserSeeder
```
-Класс наполнителя по умолчанию содержит только один метод: `run`. Этот метод вызывается при выполнении команды `db:seed` Artisan. В методе `run` вы можете вставлять данные в свою базу данных, как хотите. Вы можете использовать [построитель запросов](queries.md) для самостоятельной вставки данных или использовать [фабрики моделей Eloquent](database-testing.md#defining-model-factories).
+Класс наполнителя по умолчанию содержит только один метод: `run`. Этот метод вызывается при выполнении команды `db:seed` Artisan. В методе `run` вы можете вставлять данные в свою базу данных, как хотите. Вы можете использовать [построитель запросов](queries.md) для самостоятельной вставки данных или использовать [фабрики моделей Eloquent](eloquent-factories.md).
В качестве примера давайте изменим класс `DatabaseSeeder`, созданный по умолчанию, и добавим выражение вставки фасада `DB` в методе `run`:
@@ -53,12 +54,13 @@ php artisan make:seeder UserSeeder
}
}
-> {tip} В методе `run` вы можете объявить любые необходимые типы зависимостей. Они будут автоматически извлечены и внедрены через [контейнер служб](container.md) Laravel.
+> **Примечание**\
+> В методе `run` вы можете объявить любые необходимые типы зависимостей. Они будут автоматически извлечены и внедрены через [контейнер служб](container.md) Laravel.
### Использование фабрик моделей
-Конечно, ручное указание атрибутов для каждой модели наполнителя обременительно. Вместо этого вы можете использовать [фабрики моделей](database-testing.md#defining-model-factories) для удобного создания большого количества записей в БД. Сначала просмотрите [документацию фабрики моделей](database-testing.md#defining-model-factories), чтобы узнать, как определить свои фабрики.
+Конечно, ручное указание атрибутов для каждой модели наполнителя обременительно. Вместо этого вы можете использовать [фабрики моделей](eloquent-factories.md) для удобного создания большого количества записей в БД. Сначала просмотрите [документацию фабрики моделей](eloquent-factories.md), чтобы узнать, как определить свои фабрики.
Например, давайте создадим 50 пользователей, у каждого из которых будет по одному посту:
@@ -136,10 +138,12 @@ php artisan db:seed
php artisan db:seed --class=UserSeeder
```
-Вы также можете заполнить свою базу данных с помощью команды `migrate:fresh` в сочетании с параметром `--seed`, которая удалит все таблицы и повторно запустит все ваши миграции. Эта команда полезна для полного перестроения вашей базы данных:
+Вы также можете заполнить свою базу данных с помощью команды `migrate:fresh` в сочетании с параметром `--seed`, которая удалит все таблицы и повторно запустит все ваши миграции. Эта команда полезна для полного перестроения вашей базы данных. Параметр `--seeder` может использоваться для указания конкретного наполнителя для запуска:
```shell
php artisan migrate:fresh --seed
+
+php artisan migrate:fresh --seed --seeder=UserSeeder
```
diff --git a/docs/session.md b/docs/session.md
index 6e87620..ed6263e 100644
--- a/docs/session.md
+++ b/docs/session.md
@@ -39,7 +39,8 @@ Laravel предлагает множество различных типов х
-> {tip} Драйвер `array` в основном используется во время [тестирования](testing.md) и предотвращает сохранение данных, находящихся в сессии.
+> **Примечание**\
+> Драйвер `array` в основном используется во время [тестирования](testing.md) и предотвращает сохранение данных, находящихся в сессии.
### Предварительная подготовка драйверов
@@ -71,7 +72,8 @@ php artisan migrate
Перед использованием Redis с Laravel вам нужно будет либо установить расширение PHP PhpRedis через PECL, либо установить пакет `predis/predis` (~ 1.0) через Composer. Для получения дополнительной информации о настройке Redis обратитесь к [документации Redis](redis.md#configuration) Laravel.
-> {tip} В параметре `connection` конфигурационного файла `config/session.php` указывается, какое соединение Redis используется сессией.
+> **Примечание**\
+> В параметре `connection` конфигурационного файла `config/session.php` указывается, какое соединение Redis используется сессией.
## Взаимодействие с сессией
@@ -129,7 +131,8 @@ php artisan migrate
session(['key' => 'value']);
});
-> {tip} Существует небольшая практическая разница между использованием сессии через экземпляр HTTP-запроса и использованием глобального помощника `session`. Оба метода [тестируемые](testing.md) с помощью метода `assertSessionHas`, который доступен во всех ваших тестах.
+> **Примечание**\
+> Существует небольшая практическая разница между использованием сессии через экземпляр HTTP-запроса и использованием глобального помощника `session`. Оба метода [тестируемые](testing.md) с помощью метода `assertSessionHas`, который доступен во всех ваших тестах.
#### Получение всех данных сессии
@@ -153,7 +156,7 @@ php artisan migrate
//
}
-Чтобы определить отсутствие элемента в сессии, вы можете использовать метод `missing`. Метод `missing` возвращает `true`, если элемент отсутствует или если он равен `null`:
+Чтобы определить отсутствие элемента в сессии, вы можете использовать метод `missing`. Метод `missing` возвращает `true`, если элемент отсутствует:
if ($request->session()->missing('users')) {
//
@@ -243,7 +246,8 @@ Laravel автоматически пересоздает идентификат
## Блокировка сессии
-> {note} Чтобы использовать блокировку сессии, ваше приложение должно использовать драйвер кеша с поддержкой [атомарных блокировок](cache.md#atomic-locks). В настоящее время этими драйверами кеширования являются `memcached`, `dynamodb`, `redis` и `database`. Кроме того, вы не можете использовать драйвер сессии `cookie`.
+> **Предупреждение**\
+> Чтобы использовать блокировку сессии, ваше приложение должно использовать драйвер кеша с поддержкой [атомарных блокировок](cache.md#atomic-locks). В настоящее время этими драйверами кеширования являются `memcached`, `dynamodb`, `redis` и `database`. Кроме того, вы не можете использовать драйвер сессии `cookie`.
По умолчанию Laravel позволяет конкурентное выполнение запросов, использующих одну и ту же сессию. Так, например, если вы используете HTTP-библиотеку JavaScript для выполнения двух HTTP-запросов к вашему приложению, то они оба будут выполняться одновременно. Для многих приложений это не проблема; однако в некоторых приложениях, выполняющих запросы с записью данных в сессию и к двум различным конечным точкам приложения, может произойти потеря данных сессии.
@@ -289,7 +293,8 @@ Laravel автоматически пересоздает идентификат
public function gc($lifetime) {}
}
-> {tip} Laravel не содержит каталога для хранения ваших расширений. Вы можете разместить их где угодно. В этом примере мы создали каталог `Extensions` для размещения `MongoSessionHandler`.
+> **Примечание**\
+> Laravel не содержит каталога для хранения ваших расширений. Вы можете разместить их где угодно. В этом примере мы создали каталог `Extensions` для размещения `MongoSessionHandler`.
Поскольку цель этих методов не совсем понятна, давайте быстро рассмотрим, что делает каждый из этих методов:
diff --git a/docs/socialite.md b/docs/socialite.md
index c29b7e4..b5dcb27 100644
--- a/docs/socialite.md
+++ b/docs/socialite.md
@@ -16,7 +16,8 @@
Помимо типичной аутентификации на основе форм, Laravel также предлагает простой и удобный способ аутентификации через провайдеров OAuth с помощью [Laravel Socialite](https://github.com/laravel/socialite). Socialite в настоящее время поддерживает аутентификацию через Facebook, Twitter, LinkedIn, Google, GitHub, GitLab, и Bitbucket.
-> {tip} Адаптеры для других платформ перечислены на веб-сайте [Socialite Providers](https://socialiteproviders.com/), управляемом сообществом.
+> **Примечание**\
+> Адаптеры для других платформ перечислены на веб-сайте [Socialite Providers](https://socialiteproviders.com/), управляемом сообществом.
## Установка
@@ -45,7 +46,8 @@ composer require laravel/socialite
'redirect' => 'http://example.com/callback-url',
],
-> {tip} Если параметр `redirect` содержит относительный путь, то он будет автоматически преобразован в абсолютный URL.
+> **Примечание**\
+> Если параметр `redirect` содержит относительный путь, то он будет автоматически преобразован в абсолютный URL.
## Аутентификация
@@ -95,7 +97,8 @@ composer require laravel/socialite
return redirect('/dashboard');
});
-> {tip} О том, какая информация о пользователе доступна у конкретных провайдеров OAuth, ознакомьтесь с документацией по [получению сведений о пользователе](#retrieving-user-details).
+> **Примечание**\
+> О том, какая информация о пользователе доступна у конкретных провайдеров OAuth, ознакомьтесь с документацией по [получению сведений о пользователе](#retrieving-user-details).
### Права доступа
@@ -125,7 +128,8 @@ composer require laravel/socialite
->with(['hd' => 'example.com'])
->redirect();
-> {note} При использовании метода `with` будьте осторожны, чтобы не передавать какие-либо зарезервированные ключевые слова, такие как `state` или `response_type`.
+> **Предупреждение**\
+> При использовании метода `with` будьте осторожны, чтобы не передавать какие-либо зарезервированные ключевые слова, такие как `state` или `response_type`.
## Получение сведений о пользователе
@@ -183,4 +187,5 @@ composer require laravel/socialite
return Socialite::driver('google')->stateless()->user();
-> {note} Аутентификация без сохранения состояния недоступна для драйвера Twitter OAuth 1.0.
+> **Предупреждение**\
+> Аутентификация без сохранения состояния недоступна для драйвера Twitter OAuth 1.0.
diff --git a/docs/starter-kits.md b/docs/starter-kits.md
index 94b2fcf..27d9345 100644
--- a/docs/starter-kits.md
+++ b/docs/starter-kits.md
@@ -3,6 +3,7 @@
- [Введение](#introduction)
- [Laravel Breeze](#laravel-breeze)
- [Установка](#laravel-breeze-installation)
+ - [Breeze и Blade](#breeze-and-blade)
- [Breeze и React / Vue](#breeze-and-inertia)
- [Breeze и Next.js / API](#breeze-and-next)
- [Laravel Jetstream](#laravel-jetstream)
@@ -17,51 +18,64 @@
## Laravel Breeze
-[Laravel Breeze](https://github.com/laravel/breeze) – это минимальная и простая реализация всего [функционала аутентификации](authentication.md) Laravel, включая вход в систему, регистрацию, сброс пароля, подтверждение адреса электронной почты и пароля. Слой «View» комплекта Laravel Breeze по умолчанию состоит из простых [шаблонов Blade](blade.md), стилизованных с помощью [Tailwind CSS](https://tailwindcss.com).
+[Laravel Breeze](https://github.com/laravel/breeze) – это минимальная и простая реализация всего [функционала аутентификации](authentication.md) Laravel, включая вход в систему, регистрацию, сброс пароля, подтверждение адреса электронной почты и пароля. Кроме того, Breeze включает простую страницу «профиля», где пользователь может обновить свое имя, адрес электронной почты и пароль.
+
+Слой «View» комплекта Laravel Breeze по умолчанию состоит из простых [шаблонов Blade](blade.md), стилизованных с помощью [Tailwind CSS](https://tailwindcss.com). Или Breeze может создать каркас вашего приложения с помощью Vue или React и [Inertia] (https://inertiajs.com).
Breeze является прекрасной отправной точкой для создания нового приложения Laravel, а также отличный выбор для проектов, которые планируют вывести использование шаблонов Blade на новый уровень с помощью [Laravel Livewire](https://laravel-livewire.com).
+#### Laravel Bootcamp
+
+Если вы новичок в Laravel, не стесняйтесь перейти в [Laravel Bootcamp] (https://bootcamp.laravel.com). Laravel Bootcamp проведет вас через создание вашего первого приложения Laravel с использованием Breeze. Это отличный способ познакомиться со всем, что могут предложить Laravel и Breeze.
+
### Установка
-Сначала вы должны [создать новое приложение Laravel](installation.md), настроить свою базу данных и запустить [миграции базы данных](migrations.md):
+Сначала вы должны [создать новое приложение Laravel](installation.md), настроить свою базу данных и запустить [миграции базы данных](migrations.md). После того, как вы создали новое приложение Laravel, вы можете установить Laravel Breeze с помощью Composer:
```shell
-curl -s https://laravel.build/example-app | bash
-
-cd example-app
-
-php artisan migrate
+composer require laravel/breeze --dev
```
-Создав новое приложение Laravel, вы можете установить Laravel Breeze с помощью Composer:
+После установки Breeze вы можете создать шаблон для своего приложения, используя один из «стеков» Breeze, описанных в документации ниже.
-```shell
-composer require laravel/breeze --dev
-```
+
+### Breeze и Blade
+
+После того, как Composer установит пакет Laravel Breeze, вы можете запустить команду `breeze:install` Artisan. Эта команда опубликует для вашего приложения шаблоны, маршруты, контроллеры и другие ресурсы аутентификации. Laravel Breeze опубликует весь свой код в вашем приложении, чтобы у вас был полный контроль, а также обзор всего функционала и его реализации.
-После того, как Composer установит пакет Laravel Breeze, вы можете запустить команду `breeze:install` Artisan. Эта команда опубликует для вашего приложения шаблоны, маршруты, контроллеры и другие ресурсы аутентификации. Laravel Breeze опубликует весь свой код в вашем приложении, чтобы у вас был полный контроль, а также обзор всего функционала и его реализации. После установки Breeze вы также должны скомпилировать свои исходники, чтобы был доступен файл стилей вашего приложения:
+Стек Breeze по умолчанию — это стек Blade, который использует простые [шаблоны Blade](blade.md) для отрисовки внешнего интерфейса вашего приложения. Стек Blade можно установить, вызвав команду `breeze:install` без дополнительных аргументов. После установки каркаса Breeze вы также должны скомпилировать ресурсы внешнего интерфейсные вашего приложения:
```shell
php artisan breeze:install
+php artisan migrate
npm install
npm run dev
-php artisan migrate
```
Затем, вы можете перейти в своем веб-браузере по URL-адресам вашего приложения `/login` или `/register`. Все маршруты Breeze определены в файле `routes/auth.php`.
-> {tip} Чтобы узнать больше о компиляции CSS и JavaScript вашего приложения, ознакомьтесь с [документацией Laravel Mix](mix.md#running-mix).
+
+#### Темная тема
+
+Если вы хотите, чтобы Breeze включил поддержку «темной темы» при создании внешнего интерфейса вашего приложения, просто укажите директиву `--dark` при выполнении команды `breeze:install`:
+
+```shell
+php artisan breeze:install --dark
+```
+
+> **Примечание**\
+> Чтобы узнать больше о компиляции CSS и JavaScript вашего приложения, ознакомьтесь с [документацией Laravel Vite](vite.md#running-vite).
### Breeze и React / Vue
-Laravel Breeze также предлагает каркасы React и Vue через реализацию внешнего интерфейса [Inertia.js](https://inertiajs.com). Inertia позволяет создавать современные одностраничные приложения React и Vue, используя классическую маршрутизацию и контроллеры на стороне сервера.
+Laravel Breeze также предлагает каркасы React и Vue через реализацию внешнего интерфейса [Inertia](https://inertiajs.com). Inertia позволяет создавать современные одностраничные приложения React и Vue, используя классическую маршрутизацию и контроллеры на стороне сервера.
-Inertia позволяет вам наслаждаться мощью внешнего интерфейса React и Vue в сочетании с невероятной производительностью Laravel. Чтобы использовать стек Inertia, укажите `vue` или `react` в качестве желаемого стека при выполнении команды `breeze:install` Artisan:
+Inertia позволяет вам наслаждаться мощью внешнего интерфейса React и Vue в сочетании с невероятной производительностью Laravel и молниеносной компиляцией [Vite](https://vitejs.dev). Чтобы использовать стек Inertia, укажите `vue` или `react` в качестве желаемого стека при выполнении команды `breeze:install` Artisan. После установки каркаса Breeze вы также должны скомпилировать ресурсы внешнего интерфейсные вашего приложения:
```shell
php artisan breeze:install vue
@@ -70,11 +84,16 @@ php artisan breeze:install vue
php artisan breeze:install react
+php artisan migrate
npm install
npm run dev
-php artisan migrate
```
+Затем, вы можете перейти в своем веб-браузере по URL-адресам вашего приложения `/login` или `/register`. Все маршруты Breeze определены в файле `routes/auth.php`.
+
+
+#### Серверный рендеринг
+
Если вы хотите, чтобы Breeze поддерживал [Inertia SSR](https://inertiajs.com/server-side-rendering), то вы можете указать параметр `ssr` при вызове команды `breeze:install`:
```shell
@@ -105,6 +124,6 @@ php artisan migrate
В то время как Laravel Breeze обеспечивает простую и минимальную отправную точку для создания приложения Laravel, Jetstream дополняет эту функциональность более надежными функциями и дополнительными стеками технологий клиентского интерфейса. **Для тех, кто новичок в Laravel, мы рекомендуем изучить основы работы с Laravel Breeze перед тем, как перейти на Laravel Jetstream.**
-Jetstream предлагает красиво оформленный каркас приложений для Laravel и включает в себя вход в систему, регистрацию, подтверждение адреса электронной почты, двухфакторную аутентификацию, управление сессиями, поддержку API через Laravel Sanctum, и дополнительно, управление командой. Jetstream разработан с использованием [Tailwind CSS](https://tailwindcss.com) и предлагает на ваш выбор каркас клиентского интерфейса под управлением [Livewire](https://laravel-livewire.com) либо [Inertia.js](https://inertiajs.com).
+Jetstream предлагает красиво оформленный каркас приложений для Laravel и включает в себя вход в систему, регистрацию, подтверждение адреса электронной почты, двухфакторную аутентификацию, управление сессиями, поддержку API через Laravel Sanctum, и дополнительно, управление командой. Jetstream разработан с использованием [Tailwind CSS](https://tailwindcss.com) и предлагает на ваш выбор каркас клиентского интерфейса под управлением [Livewire](https://laravel-livewire.com) либо [Inertia](https://inertiajs.com).
Полное описание по установке Laravel Jetstream можно найти в [официальной документации Jetstream](https://jetstream.laravel.com).
diff --git a/docs/structure.md b/docs/structure.md
index cb2dbd8..e147504 100644
--- a/docs/structure.md
+++ b/docs/structure.md
@@ -33,6 +33,9 @@
Структура приложения Laravel по умолчанию предназначена для обеспечения отличной отправной точки как для больших, так и небольших приложений. Но вы можете организовать свое приложение так, как вам нравится. Laravel почти не налагает ограничений на расположение любого конкретного класса, до тех пор, пока Composer может автоматически загружать класс.
+> **Примечание**\
+> Новичок в Laravel? Посетите [Laravel Bootcamp](https://bootcamp.laravel.com) для практического ознакомления с фреймворком, пока мы познакомим вас с созданием вашего первого приложения Laravel.
+
## Корневой каталог
@@ -110,7 +113,8 @@
Множество других каталогов будет создано внутри каталога `app`, когда вы будете использовать команды `make` Artisan для создания классов. Так, например, каталог `app/Jobs` не будет существовать, пока вы не выполните команду `make:job` Artisan для создания класса задания.
-> {tip} Многие классы в каталоге `app` могут быть созданы с помощью команд Artisan. Чтобы просмотреть доступные команды, выполните команду `php artisan list make` в консоли.
+> **Примечание**\
+> Многие классы в каталоге `app` могут быть созданы с помощью команд Artisan. Чтобы просмотреть доступные команды, выполните команду `php artisan list make` в консоли.
#### Каталог пространства `Broadcasting`
diff --git a/docs/telescope.md b/docs/telescope.md
index 3b0b8ef..788d051 100644
--- a/docs/telescope.md
+++ b/docs/telescope.md
@@ -142,7 +142,8 @@ php artisan migrate
});
}
-> {note} Убедитесь, что вы изменили значение переменной `APP_ENV` на `production` в эксплуатационном окружении. В противном случае доступ к Telescope будет публичным.
+> **Предупреждение**\
+> Убедитесь, что вы изменили значение переменной `APP_ENV` на `production` в эксплуатационном окружении. В противном случае доступ к Telescope будет публичным.
## Обновление пакета Telescope
diff --git a/docs/testing.md b/docs/testing.md
index 6b3a81d..5c1e7ab 100644
--- a/docs/testing.md
+++ b/docs/testing.md
@@ -57,7 +57,8 @@ php artisan make:test UserTest --pest
php artisan make:test UserTest --unit --pest
```
-> {tip} Заготовки тестов можно настроить с помощью [публикации заготовок](artisan.md#stub-customization).
+> **Примечание**\
+> Заготовки тестов можно настроить с помощью [публикации заготовок](artisan.md#stub-customization).
После того, как тест был сгенерирован, вы можете определить методы тестирования, как обычно, используя [PHPUnit](https://phpunit.de). Чтобы запустить ваши тесты, выполните команду `vendor/bin/phpunit` или `php artisan test` из вашего терминала:
@@ -80,7 +81,8 @@ php artisan make:test UserTest --unit --pest
}
}
-> {note} Если вы определяете свои собственные методы `setUp` / `tearDown` в тестовом классе, обязательно вызывайте соответствующие методы `parent::setUp()` / `parent::tearDown()` родительского класса.
+> **Предупреждение**\
+> Если вы определяете свои собственные методы `setUp` / `tearDown` в тестовом классе, обязательно вызывайте соответствующие методы `parent::setUp()` / `parent::tearDown()` родительского класса.
## Запуск тестов
@@ -118,7 +120,8 @@ php artisan test --parallel
php artisan test --parallel --processes=4
```
-> {note} При параллельном запуске тестов некоторые параметры PHPUnit (такие как `--do-not-cache-result`) могут быть недоступны.
+> **Предупреждение**\
+> При параллельном запуске тестов некоторые параметры PHPUnit (такие как `--do-not-cache-result`) могут быть недоступны.
#### Параллельное тестирование и базы данных
@@ -188,7 +191,8 @@ php artisan test --parallel --recreate-databases
### Отчет о покрытии тестами
-> {note} Данный функционал требует [Xdebug](https://xdebug.org) или [PCOV](https://pecl.php.net/package/pcov).
+> **Предупреждение**\
+> Данный функционал требует [Xdebug](https://xdebug.org) или [PCOV](https://pecl.php.net/package/pcov).
При выполнении тестов приложения вы можете определить, действительно ли ваши тесты охватывают код приложения и сколько кода приложения используется при выполнении ваших тестов. Для этого вы можете указать флаг `--coverage` при вызове команды `test`:
diff --git a/docs/upgrade.md b/docs/upgrade.md
index 3937ad3..9de85f8 100644
--- a/docs/upgrade.md
+++ b/docs/upgrade.md
@@ -37,7 +37,8 @@
#### Приблизительное время обновления: 30 минут
-> {tip} Мы стараемся задокументировать все возможные критические изменения. Поскольку некоторые из этих критических изменений находятся в малоизвестных частях фреймворка, только часть этих изменений может повлиять на ваше приложение. Хотите сэкономить время? Вы можете использовать [Laravel Shift](https://laravelshift.com/), чтобы автоматизировать обновления приложений.
+> **Примечание**\
+> Мы стараемся задокументировать все возможные критические изменения. Поскольку некоторые из этих критических изменений находятся в малоизвестных частях фреймворка, только часть этих изменений может повлиять на ваше приложение. Хотите сэкономить время? Вы можете использовать [Laravel Shift](https://laravelshift.com/), чтобы автоматизировать обновления приложений.
### Обновление зависимостей
@@ -59,7 +60,7 @@ Laravel теперь требует PHP 8.0.2 или выше.
-Кроме того, замените `facade/ignition` на `"spatie/laravel-ignition": "^1.0"` в файле `composer.json` вашего приложения.
+Кроме того, замените `facade/ignition` на `"spatie/laravel-ignition": "^1.0"` и `pusher/pusher-php-server` (если это применимо) с `"pusher/pusher-php-server": "^5.0"` в файле `composer.json` вашего приложения.
Кроме того, следующие пакеты получили новые релизы для поддержки Laravel 9.x. Если применимо, то вы должны прочитать их отдельные руководства перед обновлением:
@@ -128,6 +129,14 @@ PHP начинает переходить к требованию определ
public function ignore(string $class);
```
+#### Привязка контракта обработчика исключений
+
+**Вероятность воздействия: очень низкая**
+
+Ранее, чтобы переопределить обработчик исключений Laravel по умолчанию, пользовательские реализации были привязаны к контейнеру службы с использованием типа `\App\Exceptions\Handler::class`. Однако теперь вы должны привязывать пользовательские реализации, используя тип `\Illuminate\Contracts\Debug\ExceptionHandler::class`.
+
+Previously, in order to override the default Laravel exception handler, custom implementations were bound into the service container using the `\App\Exceptions\Handler::class` type. However, you should now bind custom implementations using the `\Illuminate\Contracts\Debug\ExceptionHandler::class` type.
+
### Шаблонизатор Blade
#### Отложенные коллекции и переменная `$loop`
@@ -508,7 +517,8 @@ composer require symfony/postmark-mailer symfony/http-client
);
});
-> {note} Пожалуйста, внимательно изучите [документацию Symfony Mailer](https://symfony.com/doc/6.0/mailer.html#creating-sending-messages) для взаимодействий с объектом `Symfony\Component\Mime\Email`.
+> **Предупреждение**\
+> Пожалуйста, внимательно изучите [документацию Symfony Mailer](https://symfony.com/doc/6.0/mailer.html#creating-sending-messages) для взаимодействий с объектом `Symfony\Component\Mime\Email`.
Список ниже содержит более подробный обзор переименованных методов. Многие из этих методов являются низкоуровневыми методами, используемыми для прямого взаимодействия со SwiftMailer / Symfony Mailer, поэтому могут не использоваться в большинстве приложений Laravel:
@@ -584,7 +594,8 @@ SwiftMailer предлагал возможность определить со
Чтобы узнать больше о доступных параметрах конфигурации, ознакомьтесь с [документацией Symfony Mailer](https://symfony.com/doc/6.0/mailer.html#transport-setup).
-> {note} Несмотря на приведенный выше пример, обычно не рекомендуется отключать проверку SSL, поскольку это создает возможность атак типа [«man-in-the-middle»](https://ru.wikipedia.org/wiki/Атака_посредника).
+> **Предупреждение**\
+> Несмотря на приведенный выше пример, обычно не рекомендуется отключать проверку SSL, поскольку это создает возможность атак типа [«man-in-the-middle»](https://ru.wikipedia.org/wiki/Атака_посредника).
#### Режим аутентификации SMTP
diff --git a/docs/valet.md b/docs/valet.md
index b7c6207..3c11e13 100644
--- a/docs/valet.md
+++ b/docs/valet.md
@@ -42,7 +42,7 @@ Out of the box, Valet support includes, but is not limited to:
- [Laravel](https://laravel.com)
- [Bedrock](https://roots.io/bedrock/)
- [CakePHP 3](https://cakephp.org)
-- [Concrete5](https://www.concrete5.org/)
+- [ConcreteCMS](https://www.concretecms.com/)
- [Contao](https://contao.org/en/)
- [Craft](https://craftcms.com)
- [Drupal](https://www.drupal.org/)
@@ -68,7 +68,8 @@ However, you may extend Valet with your own [custom drivers](#custom-valet-drive
## Installation
-> {note} Valet requires macOS and [Homebrew](https://brew.sh/). Before installation, you should make sure that no other programs such as Apache or Nginx are binding to your local machine's port 80.
+> **Warning**
+> Valet requires macOS and [Homebrew](https://brew.sh/). Before installation, you should make sure that no other programs such as Apache or Nginx are binding to your local machine's port 80.
To get started, you first need to ensure that Homebrew is up to date using the `update` command:
@@ -117,7 +118,8 @@ php@7.2
Once this file has been created, you may simply execute the `valet use` command and the command will determine the site's preferred PHP version by reading the file.
-> {note} Valet only serves one PHP version at a time, even if you have multiple PHP versions installed.
+> **Warning**
+> Valet only serves one PHP version at a time, even if you have multiple PHP versions installed.
#### Database
@@ -127,12 +129,12 @@ If your application needs a database, check out [DBngin](https://dbngin.com). DB
#### Resetting Your Installation
-If you are having trouble getting your Valet installation to run properly, executing the `composer global update` command followed by `valet install` will reset your installation and can solve a variety of problems. In rare cases, it may be necessary to "hard reset" Valet by executing `valet uninstall --force` followed by `valet install`.
+If you are having trouble getting your Valet installation to run properly, executing the `composer global require laravel/valet` command followed by `valet install` will reset your installation and can solve a variety of problems. In rare cases, it may be necessary to "hard reset" Valet by executing `valet uninstall --force` followed by `valet install`.
### Upgrading Valet
-You may update your Valet installation by executing the `composer global update` command in your terminal. After upgrading, it is good practice to run the `valet install` command so Valet can make additional upgrades to your configuration files if necessary.
+You may update your Valet installation by executing the `composer global require laravel/valet` command in your terminal. After upgrading, it is good practice to run the `valet install` command so Valet can make additional upgrades to your configuration files if necessary.
## Serving Sites
@@ -270,7 +272,8 @@ valet share
To stop sharing your site, you may press `Control + C`. Sharing your site using Ngrok requires you to [create an Ngrok account](https://dashboard.ngrok.com/signup) and [setup an authentication token](https://dashboard.ngrok.com/get-started/your-authtoken).
-> {tip} You may pass additional Ngrok parameters to the share command, such as `valet share --region=eu`. For more information, consult the [ngrok documentation](https://ngrok.com/docs).
+> **Note**
+> You may pass additional Ngrok parameters to the share command, such as `valet share --region=eu`. For more information, consult the [ngrok documentation](https://ngrok.com/docs).
### Sharing Sites Via Expose
@@ -395,7 +398,8 @@ The `isStaticFile` should determine if the incoming request is for a file that i
return false;
}
-> {note} The `isStaticFile` method will only be called if the `serves` method returns `true` for the incoming request and the request URI is not `/`.
+> **Warning**
+> The `isStaticFile` method will only be called if the `serves` method returns `true` for the incoming request and the request URI is not `/`.
#### The `frontControllerPath` Method
@@ -420,6 +424,8 @@ The `frontControllerPath` method should return the fully qualified path to your
If you would like to define a custom Valet driver for a single application, create a `LocalValetDriver.php` file in the application's root directory. Your custom driver may extend the base `ValetDriver` class or extend an existing application specific driver such as the `LaravelValetDriver`:
+ use Valet\Drivers\LaravelValetDriver;
+
class LocalValetDriver extends LaravelValetDriver
{
/**
@@ -454,6 +460,7 @@ If you would like to define a custom Valet driver for a single application, crea
Command | Description
------------- | -------------
+`valet list` | Display a list of all Valet commands.
`valet forget` | Run this command from a "parked" directory to remove it from the parked directory list.
`valet log` | View a list of logs which are written by Valet's services.
`valet paths` | View all of your "parked" paths.
@@ -533,4 +540,4 @@ This file is the default Nginx configuration used for building SSL certificates
Since macOS 10.14, [access to some files and directories is restricted by default](https://manuals.info.apple.com/MANUALS/1000/MA1902/en_US/apple-platform-security-guide.pdf). These restrictions include the Desktop, Documents, and Downloads directories. In addition, network volume and removable volume access is restricted. Therefore, Valet recommends your site folders are located outside of these protected locations.
-However, if you wish to serve sites from within one of those locations, you will need to give Nginx "Full Disk Access". Otherwise, you may encounter server errors or other unpredictable behavior from Nginx, especially when serving static assets. Typically, macOS will automatically prompt you to grant Nginx full access to these locations. Or, you may do so manually via `System Preferences` > `Security & Privacy` > `Privacy` and selecting `Full Disk Access`. Next, enable any `nginx` entries in the main window pane.
+However, if you wish to serve sites from within one of those locations, you will need to give Nginx "Full Disk Access". Otherwise, you may encounter server errors or other unpredictable behavior from Nginx, especially when serving static assets. Typically, macOS will automatically prompt you to grant Nginx full access to these locations. Or, you may do so manually via `System Preferences` > `Security & Privacy` > `Privacy` and selecting `Full Disk Access`. Next, enable any `nginx` entries in the main window pane.
\ No newline at end of file
diff --git a/docs/validation.md b/docs/validation.md
index c9a13ea..45fac0e 100644
--- a/docs/validation.md
+++ b/docs/validation.md
@@ -316,7 +316,8 @@ php artisan make:request StorePostRequest
];
}
-> {tip} Вы можете объявить любые зависимости, которые вам нужны, в сигнатуре метода `rules`. Они будут автоматически извлечены через [контейнер служб](container.md) Laravel.
+> **Примечание**\
+> Вы можете объявить любые зависимости, которые вам нужны, в сигнатуре метода `rules`. Они будут автоматически извлечены через [контейнер служб](container.md) Laravel.
Итак, как анализируются правила валидации? Все, что вам нужно сделать, это объявить зависимость от запроса в методе вашего контроллера. Входящий запрос формы проверяется до вызова метода контроллера, что означает, что вам не нужно загромождать контроллер какой-либо логикой валидации:
@@ -435,7 +436,8 @@ php artisan make:request StorePostRequest
return true;
}
-> {tip} Вы можете объявить любые зависимости, которые вам нужны, в сигнатуре метода `authorize`. Они будут автоматически извлечены через [контейнер служб](container.md) Laravel.
+> **Примечание**\
+> Вы можете объявить любые зависимости, которые вам нужны, в сигнатуре метода `authorize`. Они будут автоматически извлечены через [контейнер служб](container.md) Laravel.
### Корректировка сообщений об ошибках
@@ -1091,7 +1093,8 @@ The credit card number field is required when payment type is credit card.
Валидатор `filter`, который использует функцию `filter_var` PHP, поставляется с Laravel и применялся по умолчанию до Laravel версии 5.8.
-> {note} Валидаторы `dns` и `spoof` требуют расширения `intl` PHP.
+> **Предупреждение**\
+> Валидаторы `dns` и `spoof` требуют расширения `intl` PHP.
#### ends_with:_foo_,_bar_,...
@@ -1110,7 +1113,8 @@ The credit card number field is required when payment type is credit card.
'status' => [new Enum(ServerStatus::class)],
]);
-> {note} Перечисляемые типы доступны только в [PHP 8.1+](https://www.php.net/manual/ru/language.enumerations.php).
+> **Предупреждение**\
+> Перечисляемые типы доступны только в [PHP 8.1+](https://www.php.net/manual/ru/language.enumerations.php).
#### exclude
@@ -1262,7 +1266,8 @@ The credit card number field is required when payment type is credit card.
Проверяемое поле должно быть целым числом.
-> {note} Это правило валидации не проверяет, что значение поля относится к типу переменной `integer`, а только что значение поля относится к типу, принятому правилом `FILTER_VALIDATE_INT` PHP. Если вам нужно проверить значение поля в качестве числа, используйте это правило в сочетании с [правилом валидации `numeric`](#rule-numeric).
+> **Предупреждение**\
+> Это правило валидации не проверяет, что значение поля относится к типу переменной `integer`, а только что значение поля относится к типу, принятому правилом `FILTER_VALIDATE_INT` PHP. Если вам нужно проверить значение поля в качестве числа, используйте это правило в сочетании с [правилом валидации `numeric`](#rule-numeric).
#### ip
@@ -1337,7 +1342,8 @@ The credit card number field is required when payment type is credit card.
Проверяемое поле должно быть кратным _value_.
-> {note} Для использования правила `multiple_of` требуется [расширение `bcmath` PHP](https://www.php.net/manual/ru/book.bc.php).
+> **Предупреждение**\
+> Для использования правила `multiple_of` требуется [расширение `bcmath` PHP](https://www.php.net/manual/ru/book.bc.php).
#### not_in:_foo_,_bar_,...
@@ -1360,7 +1366,8 @@ The credit card number field is required when payment type is credit card.
Внутренне это правило использует функцию `preg_match` PHP. Указанный шаблон должен подчиняться тому же форматированию, требуемому `preg_match`, и, следовательно, также включать допустимые разделители. Например: `'email' => 'not_regex:/^.+$/i'`.
-> {note} При использовании шаблонов `regex` / `not_regex` может потребоваться указать ваши правила валидации с использованием массива вместо использования разделителей `|`, особенно если регулярное выражение содержит символ `|`.
+> **Предупреждение**\
+> При использовании шаблонов `regex` / `not_regex` может потребоваться указать ваши правила валидации с использованием массива вместо использования разделителей `|`, особенно если регулярное выражение содержит символ `|`.
#### nullable
@@ -1377,7 +1384,8 @@ The credit card number field is required when payment type is credit card.
Проверяемое поле должно соответствовать паролю аутентифицированного пользователя.
-> {note} Это правило было переименовано в `current_password` с его дальнейшим удалением в Laravel 9. Вместо этого используйте правило [Current Password](#rule-current-password).
+> **Предупреждение**\
+> Это правило было переименовано в `current_password` с его дальнейшим удалением в Laravel 9. Вместо этого используйте правило [Current Password](#rule-current-password).
#### present
@@ -1424,7 +1432,8 @@ The credit card number field is required when payment type is credit card.
Внутренне это правило использует функцию `preg_match` PHP. Указанный шаблон должен подчиняться тому же форматированию, требуемому `preg_match`, и, следовательно, также включать допустимые разделители. Например: `'email' => 'regex:/^.+@.+$/i'`.
-> {note} При использовании шаблонов `regex` / `not_regex` может потребоваться указать ваши правила валидации с использованием массива вместо использования разделителей `|`, особенно если регулярное выражение содержит символ `|`.
+> **Предупреждение**\
+> При использовании шаблонов `regex` / `not_regex` может потребоваться указать ваши правила валидации с использованием массива вместо использования разделителей `|`, особенно если регулярное выражение содержит символ `|`.
#### required
@@ -1562,7 +1571,8 @@ The credit card number field is required when payment type is credit card.
],
]);
-> {note} Вы никогда не должны передавать какое-либо введенное пользователем значение из запроса в метод `ignore`. Вместо этого вы должны передавать только сгенерированный системой уникальный идентификатор, такой как автоинкрементный идентификатор или UUID экземпляра модели Eloquent. В противном случае ваше приложение будет уязвимо для атаки с использованием SQL-инъекции.
+> **Предупреждение**\
+> Вы никогда не должны передавать какое-либо введенное пользователем значение из запроса в метод `ignore`. Вместо этого вы должны передавать только сгенерированный системой уникальный идентификатор, такой как автоинкрементный идентификатор или UUID экземпляра модели Eloquent. В противном случае ваше приложение будет уязвимо для атаки с использованием SQL-инъекции.
Вместо того, чтобы передавать значение ключа модели методу `ignore`, вы также можете передать весь экземпляр модели. Laravel автоматически извлечет ключ из модели:
@@ -1627,7 +1637,8 @@ The credit card number field is required when payment type is credit card.
В приведенном выше примере поле `email` будет проверено, только если оно присутствует в массиве `$request->all()`.
-> {tip} Если вы пытаетесь проверить поле, которое всегда должно присутствовать, но может быть пустым, ознакомьтесь с [этим примечанием о необязательных полях](#a-note-on-optional-fields).
+> **Примечание**\
+> Если вы пытаетесь проверить поле, которое всегда должно присутствовать, но может быть пустым, ознакомьтесь с [этим примечанием о необязательных полях](#a-note-on-optional-fields).
#### Комплексная условная проверка
@@ -1653,7 +1664,8 @@ The credit card number field is required when payment type is credit card.
return $input->games >= 100;
});
-> {tip} Параметр `$input`, переданный вашему замыканию, будет экземпляром `Illuminate\Support\Fluent` и может использоваться при валидации для доступа к вашим входящим данным и файлам запроса.
+> **Примечание**\
+> Параметр `$input`, переданный вашему замыканию, будет экземпляром `Illuminate\Support\Fluent` и может использоваться при валидации для доступа к вашим входящим данным и файлам запроса.
#### Комплексная условная валидация массива
@@ -2039,4 +2051,5 @@ php artisan make:rule Uppercase
php artisan make:rule Uppercase --implicit
```
-> {note} «Неявное» правило только _подразумевает_, что атрибут является обязательным к валидации. В действительности, решать только вам, будет ли пустой или отсутствующий атрибут считаться невалидным.
+> **Предупреждение**\
+> «Неявное» правило только _подразумевает_, что атрибут является обязательным к валидации. В действительности, решать только вам, будет ли пустой или отсутствующий атрибут считаться невалидным.
diff --git a/docs/verification.md b/docs/verification.md
index 1713349..ff15379 100644
--- a/docs/verification.md
+++ b/docs/verification.md
@@ -16,7 +16,8 @@
Многие веб-приложения требуют от пользователей подтверждения своего адреса электронной почты перед использованием приложения. Вместо того, чтобы заставлять вас самостоятельно реализовывать этот функционал повторно для каждого создаваемого вами приложения, Laravel предлагает удобные встроенные службы для отправки и проверки запросов подтверждения адреса электронной почты.
-> {tip} Хотите быстро начать? Установите один из [стартовых комплектов](starter-kits.md) в новое приложение Laravel. Стартовые комплекты позаботятся о построении всей вашей системы аутентификации, включая поддержку подтверждения электронной почты.
+> **Примечание**\
+> Хотите быстро начать? Установите один из [стартовых комплектов](starter-kits.md) в новое приложение Laravel. Стартовые комплекты позаботятся о построении всей вашей системы аутентификации, включая поддержку подтверждения электронной почты.
### Подготовка модели
@@ -75,7 +76,8 @@ php artisan migrate
Маршрут, который возвращает уведомление о подтверждении по электронной почте, должен называться `verification.notice`. Важно, чтобы маршруту было присвоено это точное имя, поскольку посредник `verify`, [включенный в Laravel](#protecting-routes), будет автоматически перенаправлять на это имя маршрута, если пользователь не подтвердил свой адрес электронной почты.
-> {tip} При выполнении проверки электронной почты самостоятельно, вам необходимо определить содержание страницы уведомления о проверке. Если вам необходим каркас, включающий все необходимые страницы для аутентификации и проверки, ознакомьтесь со [стартовыми комплектами приложений Laravel](starter-kits.md).
+> **Примечание**\
+> При выполнении проверки электронной почты самостоятельно, вам необходимо определить содержание страницы уведомления о проверке. Если вам необходим каркас, включающий все необходимые страницы для аутентификации и проверки, ознакомьтесь со [стартовыми комплектами приложений Laravel](starter-kits.md).
### Обработчик проверки электронной почты
@@ -148,7 +150,8 @@ php artisan migrate
});
}
-> {tip} Чтобы узнать больше о почтовых уведомлениях, обратитесь к [документации по почтовым уведомлениям](notifications.md#mail-notifications).
+> **Примечание**\
+> Чтобы узнать больше о почтовых уведомлениях, обратитесь к [документации по почтовым уведомлениям](notifications.md#mail-notifications).
## События
diff --git a/docs/views.md b/docs/views.md
index 0004f06..41ae2d9 100644
--- a/docs/views.md
+++ b/docs/views.md
@@ -32,7 +32,8 @@
return view('greeting', ['name' => 'James']);
});
-> {tip} Ищете дополнительную информацию о том, как писать шаблоны Blade? Ознакомьтесь с полной [документацией по Blade](blade.md), чтобы начать работу.
+> **Примечание**\
+> Ищете дополнительную информацию о том, как писать шаблоны Blade? Ознакомьтесь с полной [документацией по Blade](blade.md), чтобы начать работу.
## Создание и отрисовка шаблонов
@@ -60,7 +61,8 @@
return view('admin.profile', $data);
-> {note} Имена каталогов шаблонов не должны содержать символа `.`.
+> **Предупреждение**\
+> Имена каталогов шаблонов не должны содержать символа `.`.
### Использование первого доступного шаблона
@@ -177,7 +179,8 @@
}
}
-> {note} Помните, что если вы создаете нового поставщика служб, который будет содержать регистрации вашего компоновщика, то вам нужно будет добавить поставщика служб в массив `providers` в конфигурационном файле `config/app.php`.
+> **Предупреждение**\
+> Помните, что если вы создаете нового поставщика служб, который будет содержать регистрации вашего компоновщика, то вам нужно будет добавить поставщика служб в массив `providers` в конфигурационном файле `config/app.php`.
Теперь, когда мы зарегистрировали компоновщик, метод `compose` класса `App\View\Composers\ProfileComposer` будет выполняться каждый раз, когда отрисовывается шаблон профиля. Давайте посмотрим на пример класса компоновщика:
diff --git a/docs/vite.md b/docs/vite.md
new file mode 100644
index 0000000..e2e94f2
--- /dev/null
+++ b/docs/vite.md
@@ -0,0 +1,765 @@
+# Laravel 9 · Asset Bundling (Vite)
+
+- [Introduction](#introduction)
+- [Installation & Setup](#installation)
+ - [Installing Node](#installing-node)
+ - [Installing Vite And The Laravel Plugin](#installing-vite-and-laravel-plugin)
+ - [Configuring Vite](#configuring-vite)
+ - [Loading Your Scripts And Styles](#loading-your-scripts-and-styles)
+- [Running Vite](#running-vite)
+- [Working With JavaScript](#working-with-scripts)
+ - [Aliases](#aliases)
+ - [Vue](#vue)
+ - [React](#react)
+ - [Inertia](#inertia)
+ - [URL Processing](#url-processing)
+- [Working With Stylesheets](#working-with-stylesheets)
+- [Working With Blade & Routes](#working-with-blade-and-routes)
+ - [Processing Static Assets With Vite](#blade-processing-static-assets)
+ - [Refreshing On Save](#blade-refreshing-on-save)
+ - [Aliases](#blade-aliases)
+- [Custom Base URLs](#custom-base-urls)
+- [Environment Variables](#environment-variables)
+- [Disabling Vite In Tests](#disabling-vite-in-tests)
+- [Server-Side Rendering (SSR)](#ssr)
+- [Script & Style Tag Attributes](#script-and-style-attributes)
+ - [Content Security Policy (CSP) Nonce](#content-security-policy-csp-nonce)
+ - [Subresource Integrity (SRI)](#subresource-integrity-sri)
+ - [Arbitrary Attributes](#arbitrary-attributes)
+- [Advanced Customization](#advanced-customization)
+
+
+## Introduction
+
+[Vite](https://vitejs.dev) is a modern frontend build tool that provides an extremely fast development environment and bundles your code for production. When building applications with Laravel, you will typically use Vite to bundle your application's CSS and JavaScript files into production ready assets.
+
+Laravel integrates seamlessly with Vite by providing an official plugin and Blade directive to load your assets for development and production.
+
+> **Note**
+> Are you running Laravel Mix? Vite has replaced Laravel Mix in new Laravel installations. For Mix documentation, please visit the [Laravel Mix](https://laravel-mix.com/) website. If you would like to switch to Vite, please see our [migration guide](https://github.com/laravel/vite-plugin/blob/main/UPGRADE.md#migrating-from-laravel-mix-to-vite).
+
+
+#### Choosing Between Vite And Laravel Mix
+
+Before transitioning to Vite, new Laravel applications utilized [Mix](https://laravel-mix.com/), which is powered by [webpack](https://webpack.js.org/), when bundling assets. Vite focuses on providing a faster and more productive experience when building rich JavaScript applications. If you are developing a Single Page Application (SPA), including those developed with tools like [Inertia](https://inertiajs.com), Vite will be the perfect fit.
+
+Vite also works well with traditional server-side rendered applications with JavaScript "sprinkles", including those using [Livewire](https://laravel-livewire.com). However, it lacks some features that Laravel Mix supports, such as the ability to copy arbitrary assets into the build that are not referenced directly in your JavaScript application.
+
+
+#### Migrating Back To Mix
+
+Have you started a new Laravel application using our Vite scaffolding but need to move back to Laravel Mix and webpack? No problem. Please consult our [official guide on migrating from Vite to Mix](https://github.com/laravel/vite-plugin/blob/main/UPGRADE.md#migrating-from-vite-to-laravel-mix).
+
+
+## Installation & Setup
+
+> **Note**
+> The following documentation discusses how to manually install and configure the Laravel Vite plugin. However, Laravel's [starter kits](/docs/{{version}}/starter-kits) already include all of this scaffolding and are the fastest way to get started with Laravel and Vite.
+
+
+### Installing Node
+
+You must ensure that Node.js (16+) and NPM are installed before running Vite and the Laravel plugin:
+
+```sh
+node -v
+npm -v
+```
+
+You can easily install the latest version of Node and NPM using simple graphical installers from [the official Node website](https://nodejs.org/en/download/). Or, if you are using [Laravel Sail](https://laravel.com/docs/{{version}}/sail), you may invoke Node and NPM through Sail:
+
+```sh
+./vendor/bin/sail node -v
+./vendor/bin/sail npm -v
+```
+
+
+### Installing Vite And The Laravel Plugin
+
+Within a fresh installation of Laravel, you will find a `package.json` file in the root of your application's directory structure. The default `package.json` file already includes everything you need to get started using Vite and the Laravel plugin. You may install your application's frontend dependencies via NPM:
+
+```sh
+npm install
+```
+
+
+### Configuring Vite
+
+Vite is configured via a `vite.config.js` file in the root of your project. You are free to customize this file based on your needs, and you may also install any other plugins your application requires, such as `@vitejs/plugin-vue` or `@vitejs/plugin-react`.
+
+The Laravel Vite plugin requires you to specify the entry points for your application. These may be JavaScript or CSS files, and include preprocessed languages such as TypeScript, JSX, TSX, and Sass.
+
+```js
+import { defineConfig } from 'vite';
+import laravel from 'laravel-vite-plugin';
+
+export default defineConfig({
+ plugins: [
+ laravel([
+ 'resources/css/app.css',
+ 'resources/js/app.js',
+ ]),
+ ],
+});
+```
+
+If you are building an SPA, including applications built using Inertia, Vite works best without CSS entry points:
+
+```js
+import { defineConfig } from 'vite';
+import laravel from 'laravel-vite-plugin';
+
+export default defineConfig({
+ plugins: [
+ laravel([
+ 'resources/css/app.css', // [tl! remove]
+ 'resources/js/app.js',
+ ]),
+ ],
+});
+```
+
+Instead, you should import your CSS via JavaScript. Typically, this would be done in your application's `resources/js/app.js` file:
+
+```js
+import './bootstrap';
+import '../css/app.css'; // [tl! add]
+```
+
+The Laravel plugin also supports multiple entry points and advanced configuration options such as [SSR entry points](#ssr).
+
+
+#### Working With A Secure Development Server
+
+If your local development web server is serving your application via HTTPS, you may run into issues connecting to the Vite development server.
+
+If you are using [Laravel Valet](/docs/{{version}}/valet) for local development and have run the [secure command](/docs/{{version}}/valet#securing-sites) against your application, you may configure the Vite development server to automatically use Valet's generated TLS certificates:
+
+```js
+import { defineConfig } from 'vite';
+import laravel from 'laravel-vite-plugin';
+
+export default defineConfig({
+ plugins: [
+ laravel({
+ // ...
+ valetTls: 'my-app.test', // [tl! add]
+ }),
+ ],
+});
+```
+
+When using another web server, you should generate a trusted certificate and manually configure Vite to use the generated certificates:
+
+```js
+// ...
+import fs from 'fs'; // [tl! add]
+
+const host = 'my-app.test'; // [tl! add]
+
+export default defineConfig({
+ // ...
+ server: { // [tl! add]
+ host, // [tl! add]
+ hmr: { host }, // [tl! add]
+ https: { // [tl! add]
+ key: fs.readFileSync(`/path/to/${host}.key`), // [tl! add]
+ cert: fs.readFileSync(`/path/to/${host}.crt`), // [tl! add]
+ }, // [tl! add]
+ }, // [tl! add]
+});
+```
+
+If you are unable to generate a trusted certificate for your system, you may install and configure the [`@vitejs/plugin-basic-ssl` plugin](https://github.com/vitejs/vite-plugin-basic-ssl). When using untrusted certificates, you will need to accept the certificate warning for Vite's development server in your browser by following the "Local" link in your console when running the `npm run dev` command.
+
+
+### Loading Your Scripts And Styles
+
+With your Vite entry points configured, you only need reference them in a `@vite()` Blade directive that you add to the `` of your application's root template:
+
+```blade
+
+
+ {{-- ... --}}
+
+ @vite(['resources/css/app.css', 'resources/js/app.js'])
+
+```
+
+If you're importing your CSS via JavaScript, you only need to include the JavaScript entry point:
+
+```blade
+
+
+ {{-- ... --}}
+
+ @vite('resources/js/app.js')
+
+```
+
+The `@vite` directive will automatically detect the Vite development server and inject the Vite client to enable Hot Module Replacement. In build mode, the directive will load your compiled and versioned assets, including any imported CSS.
+
+If needed, you may also specify the build path of your compiled assets when invoking the `@vite` directive:
+
+```blade
+
+
+ {{-- Given build path is relative to public path. --}}
+
+ @vite('resources/js/app.js', 'vendor/courier/build')
+
+```
+
+
+## Running Vite
+
+There are two ways you can run Vite. You may run the development server via the `dev` command, which is useful while developing locally. The development server will automatically detect changes to your files and instantly reflect them in any open browser windows.
+
+Or, running the `build` command will version and bundle your application's assets and get them ready for you to deploy to production:
+
+```shell
+# Run the Vite development server...
+npm run dev
+
+# Build and version the assets for production...
+npm run build
+```
+
+
+## Working With JavaScript
+
+
+### Aliases
+
+By default, The Laravel plugin provides a common alias to help you hit the ground running and conveniently import your application's assets:
+
+```js
+{
+ '@' => '/resources/js'
+}
+```
+
+You may overwrite the `'@'` alias by adding your own to the `vite.config.js` configuration file:
+
+```js
+import { defineConfig } from 'vite';
+import laravel from 'laravel-vite-plugin';
+
+export default defineConfig({
+ plugins: [
+ laravel(['resources/ts/app.tsx']),
+ ],
+ resolve: {
+ alias: {
+ '@': '/resources/ts',
+ },
+ },
+});
+```
+
+
+### Vue
+
+There are a few additional options you will need to include in the `vite.config.js` configuration file when using the Vue plugin with the Laravel plugin:
+
+```js
+import { defineConfig } from 'vite';
+import laravel from 'laravel-vite-plugin';
+import vue from '@vitejs/plugin-vue';
+
+export default defineConfig({
+ plugins: [
+ laravel(['resources/js/app.js']),
+ vue({
+ template: {
+ transformAssetUrls: {
+ // The Vue plugin will re-write asset URLs, when referenced
+ // in Single File Components, to point to the Laravel web
+ // server. Setting this to `null` allows the Laravel plugin
+ // to instead re-write asset URLs to point to the Vite
+ // server instead.
+ base: null,
+
+ // The Vue plugin will parse absolute URLs and treat them
+ // as absolute paths to files on disk. Setting this to
+ // `false` will leave absolute URLs un-touched so they can
+ // reference assets in the public directory as expected.
+ includeAbsolute: false,
+ },
+ },
+ }),
+ ],
+});
+```
+
+> **Note**
+> Laravel's [starter kits](/docs/{{version}}/starter-kits) already include the proper Laravel, Vue, and Vite configuration. Check out [Laravel Breeze](/docs/{{version}}/starter-kits#breeze-and-inertia) for the fastest way to get started with Laravel, Vue, and Vite.
+
+
+### React
+
+When using Vite with React, you will need to ensure that any files containing JSX have a `.jsx` or `.tsx` extension, remembering to update your entry point, if required, as [shown above](#configuring-vite). You will also need to include the additional `@viteReactRefresh` Blade directive alongside your existing `@vite` directive.
+
+```blade
+@viteReactRefresh
+@vite('resources/js/app.jsx')
+```
+
+The `@viteReactRefresh` directive must be called before the `@vite` directive.
+
+> **Note**
+> Laravel's [starter kits](/docs/{{version}}/starter-kits) already include the proper Laravel, React, and Vite configuration. Check out [Laravel Breeze](/docs/{{version}}/starter-kits#breeze-and-inertia) for the fastest way to get started with Laravel, React, and Vite.
+
+
+### Inertia
+
+The Laravel Vite plugin provides a convenient `resolvePageComponent` function to help you resolve your Inertia page components. Below is an example of the helper in use with Vue 3; however, you may also utilize the function in other frameworks such as React:
+
+```js
+import { createApp, h } from 'vue';
+import { createInertiaApp } from '@inertiajs/inertia-vue3';
+import { resolvePageComponent } from 'laravel-vite-plugin/inertia-helpers';
+
+createInertiaApp({
+ resolve: (name) => resolvePageComponent(`./Pages/${name}.vue`, import.meta.glob('./Pages/**/*.vue')),
+ setup({ el, App, props, plugin }) {
+ createApp({ render: () => h(App, props) })
+ .use(plugin)
+ .mount(el)
+ },
+});
+```
+
+> **Note**
+> Laravel's [starter kits](/docs/{{version}}/starter-kits) already include the proper Laravel, Inertia, and Vite configuration. Check out [Laravel Breeze](/docs/{{version}}/starter-kits#breeze-and-inertia) for the fastest way to get started with Laravel, Inertia, and Vite.
+
+
+### URL Processing
+
+When using Vite and referencing assets in your application's HTML, CSS, or JS, there are a couple of caveats to consider. First, if you reference assets with an absolute path, Vite will not include the asset in the build; therefore, you should ensure that the asset is available in your public directory.
+
+When referencing relative asset paths, you should remember that the paths are relative to the file where they are referenced. Any assets referenced via a relative path will be re-written, versioned, and bundled by Vite.
+
+Consider the following project structure:
+
+```nothing
+public/
+ taylor.png
+resources/
+ js/
+ Pages/
+ Welcome.vue
+ images/
+ abigail.png
+```
+
+The following example demonstrates how Vite will treat relative and absolute URLs:
+
+```html
+
+
+
+
+
+```
+
+
+## Working With Stylesheets
+
+You can learn more about Vite's CSS support within the [Vite documentation](https://vitejs.dev/guide/features.html#css). If you are using PostCSS plugins such as [Tailwind](https://tailwindcss.com), you may create a `postcss.config.js` file in the root of your project and Vite will automatically apply it:
+
+```js
+module.exports = {
+ plugins: {
+ tailwindcss: {},
+ autoprefixer: {},
+ },
+};
+```
+
+
+## Working With Blade & Routes
+
+
+### Processing Static Assets With Vite
+
+When referencing assets in your JavaScript or CSS, Vite automatically processes and versions them. In addition, when building Blade based applications, Vite can also process and version static assets that you reference solely in Blade templates.
+
+However, in order to accomplish this, you need to make Vite aware of your assets by importing the static assets into the application's entry point. For example, if you want to process and version all images stored in `resources/images` and all fonts stored in `resources/fonts`, you should add the following in your application's `resources/js/app.js` entry point:
+
+```js
+import.meta.glob([
+ '../images/**',
+ '../fonts/**',
+]);
+```
+
+These assets will now be processed by Vite when running `npm run build`. You can then reference these assets in Blade templates using the `Vite::asset` method, which will return the versioned URL for a given asset:
+
+```blade
+
 }})
+```
+
+
+### Refreshing On Save
+
+When your application is built using traditional server-side rendering with Blade, Vite can improve your development workflow by automatically refreshing the browser when you make changes to view files in your application. To get started, you can simply specify the `refresh` option as `true`.
+
+```js
+import { defineConfig } from 'vite';
+import laravel from 'laravel-vite-plugin';
+
+export default defineConfig({
+ plugins: [
+ laravel({
+ // ...
+ refresh: true,
+ }),
+ ],
+});
+```
+
+When the `refresh` option is `true`, saving files in the following directories will trigger the browser to perform a full page refresh while you are running `npm run dev`:
+
+- `app/View/Components/**`
+- `lang/**`
+- `resources/lang/**`
+- `resources/views/**`
+- `routes/**`
+
+Watching the `routes/**` directory is useful if you are utilizing [Ziggy](https://github.com/tighten/ziggy) to generate route links within your application's frontend.
+
+If these default paths do not suit your needs, you can specify your own list of paths to watch:
+
+```js
+import { defineConfig } from 'vite';
+import laravel from 'laravel-vite-plugin';
+
+export default defineConfig({
+ plugins: [
+ laravel({
+ // ...
+ refresh: ['resources/views/**'],
+ }),
+ ],
+});
+```
+
+Under the hood, the Laravel Vite plugin uses the [`vite-plugin-full-reload`](https://github.com/ElMassimo/vite-plugin-full-reload) package, which offers some advanced configuration options to fine-tune this feature's behavior. If you need this level of customization, you may provide a `config` definition:
+
+```js
+import { defineConfig } from 'vite';
+import laravel from 'laravel-vite-plugin';
+
+export default defineConfig({
+ plugins: [
+ laravel({
+ // ...
+ refresh: [{
+ paths: ['path/to/watch/**'],
+ config: { delay: 300 }
+ }],
+ }),
+ ],
+});
+```
+
+
+### Aliases
+
+It is common in JavaScript applications to [create aliases](#aliases) to regularly referenced directories. But, you may also create aliases to use in Blade by using the `macro` method on the `Illuminate\Support\Vite` class. Typically, "macros" should be defined within the `boot` method of a [service provider](/docs/{{version}}/providers):
+
+ /**
+ * Bootstrap any application services.
+ *
+ * @return void
+ */
+ public function boot()
+ {
+ Vite::macro('image', fn ($asset) => $this->asset("resources/images/{$asset}"));
+ }
+
+Once a macro has been defined, it can be invoked within your templates. For example, we can use the `image` macro defined above to reference an asset located at `resources/images/logo.png`:
+
+```blade
+
 }})
+```
+
+
+## Custom Base URLs
+
+If your Vite compiled assets are deployed to a domain separate from your application, such as via a CDN, you must specify the `ASSET_URL` environment variable within your application's `.env` file:
+
+```env
+ASSET_URL=https://cdn.example.com
+```
+
+After configuring the asset URL, all re-written URLs to your assets will be prefixed with the configured value:
+
+```nothing
+https://cdn.example.com/build/assets/app.9dce8d17.js
+```
+
+Remember that [absolute URLs are not re-written by Vite](#url-processing), so they will not be prefixed.
+
+
+## Environment Variables
+
+You may inject environment variables into your JavaScript by prefixing them with `VITE_` in your application's `.env` file:
+
+```env
+VITE_SENTRY_DSN_PUBLIC=http://example.com
+```
+
+You may access injected environment variables via the `import.meta.env` object:
+
+```js
+import.meta.env.VITE_SENTRY_DSN_PUBLIC
+```
+
+
+## Disabling Vite In Tests
+
+Laravel's Vite integration will attempt to resolve your assets while running your tests, which requires you to either run the Vite development server or build your assets.
+
+If you would prefer to mock Vite during testing, you may call the `withoutVite` method, which is is available for any tests that extend Laravel's `TestCase` class:
+
+```php
+use Tests\TestCase;
+
+class ExampleTest extends TestCase
+{
+ public function test_without_vite_example()
+ {
+ $this->withoutVite();
+
+ // ...
+ }
+}
+```
+
+If you would like to disable Vite for all tests, you may call the `withoutVite` method from the `setUp` method on your base `TestCase` class:
+
+```php
+withoutVite();
+ }// [tl! add:end]
+}
+```
+
+
+## Server-Side Rendering (SSR)
+
+The Laravel Vite plugin makes it painless to set up server-side rendering with Vite. To get started, create an SSR entry point at `resources/js/ssr.js` and specify the entry point by passing a configuration option to the Laravel plugin:
+
+```js
+import { defineConfig } from 'vite';
+import laravel from 'laravel-vite-plugin';
+
+export default defineConfig({
+ plugins: [
+ laravel({
+ input: 'resources/js/app.js',
+ ssr: 'resources/js/ssr.js',
+ }),
+ ],
+});
+```
+
+To ensure you don't forget to rebuild the SSR entry point, we recommend augmenting the "build" script in your application's `package.json` to create your SSR build:
+
+```json
+"scripts": {
+ "dev": "vite",
+ "build": "vite build" // [tl! remove]
+ "build": "vite build && vite build --ssr" // [tl! add]
+}
+```
+
+Then, to build and start the SSR server, you may run the following commands:
+
+```sh
+npm run build
+node bootstrap/ssr/ssr.mjs
+```
+
+> **Note**
+> Laravel's [starter kits](/docs/{{version}}/starter-kits) already include the proper Laravel, Inertia SSR, and Vite configuration. Check out [Laravel Breeze](/docs/{{version}}/starter-kits#breeze-and-inertia) for the fastest way to get started with Laravel, Inertia SSR, and Vite.
+
+
+## Script & Style Tag Attributes
+
+
+### Content Security Policy (CSP) Nonce
+
+If you wish to include a [`nonce` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/nonce) on your script and style tags as part of your [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP), you may generate or specify a nonce using the `useCspNonce` method within a custom [middleware](/docs/{{version}}/middleware):
+
+```php
+withHeaders([
+ 'Content-Security-Policy' => "script-src 'nonce-".Vite::cspNonce()."'",
+ ]);
+ }
+}
+```
+
+After invoking the `useCspNonce` method, Laravel will automatically include the `nonce` attributes on all generated script and style tags.
+
+If you need to specify the nonce elsewhere, including the [Ziggy `@route` directive](https://github.com/tighten/ziggy#using-routes-with-a-content-security-policy) included with Laravel's [starter kits](/docs/{{version}}/starter-kits), you may retrieve it using the `cspNonce` method:
+
+```blade
+@routes(nonce: Vite::cspNonce())
+```
+
+If you already have a nonce that you would like to instruct Laravel to use, you may pass the nonce to the `useCspNonce` method:
+
+```php
+Vite::useCspNonce($nonce);
+```
+
+
+### Subresource Integrity (SRI)
+
+If your Vite manifest includes `integrity` hashes for your assets, Laravel will automatically add the `integrity` attribute on any script and style tags it generates in order to enforce [Subresource Integrity](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity). By default, Vite does not include the `integrity` hash in its manifest, but you may enable it by installing the [`vite-plugin-manifest-uri`](https://www.npmjs.com/package/vite-plugin-manifest-sri) NPM plugin:
+
+```shell
+npm install -D vite-plugin-manifest-sri
+```
+
+You may then enable this plugin in your `vite.config.js` file:
+
+```js
+import { defineConfig } from 'vite';
+import laravel from 'laravel-vite-plugin';
+import manifestSRI from 'vite-plugin-manifest-sri';// [tl! add]
+
+export default defineConfig({
+ plugins: [
+ laravel({
+ // ...
+ }),
+ manifestSRI(),// [tl! add]
+ ],
+});
+```
+
+If required, you may also customize the manifest key where the integrity hash can be found:
+
+```php
+use Illuminate\Support\Facades\Vite;
+
+Vite::useIntegrityKey('custom-integrity-key');
+```
+
+If you would like to disable this auto-detection completely, you may pass `false` to the `useIntegrityKey` method:
+
+```php
+Vite::useIntegrityKey(false);
+```
+
+
+### Arbitrary Attributes
+
+If you need to include additional attributes on your script and style tags, such as the [`data-turbo-track`](https://turbo.hotwired.dev/handbook/drive#reloading-when-assets-change) attribute, you may specify them via the `useScriptTagAttributes` and `useStyleTagAttributes` methods. Typically, this methods should be invoked from a [service provider](/docs/{{version}}/providers):
+
+```php
+use Illuminate\Support\Facades\Vite;
+
+Vite::useScriptTagAttributes([
+ 'data-turbo-track' => 'reload', // Specify a value for the attribute...
+ 'async' => true, // Specify an attribute without a value...
+ 'integrity' => false, // Exclude an attribute that would otherwise be included...
+]);
+
+Vite::useStyleTagAttributes([
+ 'data-turbo-track' => 'reload',
+]);
+```
+
+If you need to conditionally add attributes, you may pass a callback that will receive the asset source path, its URL, its manifest chunk, and the entire manifest:
+
+```php
+use Illuminate\Support\Facades\Vite;
+
+Vite::useScriptTagAttributes(fn (string $src, string $url, array|null $chunk, array|null $manifest) => [
+ 'data-turbo-track' => $src === 'resources/js/app.js' ? 'reload' : false,
+]);
+
+Vite::useStyleTagAttributes(fn (string $src, string $url, array|null $chunk, array|null $manifest) => [
+ 'data-turbo-track' => $chunk && $chunk['isEntry'] ? 'reload' : false,
+]);
+```
+
+> **Warning**
+> The `$chunk` and `$manifest` arguments will be `null` while the Vite development server is running.
+
+
+## Advanced Customization
+
+Out of the box, Laravel's Vite plugin uses sensible conventions that should work for the majority of applications; however, sometimes you may need to customize Vite's behavior. To enable additional customization options, we offer the following methods and options which can be used in place of the `@vite` Blade directive:
+
+```blade
+
+
+ {{-- ... --}}
+
+ {{
+ Vite::useHotFile(storage_path('vite.hot')) // Customize the "hot" file...
+ ->useBuildDirectory('bundle') // Customize the build directory...
+ ->useManifestFilename('assets.json') // Customize the manifest filename...
+ ->withEntryPoints(['resources/js/app.js']) // Specify the entry points...
+ }}
+
+```
+
+Within the `vite.config.js` file, you should then specify the same configuration:
+
+```js
+import { defineConfig } from 'vite';
+import laravel from 'laravel-vite-plugin';
+
+export default defineConfig({
+ plugins: [
+ laravel({
+ hotFile: 'storage/vite.hot', // Customize the "hot" file...
+ buildDirectory: 'bundle', // Customize the build directory...
+ input: ['resources/js/app.js'], // Specify the entry points...
+ }),
+ ],
+ build: {
+ manifest: 'assets.json', // Customize the manifest filename...
+ },
+});
+```
-> {tip} При отправке почтовых уведомлений не забудьте установить параметр `name` в вашем конфигурационном файле `config/app.php`. Это значение будет использоваться в верхнем и нижнем колонтитулах ваших почтовых уведомлений.
+> **Примечание**\
+> При отправке почтовых уведомлений не забудьте установить параметр `name` в вашем конфигурационном файле `config/app.php`. Это значение будет использоваться в верхнем и нижнем колонтитулах ваших почтовых уведомлений.
-
-#### Другие параметры формирования почтовых уведомлений
+
+#### Сообщения об ошибках
-Вместо определения «строк» текста в классе уведомления, вы можете использовать метод `view`, чтобы указать собственный шаблон, который следует использовать для отображения почтового уведомления:
+Некоторые уведомления информируют пользователей об ошибках, например о неудачной оплате счета. Вы можете указать, что почтовое сообщение касается ошибки, вызвав метод `error` при построении вашего сообщения. При использовании метода `error` в почтовом сообщении кнопка призыва к действию будет красной вместо черной:
/**
* Получить содержимое почтового уведомления.
@@ -342,12 +367,16 @@ php artisan make:notification InvoicePaid
*/
public function toMail($notifiable)
{
- return (new MailMessage)->view(
- 'emails.name', ['invoice' => $this->invoice]
- );
+ return (new MailMessage)
+ ->error()
+ ->subject('Invoice Payment Failed')
+ ->line('...');
}
-Вы можете определить текстовое содержимое для почтового сообщения, указав имя представления в качестве второго элемента массива, передаваемого методу `view`:
+
+#### Другие параметры формирования почтовых уведомлений
+
+Вместо определения «строк» текста в классе уведомления, вы можете использовать метод `view`, чтобы указать собственный шаблон, который следует использовать для отображения почтового уведомления:
/**
* Получить содержимое почтового уведомления.
@@ -358,15 +387,11 @@ php artisan make:notification InvoicePaid
public function toMail($notifiable)
{
return (new MailMessage)->view(
- ['emails.name.html', 'emails.name.plain'],
- ['invoice' => $this->invoice]
+ 'emails.name', ['invoice' => $this->invoice]
);
}
-
-#### Сообщения об ошибках
-
-Некоторые уведомления информируют пользователей об ошибках, например о неудачной оплате счета. Вы можете указать, что почтовое сообщение касается ошибки, вызвав метод `error` при построении вашего сообщения. При использовании метода `error` в почтовом сообщении кнопка призыва к действию будет красной вместо черной:
+Вы можете определить текстовое содержимое для почтового сообщения, указав имя представления в качестве второго элемента массива, передаваемого методу `view`:
/**
* Получить содержимое почтового уведомления.
@@ -376,10 +401,10 @@ php artisan make:notification InvoicePaid
*/
public function toMail($notifiable)
{
- return (new MailMessage)
- ->error()
- ->subject('Notification Subject')
- ->line('...');
+ return (new MailMessage)->view(
+ ['emails.name.html', 'emails.name.plain'],
+ ['invoice' => $this->invoice]
+ );
}
@@ -495,6 +520,9 @@ php artisan vendor:publish --tag=laravel-notifications
->attach('/path/to/file');
}
+> **Примечание**\
+> Метод `attach` почтовых уведомлений также принимает [прикрепляемые объекты](mail.md#attachable-objects).
+
При прикреплении файлов к сообщению вы также можете указать отображаемое имя и / или MIME-тип, передав массив в качестве второго аргумента методу `attach`:
/**
@@ -530,6 +558,27 @@ php artisan vendor:publish --tag=laravel-notifications
->attachFromStorage('/path/to/file');
}
+При необходимости к сообщению можно прикрепить несколько файлов с помощью метода `attachMany`:
+
+ /**
+ * Получить содержимое почтового уведомления.
+ *
+ * @param mixed $notifiable
+ * @return \Illuminate\Notifications\Messages\MailMessage
+ */
+ public function toMail($notifiable)
+ {
+ return (new MailMessage)
+ ->greeting('Hello!')
+ ->attachMany([
+ '/path/to/forge.svg',
+ '/path/to/vapor.svg' => [
+ 'as' => 'Logo.svg',
+ 'mime' => 'image/svg+xml',
+ ],
+ ]);
+ }
+
#### Почтовые вложения необработанных данных
@@ -572,7 +621,6 @@ php artisan vendor:publish --tag=laravel-notifications
Если ваше приложение использует драйвер Mailgun, то вы можете обратиться к документации Mailgun для получения дополнительной информации о [тегах](https://documentation.mailgun.com/en/latest/user_manual.html#tagging-1) и [метаданных](https://documentation.mailgun.com/en/latest/user_manual.html#attaching-data-to-messages). Кроме того, можно также обратиться к документации Postmark для получения дополнительной информации об их поддержке [тегов](https://postmarkapp.com/blog/tags-support-for-smtp) и [метаданных](https://postmarkapp.com/support/article/1125-custom-metadata-faq).
Если ваше приложение использует Amazon SES для отправки электронных писем, то вам следует использовать метод `metadata` для прикрепления [тегов SES](https://docs.aws.amazon.com/ses/latest/APIReference/API_MessageTag.html) к сообщению.
-Теги и метаданные могут быть добавлены в `MailMessage` – они используются вашей почтовой службой для фильтрации/обработки.
### Настройка сообщения Symfony
@@ -692,18 +740,18 @@ php artisan make:notification InvoicePaid --markdown=mail.invoice.paid
Почтовые уведомления Markdown используют комбинацию компонентов Blade и синтаксиса Markdown, которые позволяют легко создавать почтовые уведомления, используя предварительно созданные компоненты уведомлений Laravel:
```blade
-@component('mail::message')
+