-
-
Notifications
You must be signed in to change notification settings - Fork 84
Add RequestCookies doc information. Add view injection docs #225
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| # View injections | ||
|
|
||
| The view injections are designed to provide a standardized way to pass parameters to the common layer | ||
|
|
||
| of views in an application. Implementing this interface allows developers to manage the data that will be available | ||
| across various views, ensuring flexibility and reusability of code. | ||
|
|
||
| ## Configuration | ||
|
|
||
| In config `params.php`: | ||
|
|
||
|
|
||
| ```php | ||
| ... | ||
| 'yiisoft/yii-view' => [ | ||
| 'injections' => [ | ||
| Reference::to(ContentViewInjection::class), | ||
| Reference::to(CsrfViewInjection::class), | ||
| Reference::to(LayoutViewInjection::class), | ||
| ], | ||
| ], | ||
| ``` | ||
|
|
||
| ## New injections | ||
|
|
||
| Start by defining a class that will implement the `Yiisoft\Yii\View\Renderer\CommonParametersInjectionInterface`. This | ||
| class will be responsible for providing the parameters you want to inject into your view templates and layouts. | ||
|
|
||
| ```php | ||
| class MyCustomParametersInjection implements Yiisoft\Yii\View\Renderer\CommonParametersInjectionInterface | ||
| { | ||
| // Class properties and methods will go here | ||
|
|
||
| public function __construct(UserService $userService) | ||
| { | ||
| $this->userService = $userService; | ||
| } | ||
|
|
||
| public function getCommonParameters(): array | ||
| { | ||
| return [ | ||
| 'siteName' => 'My Awesome Site', | ||
| 'currentYear' => date('Y'), | ||
| 'user' => $this->userService->getCurrentUser(), | ||
| ]; | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Add your new Injection to `params.php`: | ||
|
|
||
| ```php | ||
| 'yiisoft/yii-view' => [ | ||
| 'injections' => [ | ||
| ..., | ||
| Reference::to(MyCustomParametersInjection::class), | ||
| ], | ||
| ], | ||
| ``` | ||
|
|
||
| ## Using Separate Injections for Different Layouts | ||
|
|
||
| If your application has multiple layouts, you can create separate parameter injections for each layout. This approach | ||
| allows you to tailor the parameters injected into each layout according to its specific needs, enhancing the flexibility | ||
| and maintainability of your application. | ||
|
|
||
| Create your custom ViewInjection for specific layout: | ||
|
|
||
| ```php | ||
| readonly final class CartViewInjection implements CommonParametersInjectionInterface | ||
| { | ||
| public function __construct(private Cart $cart) | ||
| { | ||
| } | ||
|
|
||
| public function getCommonParameters(): array | ||
| { | ||
| return [ | ||
| 'cart' => $this->cart, | ||
| ]; | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Add your new injection to `params.php` under specific layout name. In the following example, it is `@layout/cart`: | ||
|
|
||
| ```php | ||
| 'yiisoft/yii-view' => [ | ||
| 'injections' => [ | ||
| ..., | ||
| Reference::to(MyCustomParametersInjection::class), | ||
| DynamicReference::to(static function (ContainerInterface $container) { | ||
| $cart = $container | ||
| ->get(Cart::class); | ||
|
|
||
| return new LayoutSpecificInjections( | ||
| '@layout/cart', // layout name for injection | ||
|
|
||
| new CartViewInjection($cart) | ||
| ); | ||
| }), | ||
| ], | ||
| ], | ||
| ``` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.