-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
47 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,45 @@ | ||
Symfony dependency injection tags | ||
================================= | ||
|
||
The following lists all dependency injection tags and their usage available | ||
in Netgen Content Browser: | ||
|
||
``netgen_content_browser.backend`` | ||
---------------------------------- | ||
|
||
**Purpose**: Adds a new backend to the system | ||
|
||
A backend is a service that provides methods to load the list of items and | ||
locations in Content Browser interface. A backend needs to implement | ||
``Netgen\ContentBrowser\Backend\BackendInterface`` interface. | ||
|
||
When registering a new backend, you need to use the ``item_type`` attribute in | ||
the tag to specify the item type the backend is used for: | ||
|
||
.. code-block:: yaml | ||
app.content_browser.my_backend: | ||
class: AppBundle\ContentBrowser\MyBackend | ||
tags: | ||
- { name: netgen_content_browser.backend, item_type: my_backend } | ||
``netgen_content_browser.column_value_provider`` | ||
------------------------------------------------ | ||
|
||
**Purpose**: Adds a new column value provider for a single item column | ||
|
||
A column value provider is a service that provides a value to a column displayed | ||
in Content Browser interface for a specific item. Column value provider needs to | ||
implement | ||
``Netgen\ContentBrowser\Item\ColumnProvider\ColumnValueProviderInterface`` | ||
interface. | ||
|
||
When registering a new column value provider, you need to use the ``identifier`` | ||
attribute in the tag to attach a unique identifier to the provider: | ||
|
||
.. code-block:: yaml | ||
app.content_browser.my_item.custom_column: | ||
class: AppBundle\ContentBrowser\MyItem\CustomColumn | ||
tags: | ||
- { name: netgen_content_browser.column_value_provider, identifier: my_item\custom_column } |
This file contains 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 |
---|---|---|
|
@@ -7,5 +7,6 @@ Reference | |
install_instructions | ||
configuration | ||
symfony_services | ||
di_tags | ||
|
||
.. include:: /reference/map.rst.inc |
This file contains 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 |
---|---|---|
@@ -1,3 +1,4 @@ | ||
* :doc:`/reference/install_instructions` | ||
* :doc:`/reference/configuration` | ||
* :doc:`/reference/symfony_services` | ||
* :doc:`/reference/di_tags` |