khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-02 17:59:36 +07:00
Code Issues Packages Projects Releases Wiki Activity

Update DI parameters, aliases and services documentation

Browse Source 
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
This commit is contained in:
Christoph Wurst
2022-11-02 19:32:21 +01:00
parent 99f2be21c6
commit 4a04e383ec
1 changed files with 43 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
developer_manual/basics/dependency_injection.rst
View File

@@ -310,45 +310,52 @@ The following parameter names and type hints can be used to inject core services
Parameters:
* **AppName**: The app id
* **WebRoot**: The path to the Nextcloud installation
* **UserId**: The id of the current user
* **WebRoot**: The path to the Nextcloud installation
Aliases:
* **appName**: resolves to ``AppName``
* **Request**: resolves to ``\OCP\\IRequest``
* **ServerContainer**: resolves to ``\OCP\IServerContainer``
* **userId**: resolves to ``UserId``
* **webRoot**: resolves to ``WebRoot``
Types:
* **OCP\\IAppConfig**
* **OCP\\IAppManager**
* **OCP\\IAvatarManager**
* **OCP\\Activity\\IManager**
* **OCP\\ICache**
* **OCP\\ICacheFactory**
* **OCP\\IConfig**
* **OCP\\AppFramework\\Utility\\IControllerMethodReflector**
* **OCP\\Contacts\\IManager**
* **OCP\\IDateTimeZone**
* **OCP\\IDBConnection**
* **OCP\\Diagnostics\\IEventLogger**
* **OCP\\Diagnostics\\IQueryLogger**
* **OCP\\Files\\Config\\IMountProviderCollection**
* **OCP\\Files\\IRootFolder**
* **OCP\\IGroupManager**
* **OCP\\IL10N**
* **OCP\\ILogger**
* **OCP\\BackgroundJob\\IJobList**
* **OCP\\INavigationManager**
* **OCP\\IPreview**
* **OCP\\IRequest**
* **OCP\\AppFramework\\Utility\\ITimeFactory**
* **OCP\\ITagManager**
* **OCP\\ITempManager**
* **OCP\\Route\\IRouter**
* **OCP\\ISearch**
* **OCP\\ISearch**
* **OCP\\Security\\ICrypto**
* **OCP\\Security\\IHasher**
* **OCP\\Security\\ISecureRandom**
* **OCP\\IURLGenerator**
* **OCP\\IUserManager**
* **OCP\\IUserSession**
* ``\OCP\IAppConfig``
* ``\OCP\IAppManager``
* ``\OCP\IAvatarManager``
* ``\OCP\Activity\IManager``
* ``\OCP\ICache``
* ``\OCP\ICacheFactory``
* ``\OCP\IConfig``
* ``\OCP\AppFramework\Utility\IControllerMethodReflector``
* ``\OCP\Contacts\IManager``
* ``\OCP\IDateTimeZone``
* ``\OCP\IDBConnection``
* ``\OCP\Diagnostics\IEventLogger``
* ``\OCP\Diagnostics\IQueryLogger``
* ``\OCP\Files\Config\IMountProviderCollection``
* ``\OCP\Files\IRootFolder``
* ``\OCP\IGroupManager``
* ``\OCP\IL10N``
* ``\OCP\ILogger``
* ``\OCP\BackgroundJob\IJobList``
* ``\OCP\INavigationManager``
* ``\OCP\IPreview``
* ``\OCP\IRequest``
* ``\OCP\AppFramework\Utility\ITimeFactory``
* ``\OCP\ITagManager``
* ``\OCP\ITempManager``
* ``\OCP\Route\IRouter``
* ``\OCP\ISearch``
* ``\OCP\ISearch``
* ``\OCP\Security\ICrypto``
* ``\OCP\Security\IHasher``
* ``\OCP\Security\ISecureRandom``
* ``\OCP\IURLGenerator``
* ``\OCP\IUserManager``
* ``\OCP\IUserSession``
How to enable it
^^^^^^^^^^^^^^^^
@@ -396,7 +403,7 @@ What not to inject:
Accessing the container from anywhere
------------------------------------
-------------------------------------
Sometimes it can be hard to inject some service inside legacy code, in these case
you can use :code:`OCP\Server::get(MyService::class)`. This should only be used in