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

Merge pull request #12219 from nextcloud/chore/dev-logger

Browse Source 
developer: Add information about `ILogger`
This commit is contained in:
Côme Chilliet
2024-09-19 14:52:33 +02:00
committed by GitHub
parent e90f78c06f a7f76a02e6
commit 3d35893e50
3 changed files with 15 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_31.rst
View File

@@ -74,6 +74,7 @@ Changed APIs
^^^^^^^^^^^^
- Clarify ``OCP\Files\Storage\IStorage::getOwner()`` returns ``string|false``.
- The Nextcloud implementation of the ``log`` method of ``Psr\Log\LoggerInterface`` now supports ``Psr\Log\LogLevel`` as log level parameter.
Deprecated APIs
^^^^^^^^^^^^^^^
@@ -84,3 +85,10 @@ Removed APIs
^^^^^^^^^^^^
- Legacy, non functional, ``OC_App::getForms`` was removed.
- All ``OCP\ILogger`` logging methods, deprecated since Nextcloud 20, are removed.
- The interface now only holds the Nextcloud internal logging level constants.
For all logging ``Psr\Log\LoggerInterface`` should be used.
- The ``OCP\ILogger`` interface can no longer be dependency injected as it now only holds constants.
- ``OCP\IServerContainer::getLogger`` was removed, use dependency injection with ``Psr\Log\LoggerInterface`` instead.
- The internal class ``OC\AppFramework\Logger`` was removed, it should have been never used by apps.
All using apps should migrate to ``Psr\Log\LoggerInterface``.

2
developer_manual/basics/dependency_injection.rst
View File

@@ -381,7 +381,6 @@ Types:
* ``\OCP\Files\IRootFolder``
* ``\OCP\IGroupManager``
* ``\OCP\IL10N``
* ``\OCP\ILogger``
* ``\OCP\BackgroundJob\IJobList``
* ``\OCP\INavigationManager``
* ``\OCP\IPreview``
@@ -398,6 +397,7 @@ Types:
* ``\OCP\IUserManager``
* ``\OCP\IUserSession``
* ``\Psr\Container\ContainerInterface``
* ``\Psr\Log\LoggerInterface``
How to enable it
^^^^^^^^^^^^^^^^

7
developer_manual/digging_deeper/psr.rst
View File

@@ -22,12 +22,17 @@ PSR-3: Logger Interface
.. versionadded:: 19
The dependency injection container can inject an instance of a ``\Psr\Log\LoggerInterface``. This is merely a wrapper of the existing (and strongly typed) ``\OCP\ILogger``. Apps may still use the Nextcloud logger, but the `PSR-3`_ implementation shall easy the integration of 3rd party libraries that require the `PSR-3`_ logger.
The dependency injection container can inject an instance of a ``\Psr\Log\LoggerInterface``.
The `PSR-3`_ implementation shall easy the integration of 3rd party libraries that require the `PSR-3`_ logger.
.. versionchanged:: 21
Nextcloud ships version 1.1.3
.. versionchanged:: 23
Nextcloud ships version 1.1.4
.. versionchanged:: 30
Nextcloud ships version 2.0.0
.. versionchanged:: 31
The ``\Psr\Log\LoggerInterface`` fully replaced the Nextcloud internal logging methods.
.. _psr4: