mirror of
https://github.com/nextcloud/documentation.git
synced 2026-01-03 18:26:42 +07:00
72 lines
2.4 KiB
ReStructuredText
72 lines
2.4 KiB
ReStructuredText
Runtime configuration
|
|
=====================
|
|
|
|
.. sectionauthor:: Bernhard Posselt <nukeawhale@gmail.com>
|
|
|
|
|
|
|
|
Dependency Injection helps you to create testable code. A good overview over how it works and what the benefits are can be seen on `Google's Clean Code Talks <http://www.youtube.com/watch?v=RlfLCWKxHJ0>`_
|
|
|
|
The container is configured in :file:`dependencyinjection/dicontainer.php`. By default `Pimple <http://pimple.sensiolabs.org/>`_ is used as dependency injection container. A `tutorial can be found here <http://jtreminio.com/2012/10/an-introduction-to-pimple-and-service-containers/>`_
|
|
|
|
|
|
To add your own classes simply open the :file:`dependencyinjection/dicontainer.php` and add a line like this to the constructor:
|
|
|
|
.. code-block:: php
|
|
|
|
<?php
|
|
|
|
// in the constructor
|
|
|
|
$this['MyClass'] = function($c){
|
|
return new MyClass($c['SomeOtherClass']);
|
|
};
|
|
|
|
?>
|
|
|
|
You can also overwrite already existing items from the App Framework simply by redefining them.
|
|
|
|
**See also** :doc:`../general/dependencyinjection`
|
|
|
|
API abstraction layer
|
|
=====================
|
|
|
|
.. sectionauthor:: Bernhard Posselt <nukeawhale@gmail.com>
|
|
|
|
ownCloud currently has a ton of static methods which is a very bad thing concerning testability. Therefore the App Framework comes with an :php:class:`OCA\\AppFramework\\Core\\API` abstraction layer (basically a `facade <http://en.wikipedia.org/wiki/Facade_pattern>`_) which is located in the App Framework app at :file:`core/api.php`.
|
|
|
|
This is a temporary solution until ownCloud offers a proper API with normal classes that can be used in the DIContainer.
|
|
|
|
This will allow you to easily mock the API in your unittests.
|
|
|
|
If you find yourself in need to use more ownCloud internal static methods, add them to the API class in the **appframework/** directory, like:
|
|
|
|
.. code-block:: php
|
|
|
|
<?php
|
|
|
|
// inside the API class
|
|
|
|
|
|
public function methodName($someParam){
|
|
\OCP\Util::methodName($this->appName, $someParam);
|
|
}
|
|
|
|
}
|
|
?>
|
|
|
|
.. note:: Please send a pull request and cc **Raydiation** so the method can be added to the API class.
|
|
|
|
A temporary solution would be to to simply inherit from the API class and overwrite the API in the dependency injection container in :file:`dependencyinjection/dicontainer.php` by using:
|
|
|
|
.. code-block:: php
|
|
|
|
<?php
|
|
|
|
// inside the constructor
|
|
$this['API'] = $this->share(function($c){
|
|
return new MyExtendedAPI($c['AppName']);
|
|
});
|
|
|
|
|