From: Chuck Hagenbuch Date: Fri, 2 Oct 2009 02:47:20 +0000 (-0400) Subject: Remove Horde_Provider (superceded by Horde_Injector) X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=663077f91cc0580208c047af7887adbdefef939e;p=horde.git Remove Horde_Provider (superceded by Horde_Injector) --- diff --git a/framework/Provider/COPYING b/framework/Provider/COPYING deleted file mode 100644 index d1c6b98aa..000000000 --- a/framework/Provider/COPYING +++ /dev/null @@ -1,504 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 2.1, February 1999 - - Copyright 1991, 1999 Free Software Foundation, Inc. - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -[This is the first released version of the Lesser GPL. It also counts - as the successor of the GNU Library Public License, version 2, hence - the version number 2.1.] - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -Licenses are intended to guarantee your freedom to share and change -free software--to make sure the software is free for all its users. - - This license, the Lesser General Public License, applies to some -specially designated software packages--typically libraries--of the -Free Software Foundation and other authors who decide to use it. You -can use it too, but we suggest you first think carefully about whether -this license or the ordinary General Public License is the better -strategy to use in any particular case, based on the explanations below. - - When we speak of free software, we are referring to freedom of use, -not price. Our General Public Licenses are designed to make sure that -you have the freedom to distribute copies of free software (and charge -for this service if you wish); that you receive source code or can get -it if you want it; that you can change the software and use pieces of -it in new free programs; and that you are informed that you can do -these things. - - To protect your rights, we need to make restrictions that forbid -distributors to deny you these rights or to ask you to surrender these -rights. These restrictions translate to certain responsibilities for -you if you distribute copies of the library or if you modify it. - - For example, if you distribute copies of the library, whether gratis -or for a fee, you must give the recipients all the rights that we gave -you. You must make sure that they, too, receive or can get the source -code. If you link other code with the library, you must provide -complete object files to the recipients, so that they can relink them -with the library after making changes to the library and recompiling -it. And you must show them these terms so they know their rights. - - We protect your rights with a two-step method: (1) we copyright the -library, and (2) we offer you this license, which gives you legal -permission to copy, distribute and/or modify the library. - - To protect each distributor, we want to make it very clear that -there is no warranty for the free library. Also, if the library is -modified by someone else and passed on, the recipients should know -that what they have is not the original version, so that the original -author's reputation will not be affected by problems that might be -introduced by others. - - Finally, software patents pose a constant threat to the existence of -any free program. We wish to make sure that a company cannot -effectively restrict the users of a free program by obtaining a -restrictive license from a patent holder. Therefore, we insist that -any patent license obtained for a version of the library must be -consistent with the full freedom of use specified in this license. - - Most GNU software, including some libraries, is covered by the -ordinary GNU General Public License. This license, the GNU Lesser -General Public License, applies to certain designated libraries, and -is quite different from the ordinary General Public License. We use -this license for certain libraries in order to permit linking those -libraries into non-free programs. - - When a program is linked with a library, whether statically or using -a shared library, the combination of the two is legally speaking a -combined work, a derivative of the original library. The ordinary -General Public License therefore permits such linking only if the -entire combination fits its criteria of freedom. The Lesser General -Public License permits more lax criteria for linking other code with -the library. - - We call this license the "Lesser" General Public License because it -does Less to protect the user's freedom than the ordinary General -Public License. It also provides other free software developers Less -of an advantage over competing non-free programs. These disadvantages -are the reason we use the ordinary General Public License for many -libraries. However, the Lesser license provides advantages in certain -special circumstances. - - For example, on rare occasions, there may be a special need to -encourage the widest possible use of a certain library, so that it becomes -a de-facto standard. To achieve this, non-free programs must be -allowed to use the library. A more frequent case is that a free -library does the same job as widely used non-free libraries. In this -case, there is little to gain by limiting the free library to free -software only, so we use the Lesser General Public License. - - In other cases, permission to use a particular library in non-free -programs enables a greater number of people to use a large body of -free software. For example, permission to use the GNU C Library in -non-free programs enables many more people to use the whole GNU -operating system, as well as its variant, the GNU/Linux operating -system. - - Although the Lesser General Public License is Less protective of the -users' freedom, it does ensure that the user of a program that is -linked with the Library has the freedom and the wherewithal to run -that program using a modified version of the Library. - - The precise terms and conditions for copying, distribution and -modification follow. Pay close attention to the difference between a -"work based on the library" and a "work that uses the library". The -former contains code derived from the library, whereas the latter must -be combined with the library in order to run. - - GNU LESSER GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License Agreement applies to any software library or other -program which contains a notice placed by the copyright holder or -other authorized party saying it may be distributed under the terms of -this Lesser General Public License (also called "this License"). -Each licensee is addressed as "you". - - A "library" means a collection of software functions and/or data -prepared so as to be conveniently linked with application programs -(which use some of those functions and data) to form executables. - - The "Library", below, refers to any such software library or work -which has been distributed under these terms. A "work based on the -Library" means either the Library or any derivative work under -copyright law: that is to say, a work containing the Library or a -portion of it, either verbatim or with modifications and/or translated -straightforwardly into another language. (Hereinafter, translation is -included without limitation in the term "modification".) - - "Source code" for a work means the preferred form of the work for -making modifications to it. For a library, complete source code means -all the source code for all modules it contains, plus any associated -interface definition files, plus the scripts used to control compilation -and installation of the library. - - Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running a program using the Library is not restricted, and output from -such a program is covered only if its contents constitute a work based -on the Library (independent of the use of the Library in a tool for -writing it). Whether that is true depends on what the Library does -and what the program that uses the Library does. - - 1. You may copy and distribute verbatim copies of the Library's -complete source code as you receive it, in any medium, provided that -you conspicuously and appropriately publish on each copy an -appropriate copyright notice and disclaimer of warranty; keep intact -all the notices that refer to this License and to the absence of any -warranty; and distribute a copy of this License along with the -Library. - - You may charge a fee for the physical act of transferring a copy, -and you may at your option offer warranty protection in exchange for a -fee. - - 2. You may modify your copy or copies of the Library or any portion -of it, thus forming a work based on the Library, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) The modified work must itself be a software library. - - b) You must cause the files modified to carry prominent notices - stating that you changed the files and the date of any change. - - c) You must cause the whole of the work to be licensed at no - charge to all third parties under the terms of this License. - - d) If a facility in the modified Library refers to a function or a - table of data to be supplied by an application program that uses - the facility, other than as an argument passed when the facility - is invoked, then you must make a good faith effort to ensure that, - in the event an application does not supply such function or - table, the facility still operates, and performs whatever part of - its purpose remains meaningful. - - (For example, a function in a library to compute square roots has - a purpose that is entirely well-defined independent of the - application. Therefore, Subsection 2d requires that any - application-supplied function or table used by this function must - be optional: if the application does not supply it, the square - root function must still compute square roots.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Library, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Library, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote -it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Library. - -In addition, mere aggregation of another work not based on the Library -with the Library (or with a work based on the Library) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may opt to apply the terms of the ordinary GNU General Public -License instead of this License to a given copy of the Library. To do -this, you must alter all the notices that refer to this License, so -that they refer to the ordinary GNU General Public License, version 2, -instead of to this License. (If a newer version than version 2 of the -ordinary GNU General Public License has appeared, then you can specify -that version instead if you wish.) Do not make any other change in -these notices. - - Once this change is made in a given copy, it is irreversible for -that copy, so the ordinary GNU General Public License applies to all -subsequent copies and derivative works made from that copy. - - This option is useful when you wish to copy part of the code of -the Library into a program that is not a library. - - 4. You may copy and distribute the Library (or a portion or -derivative of it, under Section 2) in object code or executable form -under the terms of Sections 1 and 2 above provided that you accompany -it with the complete corresponding machine-readable source code, which -must be distributed under the terms of Sections 1 and 2 above on a -medium customarily used for software interchange. - - If distribution of object code is made by offering access to copy -from a designated place, then offering equivalent access to copy the -source code from the same place satisfies the requirement to -distribute the source code, even though third parties are not -compelled to copy the source along with the object code. - - 5. A program that contains no derivative of any portion of the -Library, but is designed to work with the Library by being compiled or -linked with it, is called a "work that uses the Library". Such a -work, in isolation, is not a derivative work of the Library, and -therefore falls outside the scope of this License. - - However, linking a "work that uses the Library" with the Library -creates an executable that is a derivative of the Library (because it -contains portions of the Library), rather than a "work that uses the -library". The executable is therefore covered by this License. -Section 6 states terms for distribution of such executables. - - When a "work that uses the Library" uses material from a header file -that is part of the Library, the object code for the work may be a -derivative work of the Library even though the source code is not. -Whether this is true is especially significant if the work can be -linked without the Library, or if the work is itself a library. The -threshold for this to be true is not precisely defined by law. - - If such an object file uses only numerical parameters, data -structure layouts and accessors, and small macros and small inline -functions (ten lines or less in length), then the use of the object -file is unrestricted, regardless of whether it is legally a derivative -work. (Executables containing this object code plus portions of the -Library will still fall under Section 6.) - - Otherwise, if the work is a derivative of the Library, you may -distribute the object code for the work under the terms of Section 6. -Any executables containing that work also fall under Section 6, -whether or not they are linked directly with the Library itself. - - 6. As an exception to the Sections above, you may also combine or -link a "work that uses the Library" with the Library to produce a -work containing portions of the Library, and distribute that work -under terms of your choice, provided that the terms permit -modification of the work for the customer's own use and reverse -engineering for debugging such modifications. - - You must give prominent notice with each copy of the work that the -Library is used in it and that the Library and its use are covered by -this License. You must supply a copy of this License. If the work -during execution displays copyright notices, you must include the -copyright notice for the Library among them, as well as a reference -directing the user to the copy of this License. Also, you must do one -of these things: - - a) Accompany the work with the complete corresponding - machine-readable source code for the Library including whatever - changes were used in the work (which must be distributed under - Sections 1 and 2 above); and, if the work is an executable linked - with the Library, with the complete machine-readable "work that - uses the Library", as object code and/or source code, so that the - user can modify the Library and then relink to produce a modified - executable containing the modified Library. (It is understood - that the user who changes the contents of definitions files in the - Library will not necessarily be able to recompile the application - to use the modified definitions.) - - b) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (1) uses at run time a - copy of the library already present on the user's computer system, - rather than copying library functions into the executable, and (2) - will operate properly with a modified version of the library, if - the user installs one, as long as the modified version is - interface-compatible with the version that the work was made with. - - c) Accompany the work with a written offer, valid for at - least three years, to give the same user the materials - specified in Subsection 6a, above, for a charge no more - than the cost of performing this distribution. - - d) If distribution of the work is made by offering access to copy - from a designated place, offer equivalent access to copy the above - specified materials from the same place. - - e) Verify that the user has already received a copy of these - materials or that you have already sent this user a copy. - - For an executable, the required form of the "work that uses the -Library" must include any data and utility programs needed for -reproducing the executable from it. However, as a special exception, -the materials to be distributed need not include anything that is -normally distributed (in either source or binary form) with the major -components (compiler, kernel, and so on) of the operating system on -which the executable runs, unless that component itself accompanies -the executable. - - It may happen that this requirement contradicts the license -restrictions of other proprietary libraries that do not normally -accompany the operating system. Such a contradiction means you cannot -use both them and the Library together in an executable that you -distribute. - - 7. You may place library facilities that are a work based on the -Library side-by-side in a single library together with other library -facilities not covered by this License, and distribute such a combined -library, provided that the separate distribution of the work based on -the Library and of the other library facilities is otherwise -permitted, and provided that you do these two things: - - a) Accompany the combined library with a copy of the same work - based on the Library, uncombined with any other library - facilities. This must be distributed under the terms of the - Sections above. - - b) Give prominent notice with the combined library of the fact - that part of it is a work based on the Library, and explaining - where to find the accompanying uncombined form of the same work. - - 8. You may not copy, modify, sublicense, link with, or distribute -the Library except as expressly provided under this License. Any -attempt otherwise to copy, modify, sublicense, link with, or -distribute the Library is void, and will automatically terminate your -rights under this License. However, parties who have received copies, -or rights, from you under this License will not have their licenses -terminated so long as such parties remain in full compliance. - - 9. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Library or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Library (or any work based on the -Library), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Library or works based on it. - - 10. Each time you redistribute the Library (or any work based on the -Library), the recipient automatically receives a license from the -original licensor to copy, distribute, link with or modify the Library -subject to these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties with -this License. - - 11. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Library at all. For example, if a patent -license would not permit royalty-free redistribution of the Library by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Library. - -If any portion of this section is held invalid or unenforceable under any -particular circumstance, the balance of the section is intended to apply, -and the section as a whole is intended to apply in other circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 12. If the distribution and/or use of the Library is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Library under this License may add -an explicit geographical distribution limitation excluding those countries, -so that distribution is permitted only in or among countries not thus -excluded. In such case, this License incorporates the limitation as if -written in the body of this License. - - 13. The Free Software Foundation may publish revised and/or new -versions of the Lesser General Public License from time to time. -Such new versions will be similar in spirit to the present version, -but may differ in detail to address new problems or concerns. - -Each version is given a distinguishing version number. If the Library -specifies a version number of this License which applies to it and -"any later version", you have the option of following the terms and -conditions either of that version or of any later version published by -the Free Software Foundation. If the Library does not specify a -license version number, you may choose any version ever published by -the Free Software Foundation. - - 14. If you wish to incorporate parts of the Library into other free -programs whose distribution conditions are incompatible with these, -write to the author to ask for permission. For software which is -copyrighted by the Free Software Foundation, write to the Free -Software Foundation; we sometimes make exceptions for this. Our -decision will be guided by the two goals of preserving the free status -of all derivatives of our free software and of promoting the sharing -and reuse of software generally. - - NO WARRANTY - - 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO -WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. -EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR -OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY -KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE -LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME -THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN -WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY -AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU -FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR -CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE -LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING -RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A -FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF -SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH -DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Libraries - - If you develop a new library, and you want it to be of the greatest -possible use to the public, we recommend making it free software that -everyone can redistribute and change. You can do so by permitting -redistribution under these terms (or, alternatively, under the terms of the -ordinary General Public License). - - To apply these terms, attach the following notices to the library. It is -safest to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least the -"copyright" line and a pointer to where the full notice is found. - - - Copyright - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - -Also add information on how to contact you by electronic and paper mail. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the library, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the - library `Frob' (a library for tweaking knobs) written by James Random Hacker. - - , 1 April 1990 - Ty Coon, President of Vice - -That's all there is to it! - - diff --git a/framework/Provider/doc/Horde/Provider/usage.txt b/framework/Provider/doc/Horde/Provider/usage.txt deleted file mode 100644 index 4f8698b32..000000000 --- a/framework/Provider/doc/Horde/Provider/usage.txt +++ /dev/null @@ -1,292 +0,0 @@ -Introduction -============ - -Dependency injection -(http://en.wikipedia.org/wiki/Dependency_injection) is a useful design -pattern that can help to avoid using global variables or state. If a -class depends on a connection to a database then this connection is -often pulled into the class using a singleton pattern or by using a -global variable. - -Instead of providing the class with knowlegde about the global state -it is often preferable to "inject" the dependency into the class from -the outside. This usually happens within the class constructor. Thus -the dependencies of a class are immediately visible without searching -the code for references to the global scope. Another major benefit of -dependency injection is the fact that it facilitates unit testing of -complex systems. - -Horde_Provider -============== - -For PHP there exist several "Dependency Injection" frameworks -(e.g. http://stubbles.net, -http://components.symfony-project.org/dependency-injection) with -extensive feature lists. So there is hardly any need for another -framework with similar capabilities. - -The essential part of dependency injection is the structure of classes -with dependencies. They need to be amenable for an external management -of their dependencies. If that is the case for a given class then most -frameworks should have no problem handling this class within the -framework. The choice of the actual framework should not matter -anymore. - -In consequence Horde_Provider provides only a minimal version of -dependency injection that is mainly inspired by Twittee -(http://twittee.org/). The goal is to drive refactoring of classes -with complex dependencies so that they can be used with a dependency -injection framework. - -Making classes amenable to dependency injection -=============================================== - -As trivial as it may sound: a class can be managed by a dependency -injection framework if the class allows the framework to inject its -dependencies from the outside. That means that the class may *NOT* - - - pull in an dependency using global state via the singleton - pattern: - - External_Class::singleton()) - - - create new objects with dependencies: - - $db = new DB(); - $b = new User($db); - - - use global variables: - - if ($conf['a']) echo 'yes'; - -In most cases the class should receive dependencies and required -parameters within the constructor. - -Using Horde_Provider -==================== - -The Horde_Provider_Base class is a simple container that allows you to -fill it with a number of elements that can be retrieved later: - - $a = new Horde_Provider_Base(); - $a->a = 'a'; - echo $a->a; - - a - -Classes with dependencies are represented by registering a wrapper -object that implements the Horde_Provider_Injection interface: - - function factory() { return 'constructed'; } - $a = new Horde_Provider_Base(); - $b = new Horde_Provider_Injection_Factory('factory'); - $a->inject = $b; - echo $a->inject; - - constructed - -The example above demonstrates this approach by using the -Horde_Provider_Injection_Factory which implements -Horde_Provider_Injection. The class allows to register a callable -function. It will use this function to construct the required -object. Here the factory function is simple though and does not return -an object but a string. - -Preparing a class for Horde_Provider -==================================== - -Assume you have the following simple class that represents a common -structure found in many of the Horde packages: - - class Horde_X - { - /** - * Instance object. - * - * @var Horde_X - */ - static protected $_instance; - - /** - * Pointer to a DB instance. - * - * @var DB - */ - protected $_db; - - /** - * Attempts to return a reference to a concrete Horde_X instance. - * - * @return Horde_X The concrete Horde_X reference. - * @throws Horde_Exception - */ - static public function singleton() - { - if (!isset(self::$_instance)) { - self::$_instance = new Horde_X(); - } - - return self::$_instance; - } - - /** - * Constructor. - */ - public function __construct() - { - global $conf; - - $this->_db = DB::connect($conf['sql']); - } - } - -The class obviously depends on a database connection. The constructor -above does not allow for dependency injection as it constructs the -database connection itself. It uses the global variable $conf in order -to get the settings for this connection. A constructor allowing -dependency injection would look like this: - - /** - * Constructor. - * - * @param DB $db A database connection. - */ - public function __construct(DB $db) - { - $this->_db = $db; - } - -Of course this connection must be provided from somewhere. The -application using Horde_X might simply provide it when creating the -Horde_X instance. If the application is however using a dependency -injection framework then this framework would be required to provide -the required database connection. - -If the application uses Horde_Provider it would be necessary to -provide a factory method as Horde_Provider currently only allows to -call factory methods via Horde_Provider_Injection_Factory: - - /** - * Return a reference to a new Horde_X instance. - * - * @return Horde_X The new Horde_X reference. - */ - static public function factory($provider) - { - $x = new Horde_X($provider->db) - return $x; - } - -The fact that we need this factory method is a specific shortcoming of -the current capabilites of the Horde_Provider system. A more complex -dependency injection framework would have the ability to look at the -Horde_X constructor. It would then fetch the required dependencies -based on the constructor arguments. Type hinting is usually required -to inform the framework of the required dependency. In case of Horde_X -we used type hinting to indicate that we need an object of type "DB" -as parameter "$db". - -Getting rid of singletons? -========================== - -From the viewpoint of dependency injection Horde_X can be used now as -it allows external injection of its dependencies. We could throw away -the singleton now. There might be some reasons however why we would -like to keep the singleton() method. One of the reasons might be -backward compatibility as some other classes or applications are bound -to use the method. Another reason might be that we want to clarify how -to get a functional instance of the class to somebody just looking at -the Horde_X class. The factory method requires that there is a -$provider object "magically" providing the db connection. - -We could keep the following singleton method: - - static public function singleton() - { - if (!isset(self::$_instance)) { - global $conf; - - $provider = new stdClass; - $provider->db = DB::connect($conf['sql']); - self::$_instance = Horde_X::factory($provider); - } - - return self::$_instance; - } - -In this specific case it would probably be easier to directly use the -Horde_X constructor rather than the factory method but there might be -situations where the factory method has a higher complexity. - -We do not gain much here: The magic $provider->db parameter is -exchanged against the magic $conf['sql'] parameter. However the -singleton demonstrates how the DB class is instantiated via the -DB::connect() method. That is something that was not visible in the -factory method. - -A decent singleton method would require the database configuration as -a parameter for the method and refer to the DB class for details -concerning the possible configuration settings. That would however -break backward compatibility for the method. - -Result -====== - -The final result that can be used with a dependency injection -framework and still provides a backward compatible singleton method: - - class Horde_X - { - /** - * Instance object. - * - * @var Horde_X - */ - static protected $_instance; - - /** - * Pointer to a DB instance. - * - * @var DB - */ - protected $_db; - - /** - * Attempts to return a reference to a concrete Horde_X instance. - * - * @return Horde_X The concrete Horde_X reference. - */ - static public function singleton() - { - if (!isset(self::$_instance)) { - global $conf; - - $provider = new stdClass; - $provider->db = DB::connect($conf['sql']); - self::$_instance = Horde_X::factory($provider); - } - - return self::$_instance; - } - - /** - * Return a reference to a new Horde_X instance. - * - * @return Horde_X The new Horde_X reference. - */ - static public function factory($provider) - { - $x = new Horde_X($provider->db) - return $x; - } - - /** - * Constructor. - * - * @param DB $db A database connection. - */ - public function __construct(DB $db) - { - $this->_db = $db; - } - } diff --git a/framework/Provider/lib/Horde/Provider/Base.php b/framework/Provider/lib/Horde/Provider/Base.php deleted file mode 100644 index 0d1ba7a21..000000000 --- a/framework/Provider/lib/Horde/Provider/Base.php +++ /dev/null @@ -1,103 +0,0 @@ - - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ - -/** - * A trivial implementation of a provider. - * - * This class holds a set of elements that can be provided to an - * application. Special placeholder values of elements that are not instantiated - * yet implement the Horde_Provider_Binding interface. Such elements will get - * instantiated during retrieval by calling getInstance() on the binding - * object. The only argument to that call is the provider itself. The binding - * object can use this reference to retrieve any other elements it needs to - * correctly instantiate the desired object. - * - * Copyright 2009 The Horde Project (http://www.horde.org/) - * - * See the enclosed file COPYING for license information (LGPL). If you did not - * receive this file, see - * http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. - * - * @category Horde - * @package Provider - * @author Gunnar Wrobel - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ -class Horde_Provider_Base -{ - /** - * The set of elements handled by this container. - * - * @var array - */ - protected $elements; - - /** - * Set an element for this container. - * - * @param string $k The key of the element to set. - * @param mixed $v The element to set. - * - * @return NULL - */ - public function __set($k, $v) - { - $this->elements[$k] = $v; - } - - /** - * Get an element from this container. - * - * @param string $k The key of the element to retrieve. - * - * @return mixed The element. - */ - public function __get($k) - { - if (isset($this->elements[$k])) { - if ($this->elements[$k] instanceOf Horde_Provider_Injection) { - $this->elements[$k] = $this->elements[$k]->getInstance($this); - } - return $this->elements[$k]; - } else { - throw new Horde_Provider_Exception(sprintf("No such element: %s", $k)); - } - } - - /** - * Test if the element is available. - * - * @param string $k The key of the element to test for. - * - * @return boolean True if the element is sset, false otherwise. - */ - public function __isset($k) - { - return isset($this->elements[$k]); - } - - /** - * Delete the element. - * - * @param string $k The key of the element to delete. - * - * @return NULL - */ - public function __unset($k) - { - if (isset($this->elements[$k])) { - unset($this->elements[$k]); - } - } -} \ No newline at end of file diff --git a/framework/Provider/lib/Horde/Provider/Exception.php b/framework/Provider/lib/Horde/Provider/Exception.php deleted file mode 100644 index 45407614e..000000000 --- a/framework/Provider/lib/Horde/Provider/Exception.php +++ /dev/null @@ -1,31 +0,0 @@ - - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ - -/** - * The standard exception for the Horde_Provider package. - * - * Copyright 2009 The Horde Project (http://www.horde.org/) - * - * See the enclosed file COPYING for license information (LGPL). If you did not - * receive this file, see - * http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. - * - * @category Horde - * @package Provider - * @author Gunnar Wrobel - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ -class Horde_Provider_Exception extends Horde_Exception -{ -} \ No newline at end of file diff --git a/framework/Provider/lib/Horde/Provider/Injection.php b/framework/Provider/lib/Horde/Provider/Injection.php deleted file mode 100644 index c6680be65..000000000 --- a/framework/Provider/lib/Horde/Provider/Injection.php +++ /dev/null @@ -1,40 +0,0 @@ - - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ - -/** - * The interface that describes the binding classes. - * - * Copyright 2009 The Horde Project (http://www.horde.org/) - * - * See the enclosed file COPYING for license information (LGPL). If you did not - * receive this file, see - * http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. - * - * @category Horde - * @package Provider - * @author Gunnar Wrobel - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ -Interface Horde_Provider_Injection -{ - /** - * Create an instance of the proxied object. - * - * @param Horde_Provider_Base $provider The class providing additional - * required dependencies. - * - * @return mixed The generated instance. - */ - public function getInstance(Horde_Provider_Base $provider); -} \ No newline at end of file diff --git a/framework/Provider/lib/Horde/Provider/Injection/Base.php b/framework/Provider/lib/Horde/Provider/Injection/Base.php deleted file mode 100644 index 27be12b37..000000000 --- a/framework/Provider/lib/Horde/Provider/Injection/Base.php +++ /dev/null @@ -1,50 +0,0 @@ - - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ - -/** - * The basic definition for generating an elemnt. - * - * Copyright 2009 The Horde Project (http://www.horde.org/) - * - * See the enclosed file COPYING for license information (LGPL). If you did not - * receive this file, see - * http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. - * - * @category Horde - * @package Provider - * @author Gunnar Wrobel - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ -class Horde_Provider_Injection_Base implements Horde_Provider_Injection -{ - - protected $loading = false; - - /** - * Create an instance of the proxied object. - * - * @param Horde_Provider_Base $provider The class providing additional - * required dependencies. - * - * @return NULL - */ - public function getInstance(Horde_Provider_Base $provider) - { - if ($this->loading) { - throw new Horde_Provider_Exception('Element already loading!'); - } - - $this->loading = true; - } -} \ No newline at end of file diff --git a/framework/Provider/lib/Horde/Provider/Injection/Factory.php b/framework/Provider/lib/Horde/Provider/Injection/Factory.php deleted file mode 100644 index c0665476f..000000000 --- a/framework/Provider/lib/Horde/Provider/Injection/Factory.php +++ /dev/null @@ -1,59 +0,0 @@ - - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ - -/** - * This class generates an element via a factory method. - * - * Copyright 2009 The Horde Project (http://www.horde.org/) - * - * See the enclosed file COPYING for license information (LGPL). If you did not - * receive this file, see - * http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. - * - * @category Horde - * @package Provider - * @author Gunnar Wrobel - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ -class Horde_Provider_Injection_Factory extends Horde_Provider_Injection_Base -{ - /** - * Constructor. - * - * @param mixed $factory A callable factory function. - */ - public function __construct($factory) - { - $this->factory = $factory; - } - - /** - * Create an instance of the proxied object via the factory method. - * - * @param Horde_Provider_Base $provider The class providing additional - * required dependencies. - * - * @return mixed The instance generated by the factory. - */ - public function getInstance(Horde_Provider_Base $provider) - { - parent::getInstance($provider); - - $instance = call_user_func($this->factory, $provider); - - $this->loading = false; - - return $instance; - } -} \ No newline at end of file diff --git a/framework/Provider/package.xml b/framework/Provider/package.xml deleted file mode 100644 index 91e755a21..000000000 --- a/framework/Provider/package.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - Provider - pear.horde.org - A provider for dependency injection. - This module provides an extremely simplified approad to dependency - injection. - - - Gunnar Wrobel - wrobel - p@rdus.de - yes - - - Chuck Hagenbuch - chuck - chuck@horde.org - yes - - - Jan Schneider - jan - jan@horde.org - yes - - 2009-09-15 - - 0.0.1 - 0.0.1 - - - alpha - alpha - - LGPL - - * Initial release. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 4.3.0 - - - 1.4.0b1 - - - Exception - pear.horde.org - - - - - - - - - - - - - - - - - diff --git a/framework/Provider/test/Horde/Provider/AllTests.php b/framework/Provider/test/Horde/Provider/AllTests.php deleted file mode 100644 index 9884a6257..000000000 --- a/framework/Provider/test/Horde/Provider/AllTests.php +++ /dev/null @@ -1,88 +0,0 @@ - - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ - -/** - * Define the main method - */ -if (!defined('PHPUnit_MAIN_METHOD')) { - define('PHPUnit_MAIN_METHOD', 'Horde_Provider_AllTests::main'); -} - -/** - * The Autoloader allows us to omit "require/include" statements. - */ -require_once 'Horde/Autoloader.php'; - -/** - * Combine the tests for this package. - * - * Copyright 2007-2009 The Horde Project (http://www.horde.org/) - * - * See the enclosed file COPYING for license information (LGPL). If you - * did not receive this file, see http://www.fsf.org/copyleft/lgpl.html. - * - * @category Horde - * @package Provider - * @subpackage UnitTests - * @author Gunnar Wrobel - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ -class Horde_Provider_AllTests -{ - - /** - * Main entry point for running the suite. - * - * @return NULL - */ - public static function main() - { - PHPUnit_TextUI_TestRunner::run(self::suite()); - } - - /** - * Collect the unit tests of this directory into a new suite. - * - * @return PHPUnit_Framework_TestSuite The test suite. - */ - public static function suite() - { - // Catch strict standards - error_reporting(E_ALL | E_STRICT); - - $suite = new PHPUnit_Framework_TestSuite('Horde Framework - Horde_Provider'); - - $basedir = dirname(__FILE__); - $baseregexp = preg_quote($basedir . DIRECTORY_SEPARATOR, '/'); - - foreach (new RecursiveIteratorIterator(new RecursiveDirectoryIterator($basedir)) as $file) { - if ($file->isFile() && preg_match('/Test.php$/', $file->getFilename())) { - $pathname = $file->getPathname(); - require $pathname; - - $class = str_replace(DIRECTORY_SEPARATOR, '_', - preg_replace("/^$baseregexp(.*)\.php/", '\\1', $pathname)); - $suite->addTestSuite('Horde_Provider_' . $class); - } - } - - return $suite; - } - -} - -if (PHPUnit_MAIN_METHOD == 'Horde_Provider_AllTests::main') { - Horde_Provider_AllTests::main(); -} diff --git a/framework/Provider/test/Horde/Provider/ProviderScenario.php b/framework/Provider/test/Horde/Provider/ProviderScenario.php deleted file mode 100644 index 76e4084dc..000000000 --- a/framework/Provider/test/Horde/Provider/ProviderScenario.php +++ /dev/null @@ -1,120 +0,0 @@ - - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ - -/** - * The Autoloader allows us to omit "require/include" statements. - */ -require_once 'Horde/Autoloader.php'; - -/** - * Test the Horde_Provider class. - * - * Copyright 2009 The Horde Project (http://www.horde.org/) - * - * See the enclosed file COPYING for license information (LGPL). If you - * did not receive this file, see http://www.fsf.org/copyleft/lgpl.html. - * - * @category Horde - * @package Provider - * @subpackage UnitTests - * @author Gunnar Wrobel - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ -class Horde_Provider_ProviderScenario extends PHPUnit_Extensions_Story_TestCase -{ - /** - * Handle a "given" step. - * - * @param array &$world Joined "world" of variables. - * @param string $action The description of the step. - * @param array $arguments Additional arguments to the step. - * - * @return mixed The outcome of the step. - */ - public function runGiven(&$world, $action, $arguments) - { - switch($action) { - case 'a provider': - $world['provider'] = new Horde_Provider_Base(); - break; - case 'a registered element': - $world['provider']->{$arguments[0]} = $arguments[1]; - break; - default: - return $this->notImplemented($action); - } - } - - /** - * Handle a "when" step. - * - * @param array &$world Joined "world" of variables. - * @param string $action The description of the step. - * @param array $arguments Additional arguments to the step. - * - * @return mixed The outcome of the step. - */ - public function runWhen(&$world, $action, $arguments) - { - switch($action) { - case 'retrieving the element': - try { - $world['result'] = $world['provider']->{$arguments[0]}; - } catch (Exception $e) { - $world['result'] = $e; - } - break; - case 'deleting the element': - try { - unset($world['provider']->{$arguments[0]}); - } catch (Exception $e) { - $world['result'] = $e; - } - break; - default: - return $this->notImplemented($action); - } - } - - /** - * Handle a "then" step. - * - * @param array &$world Joined "world" of variables. - * @param string $action The description of the step. - * @param array $arguments Additional arguments to the step. - * - * @return mixed The outcome of the step. - */ - public function runThen(&$world, $action, $arguments) - { - switch($action) { - case 'the result is': - $this->assertEquals($arguments[0], $world['result']); - break; - case 'the result is an error': - $this->assertTrue($world['result'] instanceOf Exception); - break; - case 'the result is an error with the message': - $this->assertTrue($world['result'] instanceOf Exception); - $this->assertEquals($arguments[0], $world['result']->getMessage()); - break; - case 'the element exists': - $this->assertTrue(isset($world['provider']->{$arguments[0]})); - break; - default: - return $this->notImplemented($action); - } - } -} diff --git a/framework/Provider/test/Horde/Provider/ProviderTest.php b/framework/Provider/test/Horde/Provider/ProviderTest.php deleted file mode 100644 index 54edf1a1e..000000000 --- a/framework/Provider/test/Horde/Provider/ProviderTest.php +++ /dev/null @@ -1,213 +0,0 @@ - - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ - -/** - * Load the basic story testing class. - */ -require_once 'ProviderScenario.php'; - -/** - * Test the Horde_Provider class. - * - * Copyright 2009 The Horde Project (http://www.horde.org/) - * - * See the enclosed file COPYING for license information (LGPL). If you - * did not receive this file, see http://www.fsf.org/copyleft/lgpl.html. - * - * @category Horde - * @package Provider - * @subpackage UnitTests - * @author Gunnar Wrobel - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ -class Horde_Provider_ProviderTest extends Horde_Provider_ProviderScenario -{ - /** - * Test retrieving an unset element. - * - * @scenario - * - * @return NULL - */ - public function retrievingAnUnsetElementYieldsAnError() - { - $this->given('a provider') - ->when('retrieving the element', 'key') - ->then('the result is an error with the message', - 'No such element: key'); - } - - /** - * Test retrieving a simple element. - * - * @scenario - * - * @return NULL - */ - public function retrievingASimpleElement() - { - $this->given('a provider') - ->given('a registered element', 'key', 'value') - ->when('retrieving the element', 'key') - ->then('the element exists', 'key') - ->then('the result is', 'value'); - } - - /** - * Test deleting a simple element. - * - * @scenario - * - * @return NULL - */ - public function deletingASimpleElement() - { - $this->given('a provider') - ->given('a registered element', 'key', 'value') - ->when('deleting the element', 'key') - ->when('retrieving the element', 'key') - ->then('the result is an error with the message', - 'No such element: key'); - } - - /** - * Test retrieving a new element with invalid recursion. - * - * @scenario - * - * @return NULL - */ - public function retrievingARecursingElement() - { - $injection = new Horde_Provider_Injection_Factory(array('Recursion', - 'getValue')); - - $this->given('a provider') - ->given('a registered element', 'recursion', $injection) - ->when('retrieving the element', 'recursion') - ->then('the result is an error with the message', - 'Element already loading!'); - } - - /** - * Test retrieving a new element via a factory function. - * - * @scenario - * - * @return NULL - */ - public function retrievingANewElementWithAFactoryFunction() - { - $injection = new Horde_Provider_Injection_Factory('factory'); - - $this->given('a provider') - ->given('a registered element', 'key', $injection) - ->when('retrieving the element', 'key') - ->then('the result is', 'injected'); - } - - /** - * Test retrieving a new element via a factory class method. - * - * @scenario - * - * @return NULL - */ - public function retrievingANewElementWithAFactoryClassMethod() - { - $injection = new Horde_Provider_Injection_Factory(array('Dummy', - 'getValue')); - - $this->given('a provider') - ->given('a registered element', 'key', $injection) - ->when('retrieving the element', 'key') - ->then('the result is', 'constructed'); - } - -} - -/** - * A dummy factory. - * - * Copyright 2009 The Horde Project (http://www.horde.org/) - * - * See the enclosed file COPYING for license information (LGPL). If you - * did not receive this file, see http://www.fsf.org/copyleft/lgpl.html. - * - * @category Horde - * @package Provider - * @subpackage UnitTests - * @author Gunnar Wrobel - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ -class Dummy -{ - /** - * A factory method producing a constant string. - * - * @param Horde_Provider $provider The dependency provider. - * - * @return string Always returns 'constructed' - */ - static public function getValue($provider) - { - return 'constructed'; - } -} - -/** - * A dummy factory used to demonstrate recursion. - * - * Copyright 2009 The Horde Project (http://www.horde.org/) - * - * See the enclosed file COPYING for license information (LGPL). If you - * did not receive this file, see http://www.fsf.org/copyleft/lgpl.html. - * - * @category Horde - * @package Provider - * @subpackage UnitTests - * @author Gunnar Wrobel - * @license http://www.fsf.org/copyleft/lgpl.html LGPL - * @link http://pear.horde.org/index.php?package=Provider - */ -class Recursion -{ - /** - * A factory method that returns the provided 'recursion' element. - * - * @param Horde_Provider $provider The dependency provider. - * - * @return mixed The element 'recursion' from the provider. - */ - static public function getValue($provider) - { - //@todo: Why does $provider->recursion yield no error/result? - //return $provider->recursion; - return $provider->__get('recursion'); - } -} - -/** - * A factory producing a constant string. - * - * @param Horde_Provider $provider The dependency provider. - * - * @return string Always returns 'injected' - */ -function factory($provider) -{ - return 'injected'; -}