Phly Documentation Phly
[ return to channel ] [ class tree: Phly ] [ index: Phly ] [ all elements ]

Source for file Interface.php

Documentation is available at Interface.php

  1. <?php
  2. /**
  3. * PHLY - PHp LibrarY
  4. *
  5. * PHLY is a library of PHP classes designed with the following intentions:
  6. * - Loosely coupled; dependencies should be few, and no base class should be
  7. * necessary.
  8. * - Extendible; all classes should be easily extendible. This may be via
  9. * observers, interfaces, adapters, etc.. The base class should solve 80% of
  10. * usage, and allow extensions to the class to fill in the remainder.
  11. * - Designed for PHP5 and up; all classes should make use of PHP5's features.
  12. * - Documented; all classes should minimally have excellent API-level
  13. * documentation, with use cases in the class docblock.
  14. * - Tested; all classes should have (passing) unit tests accompanying them.
  15. * - Open source and commercial friendly; all classes should use a
  16. * commercial-friendly open source license. The BSD license is one such
  17. * example.
  18. *
  19. * @license New BSD, http://www.opensource.org/licenses/bsd-license.php
  20. * @package Phly
  21. * @copyright 2006 - Present, Matthew Weier O'Phinney
  22. */
  23.  
  24. /**
  25. * Phly_Config_Adapter Interface
  26. *
  27. * Storage adapters should utilize this interface. Naming convention is file
  28. * extension:
  29. *
  30. * - Phly/Config/Adapter/Php.php
  31. * - Phly/Config/Adapter/Ini.php
  32. * - Phly/Config/Adapter/Xml.php
  33. *
  34. * @category Phly
  35. * @subcategory Phly_Config
  36. * @subpackage Phly_Config
  37. * @copyright 2006 - Present, Matthew Weier O'Phinney
  38. * @author Matthew Weier O'Phinney <mweierophinney@gmail.com>
  39. * @version @release-version@
  40. */
  41. interface Phly_Config_Adapter_Interface
  42. {
  43. /**
  44. * Load a configuration array from $source. Should return an array.
  45. *
  46. * @static
  47. * @access public
  48. * @param mixed $source
  49. * @return array
  50. */
  51. public static function load($source);
  52. }