PageRenderTime 46ms CodeModel.GetById 23ms RepoModel.GetById 0ms app.codeStats 0ms

/src/DocBlox/Transformer/Behaviour/Interface.php

https://github.com/androa/Docblox
PHP | 45 lines | 6 code | 2 blank | 37 comment | 0 complexity | 0f03d6bea6be3f1f6a1e7216fc23c643 MD5 | raw file
Possible License(s): BSD-3-Clause
  1. <?php
  2. /**
  3. * DocBlox
  4. *
  5. * PHP Version 5
  6. *
  7. * @category DocBlox
  8. * @package Transformation
  9. * @subpackage Behaviour
  10. * @author Mike van Riel <mike.vanriel@naenius.com>
  11. * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
  12. * @license http://www.opensource.org/licenses/mit-license.php MIT
  13. * @link http://docblox-project.org
  14. */
  15. /**
  16. * Collection object for a set of Behaviours.
  17. *
  18. * @category DocBlox
  19. * @package Transformer
  20. * @subpackage Behaviour
  21. * @author Mike van Riel <mike.vanriel@naenius.com>
  22. * @license http://www.opensource.org/licenses/mit-license.php MIT
  23. * @link http://docblox-project.org
  24. */
  25. interface DocBlox_Transformer_Behaviour_Interface
  26. {
  27. /**
  28. * Executes the behaviour on the given dataset,
  29. *
  30. * @param DOMDocument $xml
  31. *
  32. * @return DOMDocument
  33. */
  34. public function process(DOMDocument $xml);
  35. /**
  36. * Sets the logger for this behaviour or removes it when $log is null.
  37. *
  38. * @param DocBlox_Core_Log|null $log
  39. *
  40. * @return void
  41. */
  42. public function setLogger(DocBlox_Core_Log $log = null);
  43. }