/library/Zend/Search/Lucene/Search/Highlighter/Interface.php

https://bitbucket.org/hamidrezas/melobit · PHP · 53 lines · 7 code · 4 blank · 42 comment · 0 complexity · 6c3f9b2ffa81f3d25de932d5b387046d MD5 · raw file

  1. <?php
  2. /**
  3. * Zend Framework
  4. *
  5. * LICENSE
  6. *
  7. * This source file is subject to the new BSD license that is bundled
  8. * with this package in the file LICENSE.txt.
  9. * It is also available through the world-wide-web at this URL:
  10. * http://framework.zend.com/license/new-bsd
  11. * If you did not receive a copy of the license and are unable to
  12. * obtain it through the world-wide-web, please send an email
  13. * to license@zend.com so we can send you a copy immediately.
  14. *
  15. * @category Zend
  16. * @package Zend_Search_Lucene
  17. * @subpackage Search
  18. * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
  19. * @license http://framework.zend.com/license/new-bsd New BSD License
  20. * @version $Id: Interface.php 24594 2012-01-05 21:27:01Z matthew $
  21. */
  22. /**
  23. * @category Zend
  24. * @package Zend_Search_Lucene
  25. * @subpackage Search
  26. * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
  27. * @license http://framework.zend.com/license/new-bsd New BSD License
  28. */
  29. interface Zend_Search_Lucene_Search_Highlighter_Interface
  30. {
  31. /**
  32. * Set document for highlighting.
  33. *
  34. * @param Zend_Search_Lucene_Document_Html $document
  35. */
  36. public function setDocument(Zend_Search_Lucene_Document_Html $document);
  37. /**
  38. * Get document for highlighting.
  39. *
  40. * @return Zend_Search_Lucene_Document_Html $document
  41. */
  42. public function getDocument();
  43. /**
  44. * Highlight specified words (method is invoked once per subquery)
  45. *
  46. * @param string|array $words Words to highlight. They could be organized using the array or string.
  47. */
  48. public function highlight($words);
  49. }