search_processor.class.php 749 B

1234567891011121314151617181920212223242526272829303132
  1. <?php
  2. /* For licensing terms, see /license.txt */
  3. /**
  4. * @package chamilo.include.search
  5. */
  6. /**
  7. * Base class to make tool processors.
  8. *
  9. * This processor have to prepare the raw data from the search engine api to
  10. * make it usable by search. See some implementations of these classes if you
  11. * want to make one.
  12. *
  13. * Classes that extends this one should be named like: TOOL_<toolname> on
  14. * TOOL_<toolname>.class.php
  15. * See lp_list_search for an example of calling the process.
  16. *
  17. * @package chamilo.include.search
  18. */
  19. abstract class search_processor
  20. {
  21. /**
  22. * Search engine api results.
  23. */
  24. protected $rows = [];
  25. /**
  26. * Process the data sorted by the constructor.
  27. */
  28. abstract protected function process();
  29. }