SproutCMS

This is the code documentation for the SproutCMS project

source of /sprout/Helpers/RteLibrary.php

  1. <?php
  2. /*
  3.  * Copyright (C) 2017 Karmabunny Pty Ltd.
  4.  *
  5.  * This file is a part of SproutCMS.
  6.  *
  7.  * SproutCMS is free software: you can redistribute it and/or modify it under the terms
  8.  * of the GNU General Public License as published by the Free Software Foundation, either
  9.  * version 2 of the License, or (at your option) any later version.
  10.  *
  11.  * For more information, visit <http://getsproutcms.com>.
  12.  */
  13.  
  14. namespace Sprout\Helpers;
  15.  
  16.  
  17. abstract class RteLibrary {
  18. protected $name;
  19.  
  20.  
  21. /**
  22.   * Return the name of this library
  23.   **/
  24. public final function getName() {
  25. return $this->name;
  26. }
  27.  
  28.  
  29. /**
  30.   * Do a library browse
  31.   *
  32.   * @return array of RteLibContainer and RteLibObject objects
  33.   **/
  34. public abstract function browse($path);
  35.  
  36.  
  37. /**
  38.   * Do a library search
  39.   *
  40.   * @return array of RteLibContainer and RteLibObject objects
  41.   **/
  42. public abstract function search($term);
  43.  
  44. }
  45.