Source for file jISelector.iface.php

Documentation is available at jISelector.iface.php

  1. <?php
  2. /**
  3. * a selector is a string refering to a file or a ressource, by indicating its module and its name.
  4. * For example : "moduleName~resourceName". There are several type of selector, depending on the
  5. * resource type. Selector objects get the real path of the corresponding file, the name of the
  6. * compiler (if the file has to be compile) etc.
  7. * So here, there is a selector class for each selector type.
  8. * @package     jelix
  9. * @subpackage  core_selector
  10. * @author      Laurent Jouanneau
  11. * @contributor Christophe Thiriot
  12. * @copyright   2005-2008 Laurent Jouanneau, 2008 Christophe Thiriot
  13. * @link        http://www.jelix.org
  14. * @licence    GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html
  15. */
  16.  
  17.  
  18. /**
  19.  * interface of selector classes
  20.  * @package    jelix
  21.  * @subpackage core_selector
  22.  */
  23. interface jISelector {
  24.     /**
  25.      * @return string file path corresponding to the resource pointing by the selector
  26.      */
  27.     public function getPath ();
  28.     /**
  29.      * @return string file path of the compiled file (if the main file should be compiled by jelix)
  30.      */
  31.     public function getCompiledFilePath ();
  32.     /**
  33.      * @return jICompiler the compiler used to compile file
  34.      */
  35.     public function getCompiler();
  36.     /**
  37.      * @return boolean true if the compiler compile many file at one time
  38.      */
  39.     public function useMultiSourceCompiler();
  40.     /**
  41.      * @param boolean $full true if you want a full selector ("type:...")
  42.      * @return string the selector
  43.      */
  44.     public function toString($full=false);
  45. }

Documentation generated on Wed, 24 Sep 2014 22:00:49 +0200 by phpDocumentor 1.4.3