Source for file jIUrlEngine.iface.php

Documentation is available at jIUrlEngine.iface.php

  1. <?php
  2. /**
  3. * @package     jelix
  4. * @subpackage  core_url
  5. * @author      Laurent Jouanneau
  6. * @copyright   2005-2008 Laurent Jouanneau
  7. *  Some parts of this file are took from an experimental branch of the Copix project (CopixUrl.class.php, Copix 2.3dev20050901, http://www.copix.org),
  8. *  Some lines of code are still copyrighted 2001-2005 CopixTeam (LGPL licence).
  9. *  Initial authors of this parts are Gerald Croes and Laurent Jouanneau,
  10. *  and this parts were adapted for Jelix by Laurent Jouanneau
  11. * @link        http://www.jelix.org
  12. * @licence     GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html
  13. */
  14.  
  15. /**
  16.  * interface for url engines
  17.  * @package  jelix
  18.  * @subpackage core_url
  19.  * @author      Laurent Jouanneau
  20.  * @copyright   2005 CopixTeam, 2005-2006 Laurent Jouanneau
  21.  */
  22. interface jIUrlEngine {
  23.     /**
  24.     * Parse some url components
  25.     * @param string $scriptNamePath    /path/index.php
  26.     * @param string $pathinfo          the path info part of the url (part between script name and query)
  27.     * @param array  $params            url parameters (query part e.g. $_REQUEST)
  28.     * @return jUrlAction 
  29.     */
  30.     public function parse($scriptNamePath, $pathinfo, $params );
  31.  
  32.     /**
  33.      * Parse a url from the request
  34.      * @param jRequest $request 
  35.      * @param array  $params            url parameters
  36.      * @return jUrlAction 
  37.      * @since 1.1
  38.      */
  39.     public function parseFromRequest($request, $params );
  40.  
  41.     /**
  42.     * Create a jurl object with the given action data
  43.     * @param jUrlAction $url  information about the action
  44.     * @return jUrl the url correspondant to the action
  45.     */
  46.     public function create($urlact);
  47.  
  48. }

Documentation generated on Wed, 04 Jan 2017 22:55:39 +0100 by phpDocumentor 1.4.3