gyro/core/lib/interfaces/iroute.cls.php

Go to the documentation of this file.
00001 <?php
00002 /**
00003  * A route checks if a given url can be processed and invokes the according functions
00004  * 
00005  * @author Gerd Riesselmann
00006  * @ingroup Interfaces
00007  */ 
00008 interface IRoute {
00009         const WEIGHT_NO_MATCH = 10000;
00010         const WEIGHT_FULL_MATCH = 0;
00011         
00012         /**
00013          * Returns a suitable renderer 
00014          *
00015          * @param PageDate $page_data The page data
00016          * @return IRenderer
00017          */
00018         public function get_renderer($page_data);
00019         
00020         /**
00021          * Initialize the data passed
00022          */
00023         public function initialize($data);
00024         
00025         /**
00026          * Weight this token against path
00027          */
00028         public function weight_against_path($path);
00029         
00030         /**
00031          * Return a string that identifies this Route - e.g for debug purposes
00032          */
00033         public function identify();
00034         
00035         /**
00036          * Returns true, if this route is a directory (that is: ends with '/')
00037          */
00038         public function is_directory();
00039 }