Documentation


SEARCH

TABLE OF CONTENT

    1. Getting started 2. Basic concepts 3. Request dispatching 4. Context container 5. Dual MVC 6. Component model: 7. Security 8. Configuration 9. Session handling 10. I18n 11. Cache 12. Logging 13. Error handling 14. Advanced Topics 15. API reference

      Tutorials: Frequently Asqued Questions

      See also:


      Class: __UriComponent


      Class Overview

      The Uri Component is a component designed to render a url according to a route definition.


      Uri tag is uri

      i.e.

      1.    <comp:uri route "search"
      2.         controller "invoices"
      3.         parameters "invoice_id=4301"/>

      This example will generate a url according to the given route (i.e. search route: http://yourdomain.com/invoices/4301.html)

      Uri component allow to specify the following attributes:

      • route: The route id to use to generate the url
      • controller: The controller code to use to generate the url
      • action: The action code to use to generate the url
      • parameters: A comma-separate list of parameters to generate the url

      As a result, the Uri component generates a url.


      __UIComponent
         |
         --__UriComponent

      Methods

      [ Top ]

      Inherited Properties, Constants, and Methods

      Inherited Properties Inherited Methods Inherited Constants

      Inherited From __UIComponent

      Inherited From __UIComponent


      [ Top ]

      Method Summary

      string   getAction()   Get the action code set to the current component
      string   getController()   Get the controller code set to the current component
      string   getParameters()   Get the comma-separate list of parametes set to the current component
      string   getRoute()   Get the route id set to the current component
      string   getUrl()   Get the url generated by the current component
      void   getUseCurrentRoute()  
      void   setAction()   Set the action code to use to generate the url
      void   setController()   Set the controller code to use to generate the url
      void   setParameters()   Set a comma-separate list of parameters to use to generate the url
      void   setRoute()   Set the route id to use to generate the url
      string   setUrl()   Set a url represented by the current component.
      void   setUseCurrentRoute()  
      void   useCurrentRoute()  

      [ Top ]

      Properties

      Methods

      getAction


        string getAction( )

      Get the action code set to the current component

      Access:  public



      getController


        string getController( )

      Get the controller code set to the current component

      Access:  public



      getParameters


        string getParameters( )

      Get the comma-separate list of parametes set to the current component

      Access:  public



      getRoute


        string getRoute( )

      Get the route id set to the current component

      Access:  public



      getUrl


        string getUrl( )

      Get the url generated by the current component

      Access:  public



      getUseCurrentRoute


        void getUseCurrentRoute( )

      Access:  public



      setAction


        void setAction( string $action_code  )

      Set the action code to use to generate the url


      Parameters:
      TypeNameDescription
      string $action_code

      Access:  public



      setController


        void setController( string $controller_code  )

      Set the controller code to use to generate the url


      Parameters:
      TypeNameDescription
      string $controller_code

      Access:  public



      setParameters


        void setParameters( string $parameters  )

      Set a comma-separate list of parameters to use to generate the url


      Parameters:
      TypeNameDescription
      string $parameters

      Access:  public



      setRoute


        void setRoute( string $route_id  )

      Set the route id to use to generate the url


      Parameters:
      TypeNameDescription
      string $route_id

      Access:  public



      setUrl


        string setUrl( $url  )

      Set a url represented by the current component.

      This property is for internal usage only, to set the resultant url.



      Parameters:
      TypeNameDescription
      $url

      Access:  public



      setUseCurrentRoute


        void setUseCurrentRoute( $use_current_route  )


      Parameters:
      TypeNameDescription
      $use_current_route

      Access:  public



      useCurrentRoute


        void useCurrentRoute( )

      Access:  public