API15

JRouter/build: Difference between revisions

From Joomla! Documentation

Doxiki (talk | contribs)
New page: ===Description=== Function to convert an internal URI to a route <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<nowi...
 
Doxiki (talk | contribs)
No edit summary
Line 9: Line 9:


===Syntax===
===Syntax===
<source lang="php">build($url)</source>
<source lang="php">& build($url)</source>


  {| class="wikitable"
  {| class="wikitable"
Line 32: Line 32:
===Source Body===
===Source Body===
<source lang="php">
<source lang="php">
function build($url)
function &build($url)
{
{
         //Create the URI object
         //Create the URI object
         $uri = &$this->_createURI($url);
         $uri =& $this->_createURI($url);


         //Process the uri information based on custom defined rules
         //Process the uri information based on custom defined rules
Line 41: Line 41:


         // Build RAW URL
         // Build RAW URL
         if ($this->_mode == JROUTER_MODE_RAW) {
         if($this->_mode == JROUTER_MODE_RAW) {
                 $this->_buildRawRoute($uri);
                 $this->_buildRawRoute($uri);
         }
         }

Revision as of 22:11, 22 March 2010

Description

Function to convert an internal URI to a route

[Edit Descripton]

Template:Description:JRouter/build

Syntax

& build($url)
Parameter Name Default Value Description
$url $string The internal URL

Returns

string The absolute search engine friendly URL

Defined in

libraries/joomla/application/router.php

Importing

jimport( 'joomla.application.router' );

Source Body

function &build($url)
{
        //Create the URI object
        $uri =& $this->_createURI($url);

        //Process the uri information based on custom defined rules
        $this->_processBuildRules($uri);

        // Build RAW URL
        if($this->_mode == JROUTER_MODE_RAW) {
                $this->_buildRawRoute($uri);
        }

        // Build SEF URL : mysite/route/index.php?var=x
        if ($this->_mode == JROUTER_MODE_SEF) {
                $this->_buildSefRoute($uri);
        }

        return $uri;
}

[Edit See Also] Template:SeeAlso:JRouter/build

Examples

<CodeExamplesForm />