Joomla! Documentation - User contributions [en]

API16:JRoute/

2012-07-25T17:34:55Z

Whycali: /* Examples */

===Description===
Translates an internal Joomla URL to a humanly readible URL.


<nowiki>[</nowiki>[[Description:JRoute/_|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JRoute/_}}

===Syntax===
<source lang="php">static _($url, $xhtml=true, $ssl=null)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $url
|
| $url Absolute or Relative URI to resource.
|-
| $xhtml
| true
| $xhtml Replace & by &amp; for xml compilance.
|-
| $ssl
| null
| $ssl Secure state for the resolved URI. 1: Make URI secure using global secure site URI. 0: Leave URI in the same secure state as it was passed to the function. -1: Make URI unsecure using the global unsecure site URI.
|}

===Returns===
The translated humanly readible URL.

===Defined in===
libraries/joomla/methods.php
===Importing===
<source lang="php">jimport( 'joomla.methods' );</source>

===Source Body===
<source lang="php">
public static function _($url, $xhtml = true, $ssl = null)
{
// Get the router.
$app = &JFactory::getApplication();
$router = &$app->getRouter();

// Make sure that we have our router
if (!$router) {
return null;
}

if ((strpos($url, '&') !== 0) && (strpos($url, 'index.php') !== 0)) {
return $url;
}

// Build route.
$uri = &$router->build($url);
$url = $uri->toString(array('path', 'query', 'fragment'));

// Replace spaces.
$url = preg_replace('/\s/u', '%20', $url);

/*
* Get the secure/unsecure URLs.
*
* If the first 5 characters of the BASE are 'https', then we are on an ssl connection over
* https and need to set our secure URL to the current request URL, if not, and the scheme is
* 'http', then we need to do a quick string manipulation to switch schemes.
*/
if ((int) $ssl)
{
$uri = &JURI::getInstance();

// Get additional parts.
static $prefix;
if (!$prefix)
{
$prefix = $uri->toString(array('host', 'port'));
}

// Determine which scheme we want.
$scheme = ($ssl === 1) ? 'https' : 'http';

// Make sure our URL path begins with a slash.
if (!preg_match('#^/#', $url)) {
$url = '/'.$url;
}

// Build the URL.
$url = $scheme.'://'.$prefix.$url;
}

if ($xhtml) {
$url = str_replace('&', '&', $url);
}

return $url;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JRoute/_|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JRoute/_}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=_
category=JRoute
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>
<source lang="php"><?php
// displays the SEF URL to view article ID# 86
// 'Search Engine Friendly URLs' must be enabled in the Global config for this to have any effect
echo JRoute::_('index.php?option=com_content&view=article&id=86');
?></source>

API16:JRoute/

2012-07-25T17:31:04Z

Whycali: /* Examples */

===Description===
Translates an internal Joomla URL to a humanly readible URL.


<nowiki>[</nowiki>[[Description:JRoute/_|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JRoute/_}}

===Syntax===
<source lang="php">static _($url, $xhtml=true, $ssl=null)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $url
|
| $url Absolute or Relative URI to resource.
|-
| $xhtml
| true
| $xhtml Replace & by &amp; for xml compilance.
|-
| $ssl
| null
| $ssl Secure state for the resolved URI. 1: Make URI secure using global secure site URI. 0: Leave URI in the same secure state as it was passed to the function. -1: Make URI unsecure using the global unsecure site URI.
|}

===Returns===
The translated humanly readible URL.

===Defined in===
libraries/joomla/methods.php
===Importing===
<source lang="php">jimport( 'joomla.methods' );</source>

===Source Body===
<source lang="php">
public static function _($url, $xhtml = true, $ssl = null)
{
// Get the router.
$app = &JFactory::getApplication();
$router = &$app->getRouter();

// Make sure that we have our router
if (!$router) {
return null;
}

if ((strpos($url, '&') !== 0) && (strpos($url, 'index.php') !== 0)) {
return $url;
}

// Build route.
$uri = &$router->build($url);
$url = $uri->toString(array('path', 'query', 'fragment'));

// Replace spaces.
$url = preg_replace('/\s/u', '%20', $url);

/*
* Get the secure/unsecure URLs.
*
* If the first 5 characters of the BASE are 'https', then we are on an ssl connection over
* https and need to set our secure URL to the current request URL, if not, and the scheme is
* 'http', then we need to do a quick string manipulation to switch schemes.
*/
if ((int) $ssl)
{
$uri = &JURI::getInstance();

// Get additional parts.
static $prefix;
if (!$prefix)
{
$prefix = $uri->toString(array('host', 'port'));
}

// Determine which scheme we want.
$scheme = ($ssl === 1) ? 'https' : 'http';

// Make sure our URL path begins with a slash.
if (!preg_match('#^/#', $url)) {
$url = '/'.$url;
}

// Build the URL.
$url = $scheme.'://'.$prefix.$url;
}

if ($xhtml) {
$url = str_replace('&', '&', $url);
}

return $url;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JRoute/_|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JRoute/_}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=_
category=JRoute
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>
<source lang="php"><?php echo JRoute::_('index.php?option=com_content&view=article&id=86'); ?></source>

API16:JRoute

2012-07-25T17:30:39Z

Whycali: /* Examples */

<nowiki>[</nowiki>[[Description:JRoute|Edit Descripton]]<nowiki>]</nowiki>

{{Description:JRoute}}

===Defined in===
libraries/joomla/methods.php
===Methods===
{| class="wikitable sortable"
|-
!Method name
!Description
|-
|[[API16:JRoute/_|_]]
|Translates an internal Joomla URL to a humanly readible URL.
|}

===Importing===
<source lang="php">jimport( 'joomla.methods' );</source>


<nowiki>[</nowiki>[[SeeAlso:JRoute|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JRoute}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JRoute
category=CodeExample
category=ClassExample
include=*
format= ,,,
</dpl>

API16:JRoute

2012-07-25T17:28:27Z

Whycali: /* Examples */

API16:JRoute

2012-07-25T17:27:22Z

Whycali: /* Examples */

Archived talk:Developing a MVC Component/Adding backend actions

2011-03-15T19:46:22Z

Whycali:

It's not clear to me where the word "helloworld" refers to in these examples. Can you please clarify when 'helloworld' refers to the component,controller,model,table,view or form? While following this, I've changed the name of my component, and when running this I get a 'call to member function getTable() on non-object'. It seems that I used the wrong name somewhere, but I have no idea where.

We're also introducing JForms and JFields. These are powerful and important, and warrant some richer explanation.

Archived talk:Developing a MVC Component/Adding backend actions

2011-03-15T19:45:05Z

Whycali: New page: It's not clear to me where the word "helloworld" refers to in these examples. Can you please clarify when 'helloworld' refers to the component,controller,model,table,view or form? While ...