Joomla! Documentation - User contributions [en]

Search Engine Friendly URLs

2008-09-05T13:42:28Z

Ddorothy: Joomla Routes and SeF

'''Joomla Routes'''

Joomla routes are created by the JRouter class. This class looks in the component root of the component specified in the "option" portion of the query string and includes the reouter.php file in that component's root directory. It then calls one of two functions: one for creating the SEF link and one for interpreting the SEF link.

The JRouter class is overridden by the Joomla CMS in /includes/router.php. In this file the build and parse functions are overridden to properly build and parse the URLs for the Joomla CMS.

com_component/router.php

The router.php file should contain the following two functions:
* ContentBuildRoute - this builds the SEF url
** Parameters
*** $query - this is a named array containing the querystring variables
** Returns: an array of segments where each segment is separated by a '/' when later combined to create the actual link (the items in the array should not contain '/' characters)
* ContentParseRoute - this interprets an SEF url
** Parameters
*** $segments - this is an array that contains the segments of the url requested.
** Returns: a name => value array of the querystring variables that the link maps to

'''The SEF Plugin'''

The Joomla System SEF plugin inherits JPlugin and overrides the onAfterRender() function. In this function the body of the response that will be sent to the browser is retrieved using JResponse::getBody(). The body of the response is then searched for links containing "/index.php..." and replaces them with a correct SEF url by calling JRoute::_(url).

JRoute builds SEF URLs by instantiating a JRouter object and requesting that it build the correct link from the passed in URL.

'''Handling SEF URLs'''

By default the SEF URLs are handled by the the JRouterSite object (from /includes/router.php) and is called by a call to JApplication::route() in index.php. This call is made on the $mainframe variable which is actually an instance of JSite (from /includes/application.php).

JApplication::route() has a non-destructive result on the $_GET array. By this I mean that JApplication::route() sets variables in $_GET by calling JRequest::set() with the overwrite flag set to false. Thus if a variable name is returned from JRouter::route() that is already in $_GET then it will not put that value into $_GET. This allows for custom routing.

'''Custom Routing'''

Joomla allows you to create your own routing mechanism. In order to create this mechanism you must have a plugin that overrides the JPlugin::onAfterInitialise() function. This function then parses the URL and creates the needed variables in $_GET before the standard Joomla routing is done.

Portal:Developers

2008-09-05T13:42:06Z

Ddorothy: /* Cookie Jar */

{{Developer profile}}

== Participation ==

* [[Participating in the community]]: a brief description of how people can get involved.
* [[Setting up your workstation for Joomla! development]]: a step-by-step guide for installing the Eclipse IDE on your local workstation for Joomla! development
* [[Coding style and standards]] (To be reviewed).
* [[Patch submission guidelines]].
* [[Filing bugs and issues]].
* [[How to release a distribution tarball]].

== Reference Pages ==

Peruse all pages in the [[:Category:Development]] category.

When creating a new page, ensure you place the following marker at the top of the page so it is included in the category list:

<pre><nowiki>[[Category:Development]]
</nowiki></pre>

If you locate other articles you thing that are relevant to developer, please add this marker to those pages.

== Articles and Tutorials on developer.joomla.org ==

[http://community.joomla.org/magazine/article/508-developer-localization-advancements-in-joomla-15.html Localization Advancements in Joomla! 1.5]

[http://developer.joomla.org/tutorials/165-understanding-output-overrides-in-joomla.html Understanding Output Overrides in Joomla! 1.5]

[http://developer.joomla.org/tutorials/181-preventing-sql-injections.html Preventing SQL Injections]

[http://developer.joomla.org/tutorials/184-how-to-create-a-joomla-plugin.html How to create a Joomla! Plugin]

[http://docs.joomla.org/Developing_a_Model-View-Controller_Component_-_Part_1 Developing a Model-View-Controller Component - Part 1]

[http://docs.joomla.org/Developing_a_Model-View-Controller_Component_-_Part_2_-_Adding_a_Model Developing a Model-View-Controller Component - Part 2 - Adding a Model]

[http://docs.joomla.org/Developing_a_Model-View-Controller_Component_-_Part_3_-_Using_the_Database Developing a Model-View-Controller Component - Part 3 - Using the Database]

[http://docs.joomla.org/Developing_a_Model-View-Controller_Component_-_Part_4_-_Creating_an_Administrator_Interface Developing a Model-View-Controller Component - Part 4 - Creating an Administrator Interface]

== Cookie Jar ==

Articles that need to be written.

* Developer guidelines.
* Secure coding guidelines.
* Error message conventions.
* Exception handling.
* Release numbering, compatibility and deprecation.
* Complete/update/review the wiki API reference (assumes this has been moved from DocuWiki to MediaWiki).
* Update developer tutorials and how-to's currently on dev.joomla.org
** Review all material under the tutorials heading at http://dev.joomla.org/component/option,com_jd-wiki/Itemid,32/
** Recommend material to be migrated over to docs.joomla.org
** Update material that is to be migrated over to docs.joomla.org
* [[Adding AJAX to your component]].
** Write a document describing how to add AJAX to an MVC component. If desired, use the MVC Hello World tutorial as a base. Describe where various elements should go in the MVC design pattern. Also describe how to implement MVC in a module (these need supporting components to do AJAX).
* [[Creating a toolbar for your component]].
* [[Adding configuration objects to modules and plugins]].
* [[Storing data in the session between page loads]].
* [[Using the caching system in your component]].
* [[Creating a file uploader in your component]].
* [[Suppressing output of extra HTML]].
* [[Adding view layout configuration parameters]].
** Explain how to create an XML file that will allow users to configure views.
* [[How to implement XML-RPC in a component]]
** There are two ways to do this:
*** Implement it using an XML-RPC plugin
*** Implement it in the component itself using raw views
* [[How to use the filesystem package]]
* [[How to use the filter package]]
** Describe how and when to use the Filter package and explain what needs to be filtered for various situations (for queries, for URLs, etc)
* [[How to use the registry package]]
* [[How to use JSimpleXML]]
** How to load and store XML files and how to work with them
* [[How to add breadcrumbs]]
* [[How to create component feeds]] (RSS/ATOM)
* [[How to create PDF views]]
* [[How to send email from components]]
* [[What's available in the JFactory class]]
* [[How to generate paths for client side and server side]]
* How to access information from the request/browser
** This focuses on using the JBrowser class to retrieve information about the features available in the user's browser.
* [[How to create an editor plugin]]
* [[What can be done with a user plugin]]
* [[How to work with parameters]]
* [[How to use the JToolBar class in the frontend]]
* [[How to use the editor in a component]]
* [[How to cloak email addresses]]
* [[Joomla Routes and SEF]]

[[Category:Development]]

Joomla Routes & SEF

2008-09-05T13:40:03Z

Ddorothy: Joomla Routes & SEF

Portal:Developers

2008-09-05T13:35:20Z

Ddorothy: /* Cookie Jar */