Référence de la classe Route

Fonctions membres publiques statiques
static	_ ($url, $xhtml=true, $tls=self::TLS_IGNORE, $absolute=false)
static	link ($client, $url, $xhtml=true, $tls=self::TLS_IGNORE, $absolute=false)

Champs de données
const	TLS_IGNORE = 0
const	TLS_FORCE = 1
const	TLS_DISABLE = 2

Attributs privés statiques
static	$_router = array()

Description détaillée

Route handling class

Depuis

1.7.0

Documentation des fonctions membres

_()

static _ (   $url,   $xhtml = true,   $tls = self::TLS_IGNORE,   $absolute = false  )

static

Translates an internal Joomla URL to a humanly readable URL. This method builds links for the current active client.

Paramètres

string	$url	Absolute or Relative URI to Joomla resource.
boolean	$xhtml	Replace & by & for XML compliance.
integer	$tls	Secure state for the resolved URI. Use Route::TLS_* constants 0: (default) No change, use the protocol currently used in the request 1: Make URI secure using global secure site URI. 2: Make URI unsecure using the global unsecure site URI.
boolean	$absolute	Return an absolute URL

Renvoie

string The translated humanly readable URL.

Depuis

1.7.0

Références $app, $client, $url, Factory\getApplication(), et null.

Référencé par OpensearchDocument\__construct(), Pagination\_buildDataObject(), HtmlView\_prepareDocument(), ModuleController\add(), ArticleController\add(), FormController\add(), CategoryView\addFeed(), DisplayController\addModule(), Users\addNote(), Shortcut\addShortcuts(), HtmlView\addToolbar(), LevelController\allowEdit(), AdministratorService\association(), Menus\association(), SiteApplication\authorise(), BannerController\batch(), NewsfeedController\batch(), UserController\batch(), ModuleController\batch(), ApplicationController\cancel(), TemplateController\cancel(), AssociationController\cancel(), ConfigController\cancel(), ItemController\cancel(), OverrideController\cancel(), ComponentController\cancel(), ProfileController\cancel(), FormController\cancel(), ContactController\cancel(), AssociationsController\checkin(), AdminController\checkin(), Session\checkToken(), CMSApplication\checkUserRequireReset(), AssociationsController\clean(), TemplateController\close(), Icon\create(), TemplateController\createFile(), OverridesController\delete(), AdminController\delete(), UpdatesitesController\delete(), MethodController\delete(), TemplateController\delete(), OpensearchView\display(), FeedView\display(), CategoryFeedView\display(), MenuController\display(), DisplayController\display(), XmlView\display(), HtmlView\display(), ProfileController\edit(), OverrideController\edit(), AssociationController\edit(), TemplateController\edit(), Icon\edit(), Dropdown\edit(), ArticleController\edit(), FormController\edit(), MethodController\execute(), MethodsController\execute(), CaptiveController\execute(), MenuController\exportXml(), Users\filterNotes(), ConsentBoxField\getAssignedArticleUrl(), ConsentBoxField\getAssignedMenuItemUrl(), AssociationsHelper\getAssociationHtmlList(), QuickIconHelper\getButtons(), HtmlView\getFields(), FinderHelper\getGetFields(), PlugininfoField\getInput(), MenutypeField\getInput(), ModuleModel\getItem(), TosField\getLabel(), ArticlesPopularHelper\getList(), LatestHelper\getList(), ArticlesArchiveHelper\getList(), LanguagesHelper\getList(), PopularHelper\getList(), LoggedHelper\getList(), ArticlesCategoryHelper\getList(), StatsAdminHelper\getStats(), InstallModel\install(), HistoryController\keep(), UserController\login(), UserController\logout(), Users\notesModal(), PluginController\oauthcallback(), KeepaliveAssetItem\onAttachCallback(), TemplateController\overrides(), ArticleController\postSaveHook(), ContactController\postSaveHook(), HtmlView\prepareDocument(), PluginModel\preprocessForm(), RemindModel\processRemindRequest(), ResetModel\processResetRequest(), TemplateController\publish(), ItemsController\publish(), AdminController\publish(), AssociationsController\purge(), ActionlogsController\purge(), UpdatesitesController\rebuild(), UpdatesitesModel\rebuild(), FeedView\reconcileNames(), AdminModel\redirectToAssociations(), RssRenderer\render(), AtomRenderer\render(), AdminController\reorder(), AdminController\runTransition(), ConfigController\save(), TemplatesController\save(), OverrideController\save(), ArticleController\save(), FormController\save(), AdminController\saveorder(), MailController\send(), WorkflowsController\setDefault(), ItemsController\setDefault(), StagesController\setDefault(), ItemController\setType(), ContactController\submit(), TemplateController\uploadFile(), et ArticleController\vote().

link()

static link (   $client,   $url,   $xhtml = true,   $tls = self::TLS_IGNORE,   $absolute = false  )

static

Translates an internal Joomla URL to a humanly readable URL. NOTE: To build link for active client instead of a specific client, you can use Route::_()

Paramètres

string	$client	The client name for which to build the link.
string	$url	Absolute or Relative URI to Joomla resource.
boolean	$xhtml	Replace & by & for XML compliance.
integer	$tls	Secure state for the resolved URI. Use Route::TLS_* constants 0: (default) No change, use the protocol currently used in the request 1: Make URI secure using global secure site URI. 2: Make URI unsecure using the global unsecure site URI.
boolean	$absolute	Return an absolute URL

Renvoie

string The translated humanly readable URL.

Exceptions

Références $client, $uri, $url, elseif, ENT_COMPAT, Factory\getApplication(), Factory\getContainer(), Uri\getInstance(), et Text\sprintf().

Référencé par RegistrationModel\activate(), HtmlView\addToolbar(), ContentSerializer\category(), ContactSerializer\category(), NewsfeedSerializer\category(), MailHelper\convertRelativeToAbsoluteUrls(), ContentSerializer\createdBy(), NewsfeedSerializer\createdBy(), ContactSerializer\createdBy(), ActionlogsHelper\getHumanReadableLogMessage(), PrivacyStatusHelper\getRequestFormPublished(), ContentSerializer\languageAssociations(), NewsfeedSerializer\languageAssociations(), ContactSerializer\languageAssociations(), ContentSerializer\modifiedBy(), NewsfeedSerializer\modifiedBy(), ContactSerializer\modifiedBy(), RegistrationModel\register(), MessageModel\save(), et ContactSerializer\userId().

Documentation des champs

$_router

$_router = array()

staticprivate

TLS_DISABLE

const TLS_DISABLE = 2

Make URI unsecure using plain http (http).

Depuis

3.9.7

TLS_FORCE

const TLS_FORCE = 1

Make URI secure using http over TLS (https).

Depuis

3.9.7

Référencé par RegistrationModel\activate(), FeedView\display(), ActionlogsHelper\getHumanReadableLogMessage(), PrivacyStatusHelper\getRequestFormPublished(), FeedView\reconcileNames(), RegistrationModel\register(), et MessageModel\save().

TLS_IGNORE

const TLS_IGNORE = 0

No change, use the protocol currently used.

Depuis

3.9.7

Référencé par RegistrationModel\activate(), MailHelper\convertRelativeToAbsoluteUrls(), FeedView\display(), ActionlogsHelper\getHumanReadableLogMessage(), PrivacyStatusHelper\getRequestFormPublished(), FeedView\reconcileNames(), RegistrationModel\register(), et MessageModel\save().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• src/Router/Route.php