[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Component/Router/ -> RouterView.php (summary)

Joomla! Content Management System

Copyright: (C) 2015 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 277 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 11 functions

  registerView()
  getViews()
  getPath()
  getRules()
  attachRules()
  attachRule()
  detachRule()
  preprocess()
  build()
  parse()
  getName()

Functions
Functions that are not part of a class:

registerView(RouterViewConfiguration $view)   X-Ref
Register the views of a component

param: RouterViewConfiguration  $view  View configuration object
return: void

getViews()   X-Ref
Return an array of registered view objects

return: RouterViewConfiguration[] Array of registered view objects

getPath($query)   X-Ref
Get the path of views from target view to root view
including content items of a nestable view

param: array  $query  Array of query elements
return: array List of views including IDs of content items

getRules()   X-Ref
Get all currently attached rules

return: RulesInterface[]  All currently attached rules in an array

attachRules($rules)   X-Ref
Add a number of router rules to the object

param: RulesInterface[]  $rules  Array of JComponentRouterRulesInterface objects
return: void

attachRule(RulesInterface $rule)   X-Ref
Attach a build rule

param: RulesInterface  $rule  The function to be called.
return: void

detachRule(RulesInterface $rule)   X-Ref
Remove a build rule

param: RulesInterface  $rule  The rule to be removed.
return: boolean  Was a rule removed?

preprocess($query)   X-Ref
Generic method to preprocess a URL

param: array  $query  An associative array of URL arguments
return: array  The URL arguments to use to assemble the subsequent URL.

build(&$query)   X-Ref
Build method for URLs

param: array  &$query  Array of query elements
return: array  Array of URL segments

parse(&$segments)   X-Ref
Parse method for URLs

param: array  &$segments  Array of URL string-segments
return: array  Associative array of query values

getName()   X-Ref
Method to return the name of the router

return: string  Name of the router



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer