[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Categories/ -> Categories.php (summary)

Joomla! Content Management System

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

Defines 1 class

Categories:: (5 methods):
  __construct()
  getInstance()
  get()
  getExtension()
  _load()


Class: Categories  - X-Ref

Categories Class.

__construct($options)   X-Ref
Class constructor

param: array  $options  Array of options

getInstance($extension, $options = array()   X-Ref
Returns a reference to a Categories object

param: string  $extension  Name of the categories extension
param: array   $options    An array of options
return: Categories|boolean  Categories object on success, boolean false if an object does not exist

get($id = 'root', $forceload = false)   X-Ref
Loads a specific category and all its children in a CategoryNode object.

param: mixed    $id         an optional id integer or equal to 'root'
param: boolean  $forceload  True to force  the _load method to execute
return: CategoryNode|null  CategoryNode object or null if $id is not valid

getExtension()   X-Ref
Returns the extension of the category.

return: string  The extension

_load($id)   X-Ref
Load method

param: integer  $id  Id of category to load
return: void



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