[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Helper/ -> UserGroupsHelper.php (summary)

Joomla! Content Management System

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

Defines 13 functions

  __construct()
  count()
  getInstance()
  get()
  getAll()
  has()
  isSingleton()
  total()
  load()
  loadAll()
  populateGroupsData()
  populateGroupData()
  setGroups()

Functions
Functions that are not part of a class:

__construct(array $groups = array()   X-Ref
Constructor

param: array    $groups  Array of groups
param: integer  $mode    Working mode for this class

count()   X-Ref
Count loaded user groups.

return: integer

getInstance()   X-Ref
Get the helper instance.

return: self

get($id)   X-Ref
Get a user group by its id.

param: integer  $id  Group identifier
return: mixed  stdClass on success. False otherwise

getAll()   X-Ref
Get the list of existing user groups.

return: array

has($id)   X-Ref
Check if a group is in the list.

param: integer  $id  Group identifier
return: boolean

isSingleton()   X-Ref
Check if this instance is a singleton.

return: boolean

total()   X-Ref
Get total available user groups in database.

return: integer

load($id)   X-Ref
Load a group from database.

param: integer  $id  Group identifier
return: mixed

loadAll()   X-Ref
Load all user groups from the database.

return: self

populateGroupsData()   X-Ref
Populates extra information for groups.

return: array

populateGroupData($group)   X-Ref
Populate data for a specific user group.

param: \stdClass  $group  Group
return: \stdClass

setGroups(array $groups)   X-Ref
Set the groups to be used as source.

param: array  $groups  Array of user groups.
return: self



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