PHPXRef 0.7.1 : phpBB-3.3.14-deutsch : Detail view of helper.php

This file is part of the phpBB Forum Software package.

Copyright:	(c) phpBB Limited
License:	GNU General Public License, version 2 (GPL-2.0)
File Size:	294 lines (9 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

helper:: (5 methods):
  __construct()
  get_name()
  get_name_string()
  get_rank()
  get_avatar()

Class: helper - X-Ref

__construct(auth $auth, cache $cache, config $config, language $language, dispatcher_interface $dispatcher, path_helper $path_helper, user $user) X-Ref

Constructor

param: auth                    $auth            Authentication object
param: cache                    $cache            Cache service object
param: config                $config            Configuration object
param: language                $language        Language object
param: dispatcher_interface    $dispatcher        Event dispatcher object
param: path_helper            $path_helper    Path helper object
param: user                    $user            User object

get_name($group_name) X-Ref

param: string $group_name The stored group name
return: string Group name or translated group name if it exists

get_name_string($mode, $group_id, $group_name, $group_colour = '', $custom_profile_url = false) X-Ref

Get group name details for placing into templates.

param: string    $mode                Profile (for getting an url to the profile),
param: int        $group_id            The group id
param: string    $group_name            The group name
param: string    $group_colour        The group colour
param: mixed        $custom_profile_url    optional parameter to specify a profile url. The group id gets appended to this url as &g={group_id}
return: string A string consisting of what is wanted based on $mode.

get_rank($group_data) X-Ref

Get group rank title and image

param: array $group_data The current stored group data
return: array An associative array containing the rank title (title),

get_avatar($group_row, $alt = 'GROUP_AVATAR', $ignore_config = false, $lazy = false) X-Ref

Get group avatar.
Wrapper function for phpbb_get_group_avatar()

param: array        $group_row        Row from the groups table
param: string    $alt            Optional language string for alt tag within image, can be a language key or text
param: bool        $ignore_config    Ignores the config-setting, to be still able to view the avatar in the UCP
param: bool        $lazy            If true, will be lazy loaded (requires JS)
return: string                     Avatar html

PHP Cross Reference of phpBB-3.3.14-deutsch

/phpbb/group/ -> helper.php (summary)

Defines 1 class