Yioop_V9.5_Source_Code_Documentation

ManagegroupsElement extends Element
in package

Used to draw the admin screen on which users can create groups, delete groups and add and delete users and roles to a group

Tags
author

Mallika Perepa (started) Chris Pollett (rewrite)

Table of Contents

$view  : object
The View on which this Element is drawn
__construct()  : mixed
constructor stores a reference to the view this element will reside on
formatHref()  : string
Used to slightly clean up hypertext links before drawing them (get rid of empty queries, avoid double encoding)
render()  : mixed
Renders the screen in which groups can be created, deleted, and added or deleted
renderGraphStats()  : mixed
Draws chart of the group statistics in terms of number of views in different time periods.
renderGroupsForm()  : mixed
Draws the add groups and edit groups forms
renderGroupStatistics()  : mixed
Draws group statistics related to number of users, popular threads and wiki pages.
renderInfoGroup()  : mixed
renderInviteUsersForm()  : mixed
Draws form used to invite users to the current group
renderJoinTable()  : mixed
Render the table of groups that a user could join.
renderSearchForm()  : mixed
Draws the search for groups forms

Properties

$view

The View on which this Element is drawn

public object $view

Methods

__construct()

constructor stores a reference to the view this element will reside on

public __construct([object $view = null ]) : mixed
Parameters
$view : object = null

object this element will reside on

Return values
mixed

formatHref()

Used to slightly clean up hypertext links before drawing them (get rid of empty queries, avoid double encoding)

public formatHref(string $url) : string
Parameters
$url : string

to clean up

Return values
string

cleaned url

render()

Renders the screen in which groups can be created, deleted, and added or deleted

public render(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

contains antiCSRF token, as well as data on available groups or which user is in what group

Return values
mixed

renderGraphStats()

Draws chart of the group statistics in terms of number of views in different time periods.

public renderGraphStats(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

from the social component controller containing statistical information of specific group item including time period, number of views, update timestamp

Return values
mixed

renderGroupsForm()

Draws the add groups and edit groups forms

public renderGroupsForm(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

consists of values of groups fields set so far as well as values of the drops downs on the form

Return values
mixed

renderGroupStatistics()

Draws group statistics related to number of users, popular threads and wiki pages.

public renderGroupStatistics(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

from the admin controller with a 'CURRENT_GROUP' field providing information about the current group as well as info about the current CSRF_TOKEN

Return values
mixed

renderInfoGroup()

public renderInfoGroup(mixed $data) : mixed
Parameters
$data : mixed
Return values
mixed

renderInviteUsersForm()

Draws form used to invite users to the current group

public renderInviteUsersForm(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

from the admin controller with a 'CURRENT_GROUP' field providing information about the current group as well as info about the current CSRF_TOKEN

Return values
mixed

renderJoinTable()

Render the table of groups that a user could join.

public renderJoinTable(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

data from the controller used to draw this table

Return values
mixed

renderSearchForm()

Draws the search for groups forms

public renderSearchForm(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

consists of values of role fields set so far as well as values of the drops downs on the form

Return values
mixed

        

Search results