Yioop_V9.5_Source_Code_Documentation

GroupbarElement extends Element
in package

Element used to draw the navigation bar on group feed and wiki pages.

Tags
author

Chris Pollett

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)
getGroupUrl()  : string
Computes the url to show one group in the already belong to the group ($is_browse == false) and the just looking at group ($is_browse == true) setting.
render()  : mixed
Used to draw the navigation bar on the group feed and wiki page portion of the yioop website
renderWikiNavButtons()  : mixed
Draws navigation controls in the GroupBar when on Wiki pages (floated to opposite side of current reading direction) allowing a user depending on the access to the group to edit or view source of a page and to see the pages discussion thread.

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

getGroupUrl()

Computes the url to show one group in the already belong to the group ($is_browse == false) and the just looking at group ($is_browse == true) setting.

public getGroupUrl(string $group_name, string $token_string, bool $is_browse) : string
Parameters
$group_name : string

name of single group to show

$token_string : string

CSRF token to show legitimately logged in

$is_browse : bool

whether already belong to group (false) or not.

Return values
string —

url to either My Groups or Join Groups pages for group

render()

Used to draw the navigation bar on the group feed and wiki page portion of the yioop website

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

contains antiCSRF token, as well as data on used to initialize title for group or wiki page

Return values
mixed —

renderWikiNavButtons()

Draws navigation controls in the GroupBar when on Wiki pages (floated to opposite side of current reading direction) allowing a user depending on the access to the group to edit or view source of a page and to see the pages discussion thread.

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

associative array of data from the controller/ SocialComponent used to draw th enav buttons.

Return values
mixed — 

        

        
    




    

    

                

    

        

            
Search results