\seekquarry\yioop\viewsGroupView

View used to draw and allow editing of group feeds when not in the admin view (so activities panel on side is not present.) This is also used to draw group feeds for public feeds when not logged.

Summary

Methods
Properties
Constants
renderView()
addContainer()
emptyContainer()
renderContainer()
__construct()
element()
helper()
render()
$layout
$controller_object
$layout_object
$logo_alt_text
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$containers
N/A

Properties

$layout

$layout : string

This view is drawn on a web layout

Type

string

$controller_object

$controller_object : object

The name of the type of controller object that is sending data to the view

Type

object

$layout_object

$layout_object : object

The reference to the layout object that the view is drawn on

Type

object

$logo_alt_text

$logo_alt_text : string

Logo image text name

Type

string

$containers

$containers : Array

Containers for Elements that this ComponentView has

Type

Array

Methods

renderView()

renderView(array  $data) 

This abstract method is implemented in sub classes with code which actually draws the view. The current layouts render method calls this function.

Parameters

array $data

an array of values set up by a controller to be used in rendering the view

addContainer()

addContainer(string  $label, string  $element_name) 

Adds an Element object to the ComponentView container so it can be drawn in that container later.

Parameters

string $label

name of the container on this component view to add the element to

string $element_name

name of the Element (for example, for a GroupoptionsElement this name would be groupoptions) to instantiate and add to the container

emptyContainer()

emptyContainer(string  $label) : boolean

Checks if one the top, sub-top,smae, opposite, center or bottom contains has anything in it or not.

Parameters

string $label

one of labels top, sub-top, etc

Returns

boolean —

whether that container is empty or not

renderContainer()

renderContainer(string  $label, array  $data) 

Draws one of the container labels onto the view using data provided by the controller

Parameters

string $label

container to draw

array $data

field data from the controller for use during drawing

__construct()

__construct(object  $view = null) 

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

Parameters

object $view

object this element will reside on

element()

element(string  $element) 

Dynamic loader for Element objects which might live on the current View

Parameters

string $element

name of Element to return

helper()

helper(string  $helper) 

Dynamic loader for Helper objects which might live on the current View

Parameters

string $helper

name of Helper to return

render()

render(array  $data) 

This method is responsible for drawing both the layout and the view. It should not be modified to change the display of then view. Instead, implement renderView.

Parameters

array $data

an array of values set up by a controller to be used in rendering the view