Yioop_V9.5_Source_Code_Documentation

RegisterView extends View
in package

Draws the page that allows a user to register for an account

Tags
author

Mallika Perepa (creator), Chris Pollett, Akash Patel

Table of Contents

$captchas_qa  : array<string|int, mixed>
An array of triples, each triple consisting of a question of the form Which is the most..? followed by one of the form Which is the least ..? followed by a string which is a comma separated list of possibilities arranged from least to most. The values for these triples are determined via the translate function tl. So can be set under Manage Locales by editing their values for the desired locale. You can also change them in the Security element
$controller_object  : object
The name of the type of controller object that is sending data to the view
$element_instances  : array<string|int, mixed>
Array of Element's that have been instantiated for this View
$head_objects  : array<string|int, mixed>
Meta info for group wiki pages
$helper_instances  : array<string|int, mixed>
Array of Helper's that have been instantiated for this View
$layout  : string
This view is drawn on a web layout
$layout_object  : object
The reference to the layout object that the view is drawn on
$logo_alt_text  : string
Logo image text name
$page_objects  : array<string|int, mixed>
Contents of group wiki pages
$recovery_qa  : array<string|int, mixed>
An array of triples, each triple consisting of a question of the form Which is your favorite..? followed by one of the form Which is your like the least..? followed by a string which is a comma separated choices. The values for these triples are determined via the translate function tl. So can be set under Manage Locales by editing their values for the desired locale.
__construct()  : mixed
Besides setting calling the constructor for the base class this constructor also sets up the captchas_qa and recovery_qa arrays so they can be localized. The reason for putting these arrays in a view is so that multiple controllers/components can see and manipulate them
element()  : mixed
Dynamic loader for Element objects which might live on the current View
helper()  : mixed
Dynamic loader for Helper objects which might live on the current View
render()  : mixed
This method is responsible for drawing both the layout and the view. It should not be modified to change the display of the view (in subclasses).
renderView()  : mixed
Draws the create account web page.

Properties

$captchas_qa

An array of triples, each triple consisting of a question of the form Which is the most..? followed by one of the form Which is the least ..? followed by a string which is a comma separated list of possibilities arranged from least to most. The values for these triples are determined via the translate function tl. So can be set under Manage Locales by editing their values for the desired locale. You can also change them in the Security element

public array<string|int, mixed> $captchas_qa

$controller_object

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

public object $controller_object = null

$element_instances

Array of Element's that have been instantiated for this View

public array<string|int, mixed> $element_instances

$head_objects

Meta info for group wiki pages

public array<string|int, mixed> $head_objects

$helper_instances

Array of Helper's that have been instantiated for this View

public array<string|int, mixed> $helper_instances

$layout

This view is drawn on a web layout

public string $layout = "web"

$layout_object

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

public object $layout_object

$logo_alt_text

Logo image text name

public string $logo_alt_text

$page_objects

Contents of group wiki pages

public array<string|int, mixed> $page_objects

$recovery_qa

An array of triples, each triple consisting of a question of the form Which is your favorite..? followed by one of the form Which is your like the least..? followed by a string which is a comma separated choices. The values for these triples are determined via the translate function tl. So can be set under Manage Locales by editing their values for the desired locale.

public array<string|int, mixed> $recovery_qa

Methods

__construct()

Besides setting calling the constructor for the base class this constructor also sets up the captchas_qa and recovery_qa arrays so they can be localized. The reason for putting these arrays in a view is so that multiple controllers/components can see and manipulate them

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

that is using this view

Return values
mixed

element()

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

public element(string $element) : mixed
Parameters
$element : string

name of Element to return

Return values
mixed

helper()

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

public helper(string $helper) : mixed
Parameters
$helper : string

name of Helper to return

Return values
mixed

render()

This method is responsible for drawing both the layout and the view. It should not be modified to change the display of the view (in subclasses).

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

Instead, implement renderView.

Parameters
$data : array<string|int, mixed>

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

Return values
mixed

renderView()

Draws the create account web page.

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

contains the anti CSRF token the view, data for captcha and recover dropdowns

Return values
mixed

        

Search results