Yioop_V9.5_Source_Code_Documentation

TestsView extends View
in package

Draws the view on which people can control their search settings such as num links per screen and the language settings

Tags
author

Chris Pollett

Table of Contents

$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
__construct()  : mixed
The constructor reads in any Element and Helper subclasses which are needed to draw the view. It also reads in the Layout subclass on which the View will be drawn.
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).
renderAllTests()  : mixed
Uses draw the results of all available unit tests in Yioop
renderTest()  : mixed
Uses draw the results of unit test class, run the tests in it and display the results
renderTestsList()  : mixed
This function is responsible for listing out HTML links to the available unit tests a user can run
renderView()  : mixed
Draws the web page on which users can control their search settings.

Properties

$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

Methods

__construct()

The constructor reads in any Element and Helper subclasses which are needed to draw the view. It also reads in the Layout subclass on which the View will be drawn.

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

renderAllTests()

Uses draw the results of all available unit tests in Yioop

public renderAllTests(string $data) : mixed
Parameters
$data : string

passed from controller. Its $data['ALL_RESULTS'] field should contain an array of all the test results for unit tests that were carried out

Return values
mixed

renderTest()

Uses draw the results of unit test class, run the tests in it and display the results

public renderTest(string $data) : mixed
Parameters
$data : string

passed from controller. Its $data['TEST_NAME'] field should contain an array test case results for a particular unit test. It's $data['NO_ALL_LINK'] should say whether all tests are currently being run or just one.

Return values
mixed

renderTestsList()

This function is responsible for listing out HTML links to the available unit tests a user can run

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

passed from controller. Its $data['TEST_NAMES'] field should contain an array of all the tests that can be run

Return values
mixed

renderView()

Draws the web page on which users can control their search settings.

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

passed from controller. It fields contain info about the possibble tests that can be run, which test activity to carry out, etc.

Return values
mixed

        

Search results