CrawlstatusView
extends View
in package
This view is used to display information about crawls that have been made by this seek_quarry instance
Tags
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
- The name of the type of layout object that the view is drawn on
- $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
- Instantiates a view for drawing the current status of crawls in the Yioop system
- 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).
- renderActiveCrawls() : mixed
- This is used to render information about ongoing crawls
- renderCrawlForm() : mixed
- Draws the form used to start a new crawl
- renderView() : mixed
- An Ajax call from the Manage Crawl Element in Admin View triggers this view to be instantiated. The renderView method then draws statistics about the currently active crawl.The $data is supplied by the crawlStatus method of the AdminController.
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
The name of the type of layout object that the view is drawn on
public
string
$layout
= ""
$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()
Instantiates a view for drawing the current status of crawls in the Yioop system
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 —renderActiveCrawls()
This is used to render information about ongoing crawls
public
renderActiveCrawls(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
-
associative array containing info about which crawls are still running, how many urls they have, etc.
Return values
mixed —renderCrawlForm()
Draws the form used to start a new crawl
public
renderCrawlForm(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
-
containing CSRF_TOKEN field and other field used to draw this form
Return values
mixed —renderView()
An Ajax call from the Manage Crawl Element in Admin View triggers this view to be instantiated. The renderView method then draws statistics about the currently active crawl.The $data is supplied by the crawlStatus method of the AdminController.
public
renderView(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
-
info about the current crawl status