\seekquarry\yioop\viewsCrawlstatusView

This view is used to display information about crawls that have been made by this seek_quarry instance

Summary

Methods
Properties
Constants
__construct()
element()
helper()
render()
renderView()
renderActiveCrawls()
renderCrawlForm()
$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
No private properties found
N/A

Properties

$layout

$layout : string

The name of the type of layout object that the view is drawn on

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

Methods

__construct()

__construct(object  $controller_object = null) 

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.

Parameters

object $controller_object

that is using this view

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

renderView()

renderView(array  $data) 

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.

Parameters

array $data

info about the current crawl status

renderActiveCrawls()

renderActiveCrawls(array  $data) 

This is used to render information about ongoing crawls

Parameters

array $data

associative array containing info about which crawls are still running, how many urls they have, etc.

renderCrawlForm()

renderCrawlForm(array  $data) 

Draws the form used to start a new crawl

Parameters

array $data

containing CSRF_TOKEN field and other field used to draw this form