seek_quarry
[ class tree: seek_quarry ] [ index: seek_quarry ] [ all elements ]

Class: View

Source Location: /views/view.php

Class Overview


Base View Class. A View is used to display the output of controller activity


Author(s):

  • Chris Pollett

Variables

Methods


Child classes:

AdminView
View responsible for drawing the admin pages of the SeekQuarry search engine site
CrawlstatusView
This view is used to display information about crawls that have been made by this seek_quarry instance
FetchView
This view is displayed by the fetch_controller.php to send information to a fetcher about things like what to crawl next
MachinestatusView
This view is used to display information about the on/off state of the queue_servers and fetchers managed by this instance of Yioop.
NocacheView
This view is drawn when someone clicks on the cached link of a web-page for which no cache is available
RssView
Web page used to present search results It is also contains the search box for people to types searches into
SearchView
Web page used to present search results It is also contains the search box for people to types searches into
SettingsView
Draws the view on which people can control their search settings such as num links per screen and the language settings
SigninView
This View is responsible for drawing the login screen for the admin panel of the Seek Quarry app
StaticView
This View is responsible for drawing the landing page of the Seek Quarry app
StatisticsView
Draws a view displaying statistical information about a web crawl such as number of hosts visited, distribution of file sizes, distribution of file type, distribution of languages, etc

Class Details

[line 45]
Base View Class. A View is used to display the output of controller activity



Tags:

author:  Chris Pollett
abstract:  


[ Top ]


Class Variables

$elements = array()

[line 51]

Names of element objects that the view uses to display itself


Type:   array


[ Top ]

$helpers = array()

[line 57]

Names of helper objects that the view uses to help draw itself


Type:   array


[ Top ]

$layout =  ""

[line 69]

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


Type:   string


[ Top ]

$layout_object =

[line 74]

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


Type:   object


[ Top ]

$pages = array()

[line 63]

Localized static page elements used by this view


Type:   array


[ Top ]



Class Methods


constructor __construct [line 82]

View __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.



[ Top ]

method render [line 178]

void 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

[ Top ]

method renderView [line 190]

void 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.



Tags:

abstract:  


Overridden in child classes as:

AdminView::renderView()
Renders the list of admin activities and draws the current activity Renders the Javascript to autologout after an hour
CrawlstatusView::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.
FetchView::renderView()
Draws message to be used by a fetcher. It might for example contains a schedule of sites to crawl
MachinestatusView::renderView()
Draws the ManagestatusView to the output buffer
NocacheView::renderView()
Draws a simple message saying no cache available of the requested page
RssView::renderView()
Draws the main landing pages as well as search result pages
SearchView::renderView()
Draws the main landing pages as well as search result pages
SettingsView::renderView()
sDraws the web page on which users can control their search settings.
SigninView::renderView()
Draws the login web page.
StaticView::renderView()
Draws the login web page.
StatisticsView::renderView()
Draws the web page used to display statistics about the default crawl

Parameters:

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

[ Top ]


Documentation generated by phpDocumentor 1.4.3