Yioop_V9.5_Source_Code_Documentation

controllers

Namespaces

components

Interfaces, Classes, Traits and Enums

AdminController

Controller used to handle admin functionalities such as modify login and password, CREATE, UPDATE,DELETE operations for users, roles, locale, and crawls

ApiController

Controller used mainly for handling JS requests for Help Wiki Pages

ArchiveController

Fetcher machines also act as archives for complete caches of web pages, this controller is used to handle access to these web page caches

ClassifierController

This class handles XmlHttpRequests to label documents during classifier construction.

Controller

Base controller class for all controllers on the SeekQuarry site.

CrawlController

Controller used to manage networked installations of Yioop where there might be mulliple QueueServers and a NameServer. Command sent to the nameserver web page are mapped out to queue_servers using this controller. Each method of the controller essentially mimics one method of CrawlModel, PhraseModel, or in general anything that extends ParallelModel and is used to proxy that information through a result web page back to the name_server.

FetchController

This class handles data coming to a queue_server from a fetcher Basically, it receives the data from the fetcher and saves it into various files for later processing by the queue server.

GroupController

Controller used to handle user group activities outside of the admin panel setting. This either could be because the admin panel is "collapsed" or because the request concerns a wiki page.

JobsController

This class is used to handle requests from a MediaUpdater to a name server There are three main types of requests: getUpdateProperties, and for any job that the MediaUpdater might be running, its getTasks, and putTasks request. getUpdateProperties is supposed to provide configuration settings for the MediaUpdater. A MediaUpdater might be running several periodic jobs. The getTasks requests of a job is used to see if there is any new work available of that job type on the name server. A putTasks request is used to handle any computed data sent back from a MediaUpdater to the name server.

MachineController

This class handles requests from a computer that is managing several fetchers and queue_servers. This controller might be used to start, stop fetchers/queue_server as well as get status on the active fetchers

RegisterController

Controller used to handle account registration and retrieval for the Yioop website. Also handles data for suggest a url

ResourceController

Used to serve resources, css, or scripts such as images from APP_DIR

SearchController

Controller used to handle search requests to SeekQuarry search site. Used to both get and display search results.

StaticController

This controller is used by the Yioop web site to display PUBLIC_GROUP_ID pages more like static forward facing pages.

TestsController

Controller used to handle search requests to SeekQuarry search site. Used to both get and display search results.

Table of Contents

tl()  : string

Translate the supplied arguments into the current locale.

e()  : mixed

shorthand for echo

exceptionErrorHandler()  : mixed

Error handler so catch errors as exceptions too