\seekquarry\yioop\controllers\componentsSystemComponent

This component is used to handle activities related to the configuration of a Yioop installation, translations of text appearing in the installation, as well as control of specifying what machines make up the installation and which processes they run.

Summary

Methods

Properties

Constants

__construct()
initializeWikiEditor()
manageMachines()
manageLocales()
serverSettings()
security()
appearance()
configure()
systemCheck()

$parent

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: src/controllers/components/SystemComponent.php
Package: Default
Class hierarchy: \seekquarry\yioop\controllers\components\Component

\seekquarry\yioop\controllers\components\SystemComponent

Properties

$parent

$parent : object

Reference to the controller this component lives on

Type

object

Methods

__construct()

__construct(object  $parent_controller)

Sets up this component by storing in its parent field a reference to controller this component lives on

Parameters

object

$parent_controller

reference to the controller this component lives on

initializeWikiEditor()

initializeWikiEditor(\seekquarry\yioop\controllers\components\array&  $data,   $id = "")

Called to include the Javascript Wiki Editor (wiki.js) on a page and to send any localizations needed from PHP to Javascript-land It is used by both Crawl and SocialComponent

Parameters

\seekquarry\yioop\controllers\components\array&	$data	an asscoiative array of data to be used by the view and layout that the wiki editor will be drawn on This method tacks on to INCLUDE_SCRIPTS to make the layout load wiki.js.
	$id	if "" then all textareas on page will get editor buttons, if -1 then sets up translations, but does not add any button, otherwise, add buttons to textarea $id will. (Can call this method multiple times, if want more than one but not all)

manageMachines()

manageMachines() : array

Handles admin request related to the managing the machines which perform crawls

With this activity an admin can add/delete machines to manage. For each managed machine, the admin can stop and start fetchers/queue_servers as well as look at their log files

Returns

array —

$data MACHINES, their MACHINE_NAMES, data for FETCHER_NUMBERS drop-down

manageLocales()

manageLocales() : array

Handles admin request related to the manage locale activity

The manage locale activity allows a user to add/delete locales, view statistics about a locale as well as edit the string for that locale

Returns

array —

$data info about current locales, statistics for each locale as well as potentially the currently set string of a locale and any messages about the success or failure of a sub activity.

serverSettings()

serverSettings() : array

Handles admin panel requests for mail, database, tor, proxy server settings

Returns

array —

$data data for the view concerning the current settings so they can be displayed

security()

security()

Responsible for the Captcha Settings and managing Captcha/Recovery questions.

appearance()

appearance() : array

Responsible for handling admin request related to the appearance activity

The activity is used to control the look and feel of the Yioop instance such as foreground, background color, icons, etc.

Returns

array —

$data fields for current appearance settings

configure()

configure() : array

Responsible for handling admin request related to the configure activity

The configure activity allows a user to set the work directory for storing data local to this SeekQuarry/Yioop instance. It also allows one to set the default language of the installation, debug info, robot info, test info, etc.

Returns

array —

$data fields for available language, debug level, etc as well as results of processing sub activity if any

systemCheck()

systemCheck() : string

Checks to see if the current machine has php configured in a way Yioop! can run.

Returns

string —

a message indicatign which required and optional components are missing; or "Passed" if nothing missing.