\seekquarry\yioop\controllers\componentsComponent

Base component class for all components on the SeekQuarry site. A component consists of a collection of activities and their auxiliary methods that can be used by a controller

Summary

Methods

Properties

Constants

__construct()
initializeWikiEditor()

$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/Component.php
Package: Default
Class hierarchy: \seekquarry\yioop\controllers\components\Component

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)