Inheritance diagram for WikiPage:

Public Member Functions
	isVisibleTo ($user)

	isEditableBy ($user)

	isCreatableBy ($user)

	isLatestVersion ()

	setAncestorForAllVersions ($ancestor)

	isValidAncestor ($ancestor)

	getDescendants ()

	isDescendantOf (string $other_keyword)

Public Member Functions inherited from SimpleORMap
	__construct ($id=null)

	__clone ()

	getRelationOptions ($relation)

	getTableMetadata ()

	hasAutoIncrementColumn ()

	setId ($id)

	getId ()

	getNewId ()

	toArray ($only_these_fields=null)

	toRawArray ($only_these_fields=null)

	toArrayRecursive ($only_these_fields=null)

	getValue ($field)

	getRelationValue ($relation, $field)

	getDefaultValue ($field)

	setValue ($field, $value)

	__get ($field)

	__set ($field, $value)

	__isset ($field)

	offsetExists ($offset)

	offsetGet ($offset)

	offsetSet ($offset, $value)

	offsetUnset ($offset)

	getIterator ()

	count ()

	isField ($field)

	isRelation ($field)

	isAdditionalField ($field)

	isAliasField ($field)

	isI18nField ($field)

	setData ($data, $reset=false)

	isNew ()

	isDeleted ()

	setNew ($is_new)

	getWhereQuery ()

	restore ()

	store ()

	triggerChdate ()

	delete ()

	isDirty ()

	isFieldDirty ($field)

	revertValue ($field)

	getPristineValue ($field)

	initRelation ($relation)

	resetRelation ($relation)

	cleanup ()

Static Public Member Functions
static	findLatestPages ($course_id)

static	findLatestPage ($course_id, $keyword)

static	getStartPage ($course_id)

static	exportUserData (StoredUserData $storage)

Static Public Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)

static	expireTableScheme ()

static	exists ($id)

static	countBySql ($sql= '1', $params=[])

static	create ($data)

static	buildExisting ($data)

static	import ($data)

static	findBySQL ($sql, $params=[])

static	findOneBySQL ($where, $params=[])

static	findThru ($foreign_key_value, $options)

static	findEachBySQL ($callable, $sql, $params=[])

static	findMany ($pks=[], $order= '', $order_params=[])

static	findEachMany ($callable, $pks=[], $order= '', $order_params=[])

static	findAndMapBySQL ($callable, $where, $params=[])

static	findAndMapMany ($callable, $pks=[], $order= '', $order_params=[])

static	deleteBySQL ($where, $params=[])

static	toObject ($id_or_object)

static	__callStatic ($name, $arguments)

Static Protected Member Functions
static	configure ($config=[])

Static Protected Member Functions inherited from SimpleORMap
static	db_table ()

static	db_fields ()

static	pk ()

static	default_values ()

static	serialized_fields ()

static	alias_fields ()

static	i18n_fields ()

static	additional_fields ()

static	has_many ()

static	has_one ()

static	belongs_to ()

static	has_and_belongs_to_many ()

static	registered_callbacks ()

static	known_slots ()

static	notification_map ()

static	getter_setter_map ()

static	configure ($config=[])

static	config ($key)

static	registerCallback ($types, $cb)

static	unregisterCallback ($types, $cb)

Additional Inherited Members
Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'

Static Public Attributes inherited from SimpleORMap
static	$schemes = null

Protected Member Functions inherited from SimpleORMap
	_getId ($field)

	_setId ($field, $value)

	_getAdditionalValueFromRelation ($field)

	_setAdditionalValueFromRelation ($field, $value)

	_getAdditionalValue ($field)

	_setAdditionalValue ($field, $value)

	parseRelationOptions ($type, $name, $options)

	storeRelations ($only_these=null)

	deleteRelations ()

	initializeContent ()

	applyCallbacks ($type)

	cbNotificationMapper ($cb_type)

	cbAfterInitialize ($cb_type)

	setSerializedValue ($field, $value)

	setI18nValue ($field, $value)

Protected Attributes inherited from SimpleORMap
	$content = []

	$content_db = []

	$is_new = true

	$is_deleted = false

	$relations = []

	$additional_data = []

Static Protected Attributes inherited from SimpleORMap
static	$config = []

static	$reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']

static	$performs_batch_operation = false

Member Function Documentation

static configure ( $config = [] )

staticprotected

Configures the model

Parameters

array $config Configuration

static exportUserData ( StoredUserData $storage )

static

Export available data of a given user into a storage object (an instance of the StoredUserData class) for that user.

Parameters

StoredUserData $storage object to store data into

Implements PrivacyObject.

static findLatestPage	(	$course_id,
		$keyword
	)

static

Finds the latest version for the given course and keyword

Parameters

string	$course_id	Course id
string	$keyword	Keyword

Returns: WikiPage or null

static findLatestPages ( $course_id )

static

Finds all latest versions of all pages for the given course.

Parameters

string $course_id Course id

Returns: SimpleCollection of all pages

getDescendants ( )

Retrieve an array of all descending WikiPages (recursive).

Returns: array Array of all descendant WikiPages

static getStartPage ( $course_id )

static

Returns the start page of a wiki for a given course. The start page has the keyword 'WikiWikiWeb'.

Parameters

string $course_id Course id

Returns: WikiPage

isCreatableBy ( $user )

Returns whether this page is creatable to the given user.

Parameters

mixed $user User object or id

Returns: boolean indicating whether the page is creatable

isDescendantOf ( string $other_keyword )

Parameters

string $other_keyword

Returns: bool

isEditableBy ( $user )

Returns whether this page is editable to the given user.

Parameters

mixed $user User object or id

Returns: boolean indicating whether the page is editable

isLatestVersion ( )

Returns whether this version of this page is the latest version availabe.

Returns: boolean

isValidAncestor ( $ancestor )

Tests if a given Wikipage name (keyword) is a valid ancestor for this page.

Parameters

string ancestor Wikipage name to be tested to be an ancestor

Returns: boolean true if ok, false if not

isVisibleTo ( $user )

Returns whether this page is visible to the given user.

Parameters

mixed $user User object or id

Returns: boolean indicating whether the page is visible

setAncestorForAllVersions ( $ancestor )

Sets the parent page for all versions of a Wikipage.

Parameters

string ancestor Wikipage name to be set as the parent

The documentation for this class was generated from the following file:

lib/models/WikiPage.class.php

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Member Function Documentation