HelpTour Class Reference

Inheritance diagram for HelpTour:

Collaboration diagram for HelpTour:

Public Member Functions
	isVisible ()
	addStep ($data, $position=0)
	deleteStep ($position=0)
	validate ()
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)
	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	GetHelpbarTourData ()
static	GetToursByRoute ($route='')
static	GetToursByFilter ($term='')
static	GetConflicts ()
static	GetTourObjects ($tour_result)
Static Public Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)
static	expireTableScheme ()
static	find ($id)
static	exists ($id)
static	countBySql ($sql=1, $params=[])
static	create ($data)
static	build ($data, $is_new=true)
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	configure ($config=[])
static	config ($key)

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)
	registerCallback ($types, $cb)
	unregisterCallback ($types, $cb)
	cbAutoIncrementColumn ($type)
	cbAutoKeyCreation ()
	cbNotificationMapper ($cb_type)
	cbAfterInitialize ($cb_type)
	setSerializedValue ($field, $value)
	setI18nValue ($field, $value)
	cbI18N ($type)
Protected Attributes inherited from SimpleORMap
	$content = []
	$content_db = []
	$is_new = true
	$is_deleted = false
	$db_table = ''
	$db_fields = null
	$pk = null
	$default_values = []
	$serialized_fields = []
	$alias_fields = []
	$i18n_fields = []
	$additional_fields = []
	$relations = []
	$has_many = []
	$has_one = []
	$belongs_to = []
	$has_and_belongs_to_many = []
	$registered_callbacks = []
	$known_slots = []
	$notification_map = []
	$additional_data = []
	$getter_setter_map = []
Static Protected Attributes inherited from SimpleORMap
static	$config = []
static	$reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']

Member Function Documentation

addStep()

addStep	(		$data,
			$position = 0
	)

adds step to the tour and rearranges existing steps

Here is the call graph for this function:

configure()

static configure (   $config = [] )

staticprotected

set configuration data from subclass

Parameters

array

$config

configuration data

Returns

void

Reimplemented from SimpleORMap.

deleteStep()

deleteStep

(

$position = 0

)

deletes step and rearranges existing steps

Here is the call graph for this function:

GetConflicts()

static GetConflicts ( )

static

fetches tour conflicts

Returns

array set of tour objects

Here is the call graph for this function:

Here is the caller graph for this function:

GetHelpbarTourData()

static GetHelpbarTourData ( )

static

get visible tours for helpbar

Returns

array set of tours

Here is the call graph for this function:

GetTourObjects()

static GetTourObjects (   $tour_result )

static

builds tour objects for given set of tour data

Parameters

array

$tour_result

tour set

Returns

array set of tour objects

Here is the caller graph for this function:

GetToursByFilter()

static GetToursByFilter (   $term = '' )

static

fetches set of tours from database filtered by parameters

Parameters

string	$term	search term for tour name
boolean	$as_objects	include HelpTour objects in result array

Returns

array set of tours

Here is the call graph for this function:

Here is the caller graph for this function:

GetToursByRoute()

static GetToursByRoute (   $route = '' )

static

fetches set of tours from database for given route

Parameters

string	$route	route for tours to begin
boolean	$as_objects	include HelpTour objects in result array

Returns

array set of tours

Here is the call graph for this function:

isVisible()

isVisible

(

)

checks if tour is visible for current user

Here is the call graph for this function:

validate()

validate

(

)

checks, if basic tour data is complete

Returns

boolean true or false

Here is the call graph for this function:

---

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

• lib/models/HelpTour.class.php