Activity Class Reference

Inheritance diagram for Activity:

Collaboration diagram for Activity:

Public Member Functions
	__toString ()
	setVerb ($verb)
	addUrl ($url, $name)
	getUrlList ()
	getRoute ()
	setContextObject (Context $context)
	getContextObject ()
	verbToText ()
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	doGarbageCollect ()
static	getOldestActivity ()
Static Public Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)
static	expireTableScheme ()
static	find ($id)
static	exists ($id)
static	countBySql ($sql=1, $params=array())
static	create ($data)
static	build ($data, $is_new=true)
static	buildExisting ($data)
static	import ($data)
static	findBySQL ($sql, $params=array())
static	findOneBySQL ($where, $params=array())
static	findThru ($foreign_key_value, $options)
static	findEachBySQL ($callable, $sql, $params=array())
static	findMany ($pks=array(), $order='', $order_params=array())
static	findEachMany ($callable, $pks=array(), $order='', $order_params=array())
static	findAndMapBySQL ($callable, $where, $params=array())
static	findAndMapMany ($callable, $pks=array(), $order='', $order_params=array())
static	deleteBySQL ($where, $params=array())
static	toObject ($id_or_object)
static	__callStatic ($name, $arguments)

Data Fields
	$object_url
	$object_route
const	GC_MAX_DAYS = 366
Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'

Static Protected Member Functions
static	configure ($config=array())
Static Protected Member Functions inherited from SimpleORMap
static	configure ($config=array())
static	config ($key)

Additional Inherited Members
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 = array()
	$content_db = array()
	$is_new = true
	$is_deleted = false
	$db_table = ''
	$db_fields = null
	$pk = null
	$default_values = array()
	$serialized_fields = array()
	$alias_fields = array()
	$i18n_fields = array()
	$additional_fields = array()
	$relations = array()
	$has_many = array()
	$has_one = array()
	$belongs_to = array()
	$has_and_belongs_to_many = array()
	$registered_callbacks = array()
	$known_slots = array()
	$notification_map = array()
	$additional_data = array()
	$getter_setter_map = array()
Static Protected Attributes inherited from SimpleORMap
static	$config = array()
static	$reserved_slots = array('value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id')

Member Function Documentation

__toString()

__toString

(

)

return a string representation for this activity

Returns

string

addUrl()

addUrl	(		$url,
			$name
	)

Add a url to the list of urls

Parameters

type	$url
type	$name

configure()

static configure (   $config = array() )

staticprotected

{set configuration data from subclass

Parameters

array

$config

configuration data

Returns

void

}

Reimplemented from SimpleORMap.

doGarbageCollect()

static doGarbageCollect ( )

static

Garbage collector for the activities. Removes all activites older than GC_MAX_DAYS (default: 366).

Here is the call graph for this function:

Here is the caller graph for this function:

getContextObject()

getContextObject

(

)

getOldestActivity()

static getOldestActivity ( )

static

Returns the oldest existing activity

Returns

Array

Here is the call graph for this function:

getRoute()

getRoute

(

)

Return api route of the content object

Returns

string

getUrlList()

getUrlList

(

)

Return assoc array of urls [[url => description]]

Returns

Array

setContextObject()

setContextObject

(

Context

$context

)

setVerb()

setVerb

(

$verb

)

set one of the allowed verbs

Parameters

string

$verb

Exceptions

InvalidArgumentException

verbToText()

verbToText

(

)

Returns a format string as placeholder for the object in question (in a grammatical / lexical sense)

Returns

string

Field Documentation

$object_route

$object_route

$object_url

$object_url

GC_MAX_DAYS

const GC_MAX_DAYS = 366

---

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

• lib/activities/Activity.php