OssnAnnotation Class Reference

Inheritance diagram for OssnAnnotation:

Public Member Functions
	initAttributes ()
	addAnnotation ()
	getAnnotationById ()
	getAnnotationsByType ()
	getAnnotationsByOwner ()
	annon_delete_by_subject ($subject, $type)
	getAnnotationBySubject ()
	deleteAnnotation ($annotation=0)
	deleteAnnotationByOwner ($ownerguid)
	getAnnotationId ()
	searchAnnotation (array $params=array())
	canChange ($user='')
	save ()
Public Member Functions inherited from OssnEntities
	add ()
	get_entity ()
	save ()
	get_entities ()
	AddedEntityGuid ()
	updateEntity ()
	deleteByOwnerGuid ($guid, $type)
	deleteEntity ($guid='')
	searchEntities (array $params=array())
	canChange ($user='')
	destruct ()
Public Member Functions inherited from OssnDatabase
	__construct ()
	Connect ()
	insert ($params)
	statement ($query)
	execute ($values=array())
	update ($params=array())
	select ($params, $multi='')
	fetch ($data=false)
	delete ($params)
	getLastEntry ()
	constructWheres (array $array, $operator="AND")
	generateLimit ($data_limit=false, $page_limit=false, $offset=false)
	clearVars ()
	__destruct ()
Public Member Functions inherited from OssnBase
	getGUID ()
	getID ()
	getParam ($param)
	isParam ($param)
	__call ($method, $args)

Additional Inherited Members
Static Public Member Functions inherited from OssnSession
static	start ()
static	assign ($name='', $value='')
static	unassign ($name='')
static	isSession ($name='')
static	getSession ($name='')

Member Function Documentation

addAnnotation()

addAnnotation

(

)

Create annotation;

Requires the owner_guid, subject_guid, and annotation type

Returns

boolean

annon_delete_by_subject()

annon_delete_by_subject	(		$subject,
			$type
	)

Delete annotations by subject guid

@params $subject = subject_guid, $type = annotation type

Parameters

string

$type

Returns

object;

canChange()

canChange

(

$user = ''

)

Can change Check if user can change the requested item or not

Parameters

object

$user

User

Returns

boolean

Reimplemented from OssnEntities.

deleteAnnotation()

deleteAnnotation

(

$annotation = 0

)

Delete Annotation

Parameters

integer

$annotation

annotation_id

Returns

boolean;

deleteAnnotationByOwner()

deleteAnnotationByOwner

(

$ownerguid

)

Delete Annotation

Parameters

integer

$annotation

annotation_id

Returns

boolean

getAnnotationById()

getAnnotationById

(

)

Get annotation by annotation id;

Requires : $object->(annotation_id)

Returns

object

getAnnotationBySubject()

getAnnotationBySubject

(

)

Get annotation by subject_guid;

Requires : $object->(subject_guid, types(optional))

Returns

object;

getAnnotationId()

getAnnotationId

(

)

Get newly create annoation id

Returns

integer

getAnnotationsByOwner()

getAnnotationsByOwner

(

)

Get annotations by owner

Requires : $this->owner_guid

Returns

object;

getAnnotationsByType()

getAnnotationsByType

(

)

Get annotations by annotation type

Requires: $object->(annotation_id)

Returns

object;

initAttributes()

initAttributes

(

)

Initialize the objects.

Returns

void

Reimplemented from OssnEntities.

save()

save

(

)

A annotation save method

Returns

boolean

Reimplemented from OssnEntities.

searchAnnotation()

searchAnnotation

(

array

$params = array()

)

Search annotation by its type, owner etc

Parameters

array	$params	A valid options in format:
string	$params,['search_type']	true(default) to performs matching on a per-character basis , false to performs matching on exact value.
string	$params,['type']	Valid annotation type
integer	$params,['subject_guid']	A valid subject guid, which results integer value
integer	$params,['owner_guid']	A valid owner guid, which results integer value
integer	$params,['limit']	Result limit default, Default is 20 values
string	$params,['order_by']	To show result in sepcific order. There is no default order.

reutrn array|false;

---

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

• source/classes/OssnAnnotation.php