Public Member Functions

Annotation Class Reference

Base annotation. More...

Inheritance diagram for Annotation:
BEAppModel AppModel

List of all members.

Public Member Functions

 buildThread ($items)
 build thread structure
 putAnnotationInThread (&$thread, $annotation, $pathArr=null)
 put an annotation in the right position of thread
 countAnnotations (array $objects, array $options)
 passed an array of BEdita objects add 'num_of_annotation_name' key with the number of annotation applied to objects

Detailed Description

Base annotation.

Version:
$Revision$ $LastChangedBy$ $LastChangedDate$

$Id$

Definition at line 31 of file annotation.php.


Member Function Documentation

Annotation::buildThread ( items  ) 

build thread structure

Parameters:
array $items
Returns:
array

Definition at line 39 of file annotation.php.

References putAnnotationInThread().

Annotation::countAnnotations ( array $  objects,
array $  options 
)

passed an array of BEdita objects add 'num_of_annotation_name' key with the number of annotation applied to objects

Parameters:
array $objects
array $options list of options accepted

  • type: array of Annotation object as array('Comment', 'EditorNote')
Returns:
array $objects

Definition at line 88 of file annotation.php.

Annotation::putAnnotationInThread ( &$  thread,
annotation,
pathArr = null 
)

put an annotation in the right position of thread

Parameters:
array $thread
array $annotation (annotation object like Comment, EditorNote,...)
array $pathArr if it's empty it will be build from thread_path field
Returns:
void

Definition at line 56 of file annotation.php.

Referenced by buildThread().


The documentation for this class was generated from the following file:
Generated on Fri Dec 11 2015 15:29:45 by Doxygen 1.7.1  BEditaBEdita 3.7 Corylus