Class DocList

Description

A list of Doc objects.

Located in /includes/classes/DocList.class.php (line 16)


	
			
Direct descendents
Class Description
 class AttachmentList A list of Doc attachment objects.
 class CommentList A list of Doc comment objects.
Variable Summary
 mixed $_arr
 mixed $_count
 mixed $_event_id
 mixed $_type
Method Summary
 DocList DocList ( $event_id,  $type)
 string getDescription ()
 Doc getDoc (int $ind)
 int getEventId ()
 int getSize ()
Variables
mixed $_arr (line 20)
mixed $_count = 0 (line 17)
mixed $_event_id = -1 (line 18)
mixed $_type (line 19)
Methods
Constructor DocList (line 53)

Creates a new Doc list for the specified event. This list will be for either attachments ($type='A') or comments ($type='C').

  • return: The new DocList object
  • access: public
DocList DocList ( $event_id,  $type)
  • $event_id
  • $type
getDescription (line 92)

Gets the event's description

  • return: The event's description
  • access: public
string getDescription ()
getDoc (line 36)

Get a specific Doc object by number (0=first)

  • return: The Doc object
Doc getDoc (int $ind)
  • int $ind: ind index number (0=first)
getEventId (line 81)

Gets the event ID of this list.

  • return: event ID
  • access: public
int getEventId ()
getSize (line 26)

Get the number of Doc objects in this list.

  • return: The number of objects in this list
int getSize ()

Documentation generated on Thu, 10 Jun 2010 17:08:23 -0400 by phpDocumentor 1.4.3