From b69fca14e76a2f5db0cd0924fe5e7056e94771b1 Mon Sep 17 00:00:00 2001 From: friendica Date: Tue, 26 Feb 2013 15:49:37 -0800 Subject: initial doco --- doc/html/classConversation.html | 496 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 496 insertions(+) create mode 100644 doc/html/classConversation.html (limited to 'doc/html/classConversation.html') diff --git a/doc/html/classConversation.html b/doc/html/classConversation.html new file mode 100644 index 000000000..246bb11a3 --- /dev/null +++ b/doc/html/classConversation.html @@ -0,0 +1,496 @@ + + + + + + +The Red Project: Conversation Class Reference + + + + + + + + + + + + + +
+
+ + + + + + + +
+
The Red Project +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Member Functions | +Private Member Functions | +Private Attributes | +List of all members
+
+
Conversation Class Reference
+
+
+
+Inheritance diagram for Conversation:
+
+
+ + +BaseObject + +
+ + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 __construct ($mode, $preview)
 
 get_mode ()
 
 is_writable ()
 
 is_preview ()
 
 get_profile_owner ()
 
 add_thread ($item)
 
 get_template_data ($alike, $dlike)
 
- Public Member Functions inherited from BaseObject
 get_app ()
 
+ + + + + +

+Private Member Functions

 set_mode ($mode)
 
 get_thread ($id)
 
+ + + + + + + + + + + +

+Private Attributes

 $threads = array()
 
 $mode = null
 
 $writable = false
 
 $profile_owner = 0
 
 $preview = false
 
+ + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from BaseObject
static set_app ($app)
 
+

Detailed Description

+

A list of threads

+

We should think about making this a SPL Iterator

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
Conversation::__construct ( $mode,
 $preview 
)
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + +
Conversation::add_thread ( $item)
+
+

Add a thread to the conversation

+

Returns: _ The inserted item on success _ false on failure

+ +
+
+ +
+
+ + + + + + + +
Conversation::get_mode ()
+
+

Get mode

+ +

Referenced by set_mode().

+ +
+
+ +
+
+ + + + + + + +
Conversation::get_profile_owner ()
+
+

Get profile owner

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Conversation::get_template_data ( $alike,
 $dlike 
)
+
+

Get data in a form usable by a conversation template

+

We should find a way to avoid using those arguments (at least most of them)

+

Returns: _ The data requested on success _ false on failure

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Conversation::get_thread ( $id)
+ 		+private
+
+

Get a thread based on its item id

+

Returns: _ The found item on success _ false on failure

+ +

Referenced by add_thread().

+ +
+
+ +
+
+ + + + + + + +
Conversation::is_preview ()
+
+

Check if page is a preview

+ +
+
+ +
+
+ + + + + + + +
Conversation::is_writable ()
+
+

Check if page is writable

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Conversation::set_mode ( $mode)
+ 		+private
+
+

Set the mode we'll be displayed on

+ +

Referenced by __construct().

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
Conversation::$mode = null
+ 		+private
+
+ +

Referenced by __construct(), get_mode(), and set_mode().

+ +
+
+ +
+
+ + + + + +
+ + + + +
Conversation::$preview = false
+ 		+private
+
+ +

Referenced by __construct(), and is_preview().

+ +
+
+ +
+
+ + + + + +
+ + + + +
Conversation::$profile_owner = 0
+ 		+private
+
+ +

Referenced by get_profile_owner().

+ +
+
+ +
+
+ + + + + +
+ + + + +
Conversation::$threads = array()
+ 		+private
+
+ +
+
+ +
+
+ + + + + +
+ + + + +
Conversation::$writable = false
+ 		+private
+
+ +

Referenced by is_writable().

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + -- cgit v1.2.3