Zotlabs\Lib\ThreadStream Class Reference

A list of threads. More...

Public Member Functions
	__construct ($mode, $preview, $uploadable, $prepared_item='')
	get_mode ()
	Get mode.
	is_writable ()
	Check if page is writable.
	is_commentable ()
	is_uploadable ()
	is_preview ()
	Check if page is a preview.
	get_profile_owner ()
	Get profile owner.
	set_profile_owner ($uid)
	get_observer ()
	get_cipher ()
	add_thread ($item)
	Add a thread to the conversation.
	get_template_data ($conv_responses, $mid_uuid_map)
	Get data in a form usable by a conversation template.

Public Attributes
	$reload = ''

Private Member Functions
	set_mode ($mode)
	Set the mode we'll be displayed on.
	get_thread ($id)
	Get a thread based on its item id.

Private Attributes
	$threads = array()
	$mode = null
	$observer = null
	$writable = false
	$commentable = false
	$uploadable = false
	$profile_owner = 0
	$preview = false
	$prepared_item = ''
	$cipher = 'AES-128-CCM'

Detailed Description

A list of threads.

Constructor & Destructor Documentation

__construct()

Zotlabs\Lib\ThreadStream::__construct	(		$mode,
			$preview,
			$uploadable,
			$prepared_item = ''
	)

Member Function Documentation

add_thread()

Zotlabs\Lib\ThreadStream::add_thread

(

$item

)

Add a thread to the conversation.

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

get_cipher()

Zotlabs\Lib\ThreadStream::get_cipher

(

)

get_mode()

Zotlabs\Lib\ThreadStream::get_mode

(

)

Get mode.

Referenced by Zotlabs\Lib\ThreadStream\set_mode(), and Zotlabs\Lib\ThreadStream\set_profile_owner().

get_observer()

Zotlabs\Lib\ThreadStream::get_observer

(

)

get_profile_owner()

Zotlabs\Lib\ThreadStream::get_profile_owner

(

)

Get profile owner.

get_template_data()

Zotlabs\Lib\ThreadStream::get_template_data	(		$conv_responses,
			$mid_uuid_map
	)

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

get_thread()

Zotlabs\Lib\ThreadStream::get_thread (   $id )

private

Get a thread based on its item id.

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

Referenced by Zotlabs\Lib\ThreadStream\add_thread().

is_commentable()

Zotlabs\Lib\ThreadStream::is_commentable

(

)

is_preview()

Zotlabs\Lib\ThreadStream::is_preview

(

)

Check if page is a preview.

is_uploadable()

Zotlabs\Lib\ThreadStream::is_uploadable

(

)

is_writable()

Zotlabs\Lib\ThreadStream::is_writable

(

)

Check if page is writable.

set_mode()

Zotlabs\Lib\ThreadStream::set_mode (   $mode )

private

Set the mode we'll be displayed on.

Referenced by Zotlabs\Lib\ThreadStream\__construct(), and Zotlabs\Lib\ThreadStream\set_profile_owner().

set_profile_owner()

Zotlabs\Lib\ThreadStream::set_profile_owner

(

$uid

)

Member Data Documentation

$cipher

Zotlabs\Lib\ThreadStream::$cipher = 'AES-128-CCM'

private

Referenced by Zotlabs\Lib\ThreadStream\get_cipher().

$commentable

Zotlabs\Lib\ThreadStream::$commentable = false

private

Referenced by Zotlabs\Lib\ThreadStream\is_commentable().

$mode

Zotlabs\Lib\ThreadStream::$mode = null

private

Referenced by Zotlabs\Lib\ThreadStream\__construct(), Zotlabs\Lib\ThreadStream\get_mode(), Zotlabs\Lib\ThreadStream\set_mode(), and Zotlabs\Lib\ThreadStream\set_profile_owner().

$observer

Zotlabs\Lib\ThreadStream::$observer = null

private

Referenced by Zotlabs\Lib\ThreadStream\add_thread(), Zotlabs\Lib\ThreadStream\get_observer(), and Zotlabs\Lib\ThreadStream\set_mode().

$prepared_item

Zotlabs\Lib\ThreadStream::$prepared_item = ''

private

Referenced by Zotlabs\Lib\ThreadStream\__construct(), and Zotlabs\Lib\ThreadStream\get_template_data().

$preview

Zotlabs\Lib\ThreadStream::$preview = false

private

Referenced by Zotlabs\Lib\ThreadStream\__construct(), and Zotlabs\Lib\ThreadStream\is_preview().

$profile_owner

Zotlabs\Lib\ThreadStream::$profile_owner = 0

private

Referenced by Zotlabs\Lib\ThreadStream\get_profile_owner().

$reload

Zotlabs\Lib\ThreadStream::$reload = ''

$threads

Zotlabs\Lib\ThreadStream::$threads = array()

private

$uploadable

Zotlabs\Lib\ThreadStream::$uploadable = false

private

Referenced by Zotlabs\Lib\ThreadStream\__construct(), and Zotlabs\Lib\ThreadStream\is_uploadable().

$writable

Zotlabs\Lib\ThreadStream::$writable = false

private

Referenced by Zotlabs\Lib\ThreadStream\is_writable().

---

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

• Zotlabs/Lib/ThreadStream.php