Class Agora

The Agora:: class provides basic Agora functionality.

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Package: Agora
Author: Marko Djukic marko@oblo.com
Located at Agora.php

Methods summary
`public array`	# `getAgoraId( )` Determines the requested forum_id, message_id and application by checking first if they are passed as the single encoded var or individual vars. Determines the requested forum_id, message_id and application by checking first if they are passed as the single encoded var or individual vars. Returns `array` Forum, message id and application.
`public string`	# `setAgoraId( mixed $forum_id, mixed $message_id, mixed $url = '', mixed $scope = null, mixed $encode = false )` Creates the Agora id. Creates the Agora id. Returns `string` If passed with the $url parameter, returns a completed url with the agora_id tacked on at the end, otherwise returns the simple agora_id.
`public string`	# `getCAPTCHA( boolean $new = false )` Returns a new or the current CAPTCHA string. Returns a new or the current CAPTCHA string. Parameters `$new` <p>If true, a new CAPTCHA is created and returned. The current, to-be-confirmed string otherwise.</p> Returns `string` A CAPTCHA string.
`public array`	# `formatCategoryTree( array $forums )` Formats a list of forums, showing each child of a parent with appropriate indent using '.. ' as a leader. Formats a list of forums, showing each child of a parent with appropriate indent using '.. ' as a leader. Parameters `$forums` The list of forums to format. Returns `array` Formatted forum list.
`public string`	# `getSortBy( string $view )` Returns the column to sort by, checking first if it is specified in the URL, then returning the value stored in prefs. Returns the column to sort by, checking first if it is specified in the URL, then returning the value stored in prefs. Parameters `$view` <p>The view name, used to identify preference settings for sorting.</p> Returns `string` The column to sort by.
`public integer`	# `getSortDir( string $view )` Returns the sort direction, checking first if it is specified in the URL, then returning the value stored in prefs. Returns the sort direction, checking first if it is specified in the URL, then returning the value stored in prefs. Parameters `$view` <p>The view name, used to identify preference settings for sorting.</p> Returns `integer` The sort direction, 0 = ascending, 1 = descending.
`public array`	# `formatColumnHeaders( array $columns, string $sort_by, string $sort_dir, string $view )` Formats column headers have sort links and sort arrows. Formats column headers have sort links and sort arrows. Parameters `$columns` The columns to format. `$sort_by` The current 'sort-by' column. `$sort_dir` The current sort direction. `$view` <p>The view name, used to identify preference settings for sorting.</p> Returns `array` The formated column headers to be displayed.
`public VFS`	# `getVFS( )` Returns a VFS instance. Returns a VFS instance. Returns `VFS` A VFS instance.
`public`	# `validateAvatar( mixed $avatar_path )`
`public`	# `getAvatarUrl( mixed $avatar_path, mixed $scopeend_sid = true )`
`public`	# `distribute( integer $message_id )` Send new posts to a distribution email address for a wider audience Send new posts to a distribution email address for a wider audience Parameters `$message_id` Identifier of message to be distributed Throws Horde_Mime_Exception

Constants summary
`string`	`VFS_PATH` The virtual path to use for VFS data. The virtual path to use for VFS data.	# `'.horde/agora/attachments/'`
`string`	`AVATAR_PATH`	# `'.horde/agora/avatars/'`

Packages

Classes

Class Agora

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Throws