Overview

Packages

  • None
  • Trean

Classes

  • DataTreeObject_Folder
  • SearchForm
  • Trean
  • Trean_Bookmark
  • Trean_Bookmarks
  • Overview
  • Package
  • Class
  • Tree

Class Trean

Trean Base Class.

$Horde: trean/lib/Trean.php,v 1.93 2009-11-29 15:51:42 chuck Exp $

Copyright 2002-2012 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (BSD). If you did not did not receive this file, see http://www.horde.org/licenses/bsdl.php.

Package: Trean
Author: Mike Cochrane mike@graftonhall.co.nz
Located at Trean.php
Methods summary
public static
# initialize( )
public
# getDb( )
public array
# listFolders( mixed $perm = Horde_Perms::SHOW, mixed $parent = null, mixed $allLevels = true )

List folders.

List folders.

Returns

array
A list of folders.
public integer
# countFolders( integer $perm = Horde_Perms::SHOW )

Counts the number of current user's folders list from storage.

Counts the number of current user's folders list from storage.

Parameters

$perm
<p>The level of permissions to require for a folder to return it.</p>

Returns

integer
The number of matching folders.
public string
# folderSelect( string $selected = null, mixed $perm = Horde_Perms::SHOW, mixed $new = false )

Generates the body of a <select> form input to select a folder. The <select> and </select> tags are NOT included in the output of this function.

Generates the body of a <select> form input to select a folder. The <select> and </select> tags are NOT included in the output of this function.

Parameters

$selected
<p>The folder to have selected by default. Defaults to the first option in the list.</p>
$perm
$new

Returns

string

A string containing

public
# sortOrder( mixed $sortby )
public mixed
# hasPermission( string $permission )

Returns the specified permission for the current user.

Returns the specified permission for the current user.

Parameters

$permission
<p>A permission, currently only 'max_folders' and 'max_bookmarks'.</p>

Returns

mixed
The value of the specified permission.
public
# HTTPStatus( mixed $status_code )

Returns the "Reason Phrase" associated with the given HTTP status code according to rfc2616.

Returns the "Reason Phrase" associated with the given HTTP status code according to rfc2616.

public
# getFavicon( mixed $bookmark )

Returns an apropriate icon for the given bookmark.

Returns an apropriate icon for the given bookmark.

API documentation generated by ApiGen