Documentation

IMP_Ftree_Select
in package

Generate a select form HTML input tag.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2013-2017 Horde LLC

license

http://www.horde.org/licenses/gpl GPL

Table of Contents

Properties

$_tree  : Horde_Tree
Generated tree.

Methods

__construct()  : mixed
Constructor.
__toString()  : string
The string tree representation.

Properties

$_tree

Generated tree.

protected Horde_Tree $_tree

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $opts = array() ]) : mixed
Parameters
$opts : array<string|int, mixed> = array()

Optional parameters:

  • abbrev: (boolean) Abbreviate long mailbox names by replacing the middle of the name with '...'? DEFAULT: Yes
  • basename: (boolean) Use raw basename instead of abbreviated label? DEFAULT: false
  • heading: (string) The label for an empty-value option at the top of the list. DEFAULT: ''
  • inc_notepads: (boolean) Include user's editable notepads in list? DEFAULT: No
  • inc_tasklists: (boolean) Include user's editable tasklists in list? DEFAULT: No
  • inc_vfolder: (boolean) Include user's virtual folders in list? DEFAULT: No
  • iterator: (Iterator) Tree iterator to use.
  • new_mbox: (boolean) Display an option to create a new mailbox? DEFAULT: No
  • optgroup: (boolean) Whether to use elements to group mailbox types. DEFAULT: false
  • selected: (string) The mailbox to have selected by default. DEFAULT: None

__toString()

The string tree representation.

public __toString() : string

NOTE: The <select> and </select> tags are NOT included in the output.

Return values
string

A string containing


        
On this page

Search results