apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: HTML_QuickForm_SelectFilter

Source Location: /HTML_QuickForm_SelectFilter-1.0.0RC1/SelectFilter.php

Class Overview

HTML_QuickForm_text
   |
   --HTML_QuickForm_SelectFilter

Class to dynamically create a filter for an HTML SELECT


Author(s):

Version:

  • 1.0

Methods


Inherited Variables

Inherited Methods


Class Details

[line 32]
Class to dynamically create a filter for an HTML SELECT
  • Author: Nicolas Hoizey <nicolas@hoizey.com>
  • Version: 1.0
  • Since: PHP4.04pl1
  • Access: public


[ Top ]


Method Detail

HTML_QuickForm_SelectFilter (Constructor)   [line 63]

void HTML_QuickForm_SelectFilter( [string $elementName = null], [string $elementLabel = null], [mixed $attributes = null], [string $selectName = null], [boolean $mustBeginWith = false])

Class constructor
  • Since: 1.0
  • Access: public

Parameters:

string   $elementName   —  (optional)Input field name attribute
string   $elementLabel   —  (optional)Input field label
mixed   $attributes   —  (optional)Either a typical HTML attribute string or an associative array
string   $selectName   —  (optional)Target select field name
boolean   $mustBeginWith   —  (optional)Indicates wether the select must begin with the filtered value or can just contain it

[ Top ]

addSelect   [line 86]

void addSelect( string $selectName, [boolean $mustBeginWith = false])

Adds a select as a target of the filter
  • Since: 1.0
  • Access: public

Parameters:

string   $selectName   —  Target select field name
boolean   $mustBeginWith   —  (optional)Indicates wether the select must begin with the filtered value or can just contain it

[ Top ]

apiVersion   [line 101]

double apiVersion( )

Returns the current API version
  • Since: 1.0
  • Access: public

[ Top ]

toHtml   [line 116]

string toHtml( )

Returns the filter in HTML
  • Since: 1.0
  • Access: public

[ Top ]


Documentation generated on Mon, 11 Mar 2019 13:59:55 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.