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

Class: MantisFilter

Source Location: /core/classes/MantisFilter.class.php

Class Overview


Base class that implements basic filter functionality and integration with MantisBT.


Author(s):

Variables

Methods



Class Details

[line 25]
Base class that implements basic filter functionality and integration with MantisBT.



Tags:

abstract:  


[ Top ]


Class Variables

$default =  null

[line 45]

Default filter value, used for non-list filter types.



Tags:

access:  public

Type:   mixed


[ Top ]

$field =  null

[line 30]

Field name, as used in the form element and processing.



Tags:

access:  public

Type:   mixed


[ Top ]

$size =  null

[line 50]

Form element size, used for non-boolean filter types.



Tags:

access:  public

Type:   mixed


[ Top ]

$title =  null

[line 35]

Filter title, as displayed to the user.



Tags:

access:  public

Type:   mixed


[ Top ]

$type =  null

[line 40]

Filter type, as defined in core/constant_inc.php



Tags:

access:  public

Type:   mixed


[ Top ]



Class Methods


method display [line 76]

string display( multi $p_filter_value)

Display the current value of the filter field.



Tags:

return:  Current value output
abstract:  


Parameters:

multi   $p_filter_value   Filter field input

[ Top ]

method options [line 83]

array options( )

For list type filters, define a keyed-array of possible filter options, not including an 'any' value.



Tags:

return:  Filter options keyed by value=>display
access:  public


[ Top ]

method query [line 69]

array query( multi $p_filter_input)

Build the SQL query elements 'join', 'where', and 'params' as used by core/filter_api.php to create the filter query.



Tags:

return:  Keyed-array with query elements; see developer guide
abstract:  


Parameters:

multi   $p_filter_input   Filter field input

[ Top ]

method validate [line 59]

boolean validate( multi $p_filter_input)

Validate the filter input, returning true if input is valid, or returning false if invalid. Invalid inputs will be replaced with the filter's default value.



Tags:

return:  Input valid (true) or invalid (false)
access:  public


Parameters:

multi   $p_filter_input   Filter field input

[ Top ]


Documentation generated on Sun, 12 Dec 2010 23:50:42 +0900 by phpDocumentor 1.4.3
inserted by FC2 system