Documentation

Search box configuration parameters

Parameter

Rel

Description

description

1.0.0

field description to use in query form

fieldname

1.0.0

mysql field name. It is case sensitive

type

1.0.0

A=alphabetic, N=Numeric

size

1.0.0

field size for padding. Used for type A

padding

1.0.0

Request the padding for the field (none, left, right) default: none. Ignored if field type = N

paddingchar

1.0.0

character to pad the field. Ignored if field type = N

useregex

1.0.0

use regex to match the field contents against the requested string. It is used for type A field, and if true the module don't pad the field. Values 1=use regex, 0=don't use regex. Optional, default: 0

fieldclass

2.1.0

Class to use to manage the input box. Available classes are: CYap_clsSearchDate, CYap_clsSearchRangeTxt, CYap_clsSearchRegexOpt, CYap_clsSearchSelectBox, and CYap_clsSearchTxt. Default: CYap_clsSearchTxt

viewclass

2.1.0

Class to use to write the HTML code for the field object. It keeps away the HTML code from the logic of the filter form, so you may customize easily the form appearance. By default, each field class has it own view. The relationship is:

CYap_clsSearchDate

CYap_ViewDate

CYap_clsSearchRangeTxt

CYap_ViewTextRange

CYap_clsSearchRegexOpt

CYap_ViewOptRegex

CYap_clsSearchSelectBox

CYap_SelectBox

CYap_clsSearchTxt

CYap_ViewTextBox

optionlist

2.1.0

Used only if fieldclass is set to CYap_clsSearchSelectBox. Array of available option The index is the value returned by the form and used to build the filter condition. The value is the text shown to the user as option.

showformat

2.1.0

Used only if fieldclass is set to CYap_clsSearchDate. How the date is shown to the user and entered by the user. Available formats: d/m/Y, d-m-Y, m/d/Y, and m-d-Y.

whereformat

2.1.0

Used only if fieldclass is set to CYap_clsSearchDate. Date format to use to build the filter to look for. It accepts all formats recognized by PHP date command.

layoutclass

2.1.0

Class used to place the input box on the form. The avilable classes are

CYap_clsSearchLayout

(default) One column layout.

CYAP_cls2ColumnLayout

Two column layout.