Class: CustomSearch

Source Location: /_includes/lib_search.php

Class Overview

SearchField
   |
   --CustomSearch

Describes a search field that uses a custom pattern to construct the sql conditions.

Author(s):

Andreas Launila

Inherited Variables

Class: SearchField

SearchField::$parameter
SearchField::$processCallback
SearchField::$requestName
SearchField::$tableField

Inherited Methods

Class: SearchField

SearchField::__construct(): Constructor for SearchField.
SearchField::getRequestName(): Gets the name of the table field that the search field is connected to.
SearchField::getSqlWhereCondition(): Gets the where condition of the search field. This should be a sql statement that can be placed after "WHERE" in the sql query. A couple of examples: "id > 5", "(solved = 1) AND (tested = 0)".
SearchField::isValid(): Checks if the search field is valid, meaning if it has has caugth a non empty parameter.
SearchField::setParameter(): Sets the parameter for the search done by the field to a new value.

Class Details

[line 555]
Describes a search field that uses a custom pattern to construct the sql conditions.

Tags:

author:

Andreas Launila

[ Top ]

Class Variables

$customPattern =

[line 561]

The custom pattern that should be used when constructing the where conditions.

Tags:

access:

private

Type:

string

[ Top ]

Class Methods

constructor __construct [line 571]

CustomSearch __construct(
mixed
$requestName, string
$customPattern, [mixed
$processCallback = ''])

Constructor for CustomSearch.

Tags:

access:	public
see:	SearchField.searchField($requestName, SearchField::$tableField, $processCallback = '')

Overrides SearchField::__construct() (Constructor for SearchField.)

Parameters:

string

$customPattern

The custom pattern that should be used when searching. All instances of '%p' will be replaced with the search parameter.

[ Top ]

method getSqlWhereCondition [line 579]

void getSqlWhereCondition(
)

Tags:

access:	public
see:	SearchField.getSqlWhereCondition()

Overrides SearchField::getSqlWhereCondition() (Gets the where condition of the search field. This should be a sql statement that can be placed after "WHERE" in the sql query. A couple of examples: "id > 5", "(solved = 1) AND (tested = 0)".)

[ Top ]

Documentation generated on Sun, 16 Apr 2006 21:03:53 +0200 by phpDocumentor 1.3.0RC4