NumberSearchParameterHandler Class Reference

NumberSearchParameterHandler is a SearchParameterHandler for numeric database types. More...

Inheritance diagram for NumberSearchParameterHandler:

Collaboration diagram for NumberSearchParameterHandler:

Public Member Functions
	equal ($name, $value)
	Generates the constraint expression for equality matching parameters. More...
	any ($name, $value)
	Generate the constraint expression for matching any word in a group of words. More...
	like ($name, $value)
	Generates the constraint expression for 'like' matching parameters, i.e. More...
	startsWith ($name, $value)
	Generates the constraint expression for 'startsWith' matching parameters, i.e. More...
	from ($name, $from)
	Generates the constraint expression for 'from' matching parameters, i.e. More...
	to ($name, $to)
	Generates the constraint expression for 'to' matching parameters, i.e. More...
	range ($name, $from, $to)
	Generates the constraint expression for 'range' matching parameters, i.e. More...
	member ($name, $set)
	Generate the constraint expression for set membership matching paramters, matching values in a comma delimite set. More...
Public Member Functions inherited from SearchParameterHandler
	all ($name, $value)
	Generate the constraint expression for matching all words in a group of words but allowing other words in between. More...
	fullName ($f_name, $l_name, $value)
	Generate the constraint expression for matching the f_name and l_name fields to a given value. More...
	checked ($name, $value)
	Generate the constraint expresssion for matching boolean only when the UI element is selected. More...

Detailed Description

NumberSearchParameterHandler is a SearchParameterHandler for numeric database types.

Author

andy

Definition at line 190 of file search_form.inc.

Member Function Documentation

any()

NumberSearchParameterHandler::any	(		$name,
			$value
	)

Generate the constraint expression for matching any word in a group of words.

Parameters

string	$name	the name of the field
string	$value	a string that may contain multiple words

Returns

string a SQL expression to peform the match

Reimplemented from SearchParameterHandler.

Definition at line 199 of file search_form.inc.

     {
          trace("NUMBER: ANY!!!", 3);
 
          if (strpos($value, ",") !== FALSE)
          {
               $value = explode(",", $value);
          }
          
          checkNumeric($value);
          
          if (is_array($value))
          {
               if (count($value) == 0) return "";
               return "$name in (".implode(",", array_values($value)).") ";
          }
          else return "$name=$value";
     }    

equal()

NumberSearchParameterHandler::equal	(		$name,
			$value
	)

Generates the constraint expression for equality matching parameters.

Parameters

string	$name	the name of the field
mixed	$value	the value to match

Returns

string a SQL expression to perform the match

Reimplemented from SearchParameterHandler.

Definition at line 192 of file search_form.inc.

     {
          checkNumeric($value);
          
          return "$name=$value";
     }

from()

NumberSearchParameterHandler::from	(		$name,
			$from
	)

Generates the constraint expression for 'from' matching parameters, i.e.

matching values that are greater than or equal to the specified value.

Parameters

string	$name	the name of the field
mixed	$from	the lower bound

Returns

string a SQL expression to perform the match

Reimplemented from SearchParameterHandler.

Definition at line 228 of file search_form.inc.

     {
          checkNumeric($from);
          return "$name >= $from";
     }

like()

NumberSearchParameterHandler::like	(		$name,
			$value
	)

Generates the constraint expression for 'like' matching parameters, i.e.

matching a substring or partial match.

Parameters

string	$name	the name of the field
mixed	$value	the value to match

Returns

string a SQL expression to perform the match

Reimplemented from SearchParameterHandler.

Definition at line 218 of file search_form.inc.

     {
          die("Inappropriate matching mode");
     }

member()

NumberSearchParameterHandler::member	(		$name,
			$set
	)

Generate the constraint expression for set membership matching paramters, matching values in a comma delimite set.

Parameters

string	$name	the name of the field
string	$set	a comma delimited set of values to match

Returns

string a SQL expression to peform the match

Reimplemented from SearchParameterHandler.

Definition at line 256 of file search_form.inc.

     {
          trace("## NUMBERSEARCHPARAMETERHANDLER", 1);
          
          $values = $set;
          if(is_array($set))
               $values = implode(",", array_keys($set));
          return "$name IN ($set)";
     }

range()

NumberSearchParameterHandler::range	(		$name,
			$from,
			$to
	)

Generates the constraint expression for 'range' matching parameters, i.e.

matching values that within the range of the two specified values.

Parameters

string	$name	the name of the field
string	$from	the lower bound
mixed	$to	the value to match

Returns

string a SQL expression to perform the match

Reimplemented from SearchParameterHandler.

Definition at line 240 of file search_form.inc.

     {
          checkNumeric($from);
          checkNumeric($to);
          
          return "($name >= $from AND $name <= $to)";
     }

startsWith()

NumberSearchParameterHandler::startsWith	(		$name,
			$value
	)

Generates the constraint expression for 'startsWith' matching parameters, i.e.

matching a substring or partial match at the start of the field only.

Parameters

string	$name	the name of the field
string	$value	the value to match

Returns

string a SQL expression to perform the match

Reimplemented from SearchParameterHandler.

Definition at line 223 of file search_form.inc.

     {
          die("Inappropriate matching mode");
     }

to()

NumberSearchParameterHandler::to	(		$name,
			$to
	)

Generates the constraint expression for 'to' matching parameters, i.e.

matching values that are less than or equal to the specified value.

Parameters

string	$name	the name of the field
mixed	$to	the upper bound

Returns

string a SQL expression to perform the match

Reimplemented from SearchParameterHandler.

Definition at line 234 of file search_form.inc.

     {
          checkNumeric($to);
          return "$name <= $to";
     }

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/framework/search_form.inc