StringSearchParameterHandler is a SearchParameterHandler for text database types. More...

Inheritance diagram for StringSearchParameterHandler:

Collaboration diagram for StringSearchParameterHandler:

Public Member Functions
	equal ($name, $value)
	Generates the constraint expression for equality matching parameters. 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...

	any ($name, $value)
	Generate the constraint expression for matching any word in a group of words. More...

	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...

	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
	checked ($name, $value)
	Generate the constraint expresssion for matching boolean only when the UI element is selected. More...

Detailed Description

StringSearchParameterHandler is a SearchParameterHandler for text database types.

Author: andy

Definition at line 273 of file search_form.inc.

Member Function Documentation

◆ all()

StringSearchParameterHandler::all	(	$name,
		$value
	)

Generate the constraint expression for matching all words in a group of words but allowing other words in between.

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 334 of file search_form.inc.

      {
           $value = preg_replace("/\\s+/", " ", $value);
           
           $words = explode(" ", $value);
                
           if (count($words) == 0) return;
                               
           $query .= " (";
           $first = true;
           foreach($words as $word)
           {
                $txt = ConnectionManager::quote("%{$word}%");
                if (!$first) $query .= " AND ";
                $query .= "$name LIKE $txt";
                $first = false;
           }
           $query .= ")"; 
           
           return $query;
      }

◆ any()

StringSearchParameterHandler::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 313 of file search_form.inc.

      {
           $value = preg_replace("/\\s+/", " ", $value);
           $words = explode(" ", $value);
           
           if (count($words) == 0) return;
                     
           $query .= " (";
           $first = true;
           foreach($words as $word)
           {
                $txt = ConnectionManager::quote("%{$word}%");
                if (!$first) $query .= " OR ";
                $query .= "$name LIKE $txt";
                $first = false;
           }
           $query .= ")"; 
           
           return $query;
      }

◆ equal()

StringSearchParameterHandler::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 275 of file search_form.inc.

      {
           $txt = ConnectionManager::quote($value);
           return "$name=$txt";
      }

◆ from()

StringSearchParameterHandler::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 293 of file search_form.inc.

      {
           $txt = ConnectionManager::quote($from);
           return "$name >= $txt";
      }

◆ fullName()

StringSearchParameterHandler::fullName	(	$f_name,
		$l_name,
		$value
	)

Generate the constraint expression for matching the f_name and l_name fields to a given value.

Parameters

string	$f_name	the name of the first name field
string	$l_name	the name of the last name field
string	$value	a string that may contain multiple words

Returns: string a SQL expression to perform the match

Reimplemented from SearchParameterHandler.

Definition at line 357 of file search_form.inc.

      {
           $value = preg_replace("/\\s+/", " ", $value);
           $words = explode(" ", $value);
           
           if(count($words) < 2) return;
           
           $idx = 0;
           $query = " (";
           $first = true;
                
           while($idx < count($words)-1)
           {
                if (!$first) $query .= " OR (";
                          
                $txt1 = ConnectionManager::quote("%{$words[$idx]}%");
                $txt2 = ConnectionManager::quote("%{$words[$idx+1]}%"); 
                $query .= "{$f_name} LIKE $txt1 AND {$l_name} LIKE $txt2";
  
                $idx += 1;
                $query .= ") ";
                $first = false;
           }
  
           return $query;
      }    

◆ like()

StringSearchParameterHandler::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 281 of file search_form.inc.

      {
           $txt = ConnectionManager::quote("%{$value}%");
           return "$name LIKE $txt";
      }

◆ member()

StringSearchParameterHandler::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 389 of file search_form.inc.

      {
           trace("## STRINGSEARCHPARAMETERHANDLER", 1);
           if(!$set || !isset($set)) return "";
           
           $values = $set;
           if(is_array($set))
           {
                $values = "'". implode("','", array_keys($set)) . "'";
           }
           else if($set)
           {
                $values = "'".implode("','", explode(",", $set))."'";
                $values = preg_replace("/''/", "'", $values);
           }
      
           return "$name IN ($values)";
      }

◆ range()

StringSearchParameterHandler::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 305 of file search_form.inc.

      {
           $from = ConnectionManager::quote($from);
           $to = ConnectionManager::quote($to);
           
           return "($name >= $from AND $name <= $to)";
      }

◆ startsWith()

StringSearchParameterHandler::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 287 of file search_form.inc.

      {
           $txt = ConnectionManager::quote("{$value}%");
           return "$name LIKE $txt";
      }

◆ to()

StringSearchParameterHandler::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 299 of file search_form.inc.

      {
           $txt = ConnectionManager::quote($to);
           return "$name <= $txt";
      }

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

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ all()

◆ any()

◆ equal()

◆ from()

◆ fullName()

◆ like()

◆ member()

◆ range()

◆ startsWith()

◆ to()