The SearchParameters class interprets the set of input parameters for a search and generates the corresponding SQL constraints to perform the search against the database. More...

Public Member Functions
	__sleep ()

	copy ($src)

	SearchParameters ($target, $form=null)

	get ($field, $mode=null)

	setHandler ($field, $handler)
	Override default handling by setting a custom callback to generate the constraint for a field. More...

	fromArray ($array)

	setParam ($fieldname, $mode, $value)

	clearParam ($field)
	Clear any parameters set for the specified field. More...

	set ($field, $mode, $value)

	fromGET ()

	fromPOST ()

	remapField ($old, $new)

	copyField ($old, $new)

	secondaryFields ($src)
	Specifies additional data fields to search when querying for the given source field. More...

	toQueryString ()

	generateConstraint ($first=true, $firstText="WHERE")
	generateConstraint More...

	getClause ($handler, $modifier, $field, $value)

	_getClause ($handler, $modifier, $field, $value)

Static Public Member Functions
static	joinClauses (&$first, $clause, $joinWith="AND", $firstText)
	joinClauses More...

static	closeClause (&$constraint, $firstText)

Public Attributes
	$form

	$target

	$params

	$handlers

	$joinWith = "AND"

	$paramHandlers = array()

	$secondaryFields = array()

	$additional = array()

	$empty = true
	true if no search parameters were specified, false if any parameter was found More...

Detailed Description

The SearchParameters class interprets the set of input parameters for a search and generates the corresponding SQL constraints to perform the search against the database.

Author: andy

Definition at line 556 of file search_form.inc.

Member Function Documentation

◆ __sleep()

SearchParameters::__sleep ( )

Definition at line 569 of file search_form.inc.

      {
           return SearchParameters::$serializedFields;
      }

◆ _getClause()

SearchParameters::_getClause	(	$handler,
		$modifier,
		$field,
		$value
	)

Definition at line 894 of file search_form.inc.

      {
           $clause = "";
                
           switch($modifier)
           {
                case "equal":
  
                     $clause = $handler->equal($field, $value);
                     break;
                     
                case "like":
                     
                     $clause = $handler->like($field, $value);
                     break;
                     
                case "startsWith":
                     
                     $clause = $handler->startsWith($field, $value);
                     break;                   
                     
                case "from":
  
                     if (array_key_exists("{$field}:to", $this->params))
                     {
                          trace("date range", 3);
                     }
                     else
                     {
                          $clause = $handler->from($field, $value);
                     }
                     break;
                     
                case "to":
                     
                     $clause = $handler->to($field, $value);
                     break;
                
                case "range":
                     
                     $param = $this->params[$field];
                     $clause = $handler->range($field, $param->from, $param->to);
                     break;
                     
                case "member":
                     
                     $clause = $handler->member($field, $value);
                     break;
  
                case "any":
                     
                     $clause = $handler->any($field, $value);
                     break;                   
  
                case "all":
                     
                     $clause = $handler->all($field, $value);
                     break;
                     
                case "fullName":
                     
                     $clause = $handler->fullName($field, $value);
                     break;
                     
                case "checked":
                     
                     $clause = $handler->checked($field, $value);
                     break;
                     
                default:
                     break;
                
           } // end case statement
           
           return $clause;
      }    

◆ clearParam()

SearchParameters::clearParam ( $field )

Clear any parameters set for the specified field.

Parameters

string $field the name of the field

Definition at line 733 of file search_form.inc.

      {
           foreach($this->params as $name => $value)
           {
                list($f, $mode) = explode(":", $name);
                if ($f == $field) unset($this->params["$f:$mode"]);
           }
      }

◆ closeClause()

static SearchParameters::closeClause	(	&	$constraint,
			$firstText
	)

static

Definition at line 1001 of file search_form.inc.

      {
           /*
            * If no clauses were created, remove the
            * $firstText if "AND (" or "OR (".
            * Close out an opened group of clauses, by
            * adding the ")";
            */
           if($constraint == "") return;
           
           if(strpos($firstText, "(") !== false)
           {
                $constraint .= ") ";
           }
      }

◆ copy()

SearchParameters::copy ( $src )

Definition at line 574 of file search_form.inc.

      {
           $this->params = $src->params;
           foreach(SearchParameters::$serializedFields as $field)
           {
                $this->$field = $src->$field;
           }
      }

◆ copyField()

SearchParameters::copyField	(	$old,
		$new
	)

Definition at line 770 of file search_form.inc.

      {
           $this->params[$new] = $this->params[$old];
      }

◆ fromArray()

SearchParameters::fromArray ( $array )

Definition at line 649 of file search_form.inc.

      {
           $this->empty = true;
           $this->isDefaultState = true;
           
           $fields = array_keys($this->target->getFields());
           foreach($array as $field => $value)
           {
                list($fieldname, $mode) = explode(":", $field);
  
                $skip = false;
                
                if ($this->target->filter && $this->target->filter->isExcluded($fieldname))
                {
                     trace("## Skipping $fieldname", 4);
                     continue;
                }
                
                if (!$this->target->hasField($fieldname) &&
                     (!$this->form || !$this->form->hasAdditional($fieldname))) 
                {
                     trace("### Skipping $fieldname", 4);
                     continue;
                }
           
                $this->isDefaultState = false;
                //if (!$mode) continue;
                if ($value != "")
                {
                     $this->empty = false;
                     
                     $this->setParam($fieldname, $mode, $value);
                }
           }
      }

◆ fromGET()

SearchParameters::fromGET ( )

Definition at line 747 of file search_form.inc.

      {
           $this->fromArray($_GET);
      }

◆ fromPOST()

SearchParameters::fromPOST ( )

Definition at line 752 of file search_form.inc.

      {
           $this->fromArray($_POST);
      }

◆ generateConstraint()

SearchParameters::generateConstraint	(	$first = `true`,
		$firstText = `"WHERE"`
	)

generateConstraint

@first: whether this set of clauses is the first in a group

@firstText: the text is this is the first clause: either WHERE or AND (

Definition at line 820 of file search_form.inc.

      {
           $constraint = "";
                          
           trace(print_r($this->params, true), 3);
           
           foreach($this->params as $field => $param)
           {
                $joinWith = (!$first) ? $this->joinWith : "";
                 
                $modifier = $param->mode;
                $value = $param->value;
                
 //             if (strpos($param, ':') > 0)
 //             {
 //                  list($field, $modifier) = explode(":", $param);
 //             }
 //             else
 //             {
 //                  $field = $param;
 //                  $modifier = "equal";
 //             }
                
                // JDG 10/25/2011 - allow callback function for clauses
                if(!array_key_exists($field, $this->paramHandlers))
                {
                     $fields = $this->target->getFields();
                     $handler = $this->handlers[$fields[$field]];
                     
                     //AJG: Default to String if field type is not known
                     if (!$handler) $handler = new StringSearchParameterHandler();
                     $clause = $this->getClause($handler, $modifier, $field, $value);           
                }
                else
                {
                     $handler = $this->paramHandlers[$field];
                     
                     if(is_callable($handler))
                          $clause = call_user_func($handler, $field, $value);
                     elseif(method_exists($handler, $modifier))
                          $clause = $handler->$modifier($field, $value);
                }
      
                $constraint .= $this->joinClauses($first, $clause, $joinWith, $firstText);
           }
           
           $this->closeClause($constraint, $firstText);
           
           return $constraint;
      }

◆ get()

SearchParameters::get	(	$field,
		$mode = `null`
	)

Definition at line 601 of file search_form.inc.

      {
           if (!isset($this->params[$field])) return null;
           
           $val = $this->params[$field];
           if ($val->mode == "range")
           {
                if ($mode == "from")
                {
                     $value = $val->from;
                }
                else if ($mode == "to")
                {
                     $value = $val->to;
                }
                else return null;
           }
           else
           {
                if ($mode !== null && $val->mode != $mode) return null;
           }
           
           $value = $val->value;
           trace("SearchParameters::get({$field}:$mode): $value", 3);
           return $value;
      }

◆ getClause()

SearchParameters::getClause	(	$handler,
		$modifier,
		$field,
		$value
	)

Definition at line 871 of file search_form.inc.

      {
           $clause = array();
  
           $clause[] = $this->_getClause($handler, $modifier, $field, $value);
           
           if (isset($this->secondaryFields[$field]))        
           {
                $secondaries = $this->secondaryFields[$field];
  
                foreach($secondaries as $secondary)
                {
                     $clause[] = $this->_getClause($handler, $modifier, $secondary, $value);
                }
                
                return "(".implode(" OR ", $clause).") ";
           }
           else
           {
                return $clause[0];
           }         
      }

◆ joinClauses()

static SearchParameters::joinClauses	(	&	$first,
			$clause,
			$joinWith = `"AND"`,
			$firstText
	)

static

joinClauses

@first: whether this is the first clause; if so start with "WHERE"

@clause: the statement, e.g., l_name like 'smith'

@joinWith: specify is statement is to be joined with OR or AND

@firstText: the text to output if first: WHERE or "" - clause may be first in a group "(" rather than first of all clauses.

Definition at line 983 of file search_form.inc.

      {
           if ($clause != "")
           {
                if ($first)
                {
                     $constraint = "{$firstText} $clause";
                     $first = false;
                }
                else
                {
                     $constraint .= " $joinWith $clause";
                }
           }
  
           return $constraint;
      }

◆ remapField()

SearchParameters::remapField	(	$old,
		$new
	)

Definition at line 757 of file search_form.inc.

      {
           foreach($this->params as $key => $value)
           {
                list($field, $mode) = explode(":", $key);
                if ($field == $old)
                {
                     $this->params["$new:$mode"] = $value;
                     unset($this->params["$old:$mode"]);
                }
           }
      }

◆ SearchParameters()

SearchParameters::SearchParameters	(	$target,
		$form = `null`
	)

Definition at line 583 of file search_form.inc.

      {
           $this->target = $target;
           $this->form = $form;
           $this->params = array();
           
           $this->handlers = array();
  
           $this->handlers[String]  = new StringSearchParameterHandler();
           $this->handlers[HTML]         = new StringSearchParameterHandler();
           $this->handlers[Date]         = new DateSearchParameterHandler();
           $this->handlers[DateTime]     = new DateSearchParameterHandler();
           $this->handlers[Timestamp]    = new DateSearchParameterHandler();
           $this->handlers[Number]       = new NumberSearchParameterHandler();
           $this->handlers[Currency]     = new NumberSearchParameterHandler();
           $this->handlers[Boolean] = new BooleanSearchParameterHandler();       
      }

◆ secondaryFields()

SearchParameters::secondaryFields ( $src )

Specifies additional data fields to search when querying for the given source field.

Parameters

string	$src	name of the primary field
	[string]	the list of additional fields to search

Definition at line 781 of file search_form.inc.

      {
           if (!isset($this->secondaryFields[$src]))
           {
                $this->secondaryFields[$src] = array();
           }
  
           for($i = 1; $i < func_num_args(); ++$i)
           {
                $this->secondaryFields[$src][] = func_get_arg($i);
           }              
      }

◆ set()

SearchParameters::set	(	$field,
		$mode,
		$value
	)

Definition at line 742 of file search_form.inc.

      {
           $this->setParam($field, $mode, $value);
      }

◆ setHandler()

SearchParameters::setHandler	(	$field,
		$handler
	)

Override default handling by setting a custom callback to generate the constraint for a field.

Parameters

$field - the field name in the obj to be queried

@handler - callback function such as array(MyClass, MyFunction)

When the function is called, it is given the parameters $name and $value

Definition at line 640 of file search_form.inc.

      {
           $this->paramHandlers[$field] = $handler;     
           if (!$this->target->hasField($field))
           {
                $this->additional[] = $field;
           }    
      }

◆ setParam()

SearchParameters::setParam	(	$fieldname,
		$mode,
		$value
	)

Definition at line 689 of file search_form.inc.

      {
           if (is_array($value)) $value = implode(",", array_values($value));
           
           if (isset($this->params[$fieldname]))
           {
                $p = $this->params[$fieldname];
                if ($mode)
                {
                     if ($mode == "from" && $p->mode == "to")
                     {
                          $p->mode = "range";
                          $p->to = $p->value;
                          $p->from = $value;
                          $p->value = null;
                     }
                     else if ($mode == "to" && $p->mode == "from")
                     {
                          $p->mode = "range";
                          $p->to = $value;
                          $p->from = $p->value;
                          $p->value = null;
                     }
                     else
                     {
                          $p->mode = $mode;
                          $p->value = $value;
                     }
                }
                else
                {
                     $p->value = $value;
                }
           }
           else
           {
                $this->params[$fieldname] = new SearchParameterValue($mode, $value);
           }
      }

◆ toQueryString()

SearchParameters::toQueryString ( )

Definition at line 794 of file search_form.inc.

      {
           $qs = "";
           
           foreach($this->params as $name => $value)
           {
                if ($value == "") continue;
                
                $qs .= ($qs == "") ? "?" : "&";
                
                $qs .= urlencode($name);
                $qs .= "=";
                $qs .= urlencode($value);     
           }
           
           return $qs;
      }

Member Data Documentation

◆ $additional

SearchParameters::$additional = array()

Definition at line 565 of file search_form.inc.

◆ $empty

SearchParameters::$empty = true

true if no search parameters were specified, false if any parameter was found

Definition at line 566 of file search_form.inc.

◆ $form

SearchParameters::$form

Definition at line 558 of file search_form.inc.

◆ $handlers

SearchParameters::$handlers

Definition at line 561 of file search_form.inc.

◆ $joinWith

SearchParameters::$joinWith = "AND"

Definition at line 562 of file search_form.inc.

◆ $paramHandlers

SearchParameters::$paramHandlers = array()

Definition at line 563 of file search_form.inc.

◆ $params

SearchParameters::$params

Definition at line 560 of file search_form.inc.

◆ $secondaryFields

SearchParameters::$secondaryFields = array()

Definition at line 564 of file search_form.inc.

◆ $target

SearchParameters::$target

Definition at line 559 of file search_form.inc.

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ __sleep()

◆ _getClause()

◆ clearParam()

◆ closeClause()

◆ copy()

◆ copyField()

◆ fromArray()

◆ fromGET()

◆ fromPOST()

◆ generateConstraint()

◆ get()

◆ getClause()

◆ joinClauses()

◆ remapField()

◆ SearchParameters()

◆ secondaryFields()

◆ set()

◆ setHandler()

◆ setParam()

◆ toQueryString()

Member Data Documentation

◆ $additional

◆ $empty

◆ $form

◆ $handlers

◆ $joinWith

◆ $paramHandlers

◆ $params

◆ $secondaryFields

◆ $target