Class SearchCriteria

Description

Search criteria are used when fetching a large number of Records but you want to limit those down to ones that only match certain criteria. Criteria could hypothetically be anything imaginable, as long as they can be represented within an SQL query.

  • version: $Id: SearchCriteria.interface.php,v 1.5 2007/04/12 15:37:25 adamfranco Exp $
  • license: GNU General Public License (GPL)
  • copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/dataManager/search/SearchCriteria.interface.php (line 57)


	
			
Direct descendents
Class Description
ActiveRecordsSearch Limits a search to exclude all inactive Records.
FieldValueSearch Searches for only Records that contain a certain field=value pair.
MultipleCriteriaSearch An abstract class on which to build Criteria that are made up of multiple other search criteria objects.
SchemaSearch Limits a search to exclude all other Schemas except the one specified.
Method Summary
array postProcess (array $ids)
string returnSearchString ()
Methods
postProcess (line 72)

Returns an array of new IDs, giving the criteria the opportunity to do post-processing if that is desired. If no post-processing is to be done, it should return what is passed.

  • access: public
array postProcess (array $ids)
  • array $ids: A list of IDs found by searching with the criteria.

Redefined in descendants as:
returnSearchString (line 64)

Returns a string with what will end up part of an SQL query in the WHERE clause.

  • access: public
string returnSearchString ()

Redefined in descendants as:

Documentation generated on Wed, 19 Sep 2007 10:26:20 -0400 by phpDocumentor 1.3.0RC3