Tuskfish API V1.1.1
  • Package
  • Class

Packages

  • content
  • core
  • database
  • installation
  • security
  • user
  • utilities

Classes

  • TfCriteria
  • TfCriteriaFactory
  • TfCriteriaItem
  • TfDatabase

Class TfCriteriaFactory

Factory for instantiating TfCriteria objects and injecting dependencies.

Use this class to delegate construction of TfCriteria objects. See the Tuskfish Developer Guide for a full explanation and examples.

Package: database
Copyright: Simon Wilkinson 2013+ (https://tuskfish.biz)
License: GNU General Public License (GPL) V2
Author: Simon Wilkinson simon@isengard.biz
Version: Release: 1.0
Since: 1.1
Var: TfValidator $validator Instance of the Tuskfish data validator class.
Located at trust_path/libraries/tuskfish/class/TfCriteriaFactory.php

Methods summary

public
# __construct( TfValidator $validator )

Constructor.

Constructor.

Parameters

$validator
An instance of the Tuskfish data validator class.
public TfCriteria
# getCriteria( )

Factory method to instantiate and return a TfCriteria object.

Factory method to instantiate and return a TfCriteria object.

Returns

TfCriteria
Instance of a TfCriteria object.
public TfCriteriaItem
# getItem( string $column, mixed $value, string $operator = '=' )

Factory method to instantiate and return a TfCriteriaItem object.

Factory method to instantiate and return a TfCriteriaItem object.

Parameters

$column

Name of column in database table. Alphanumeric and underscore characters only.

$value
Value of the column.
$operator

See TfishCriteriaItem::getListOfPermittedOperators() for a list of acceptable operators.

Returns

TfCriteriaItem

Properties summary

protected $validator
#
Tuskfish API V1.1.1 API documentation generated by ApiGen