PntSqlSpec Class Reference

Inherits PntObject.

Inherited by PntSqlFilter, and PntSqlSort.

Public Member Functions
	__construct ($id=null)
	getId ()
	getLabel ()
	getQueryHandler ()
	getDescription ($conv)
	setDescription ($value)
	getSqlForJoin ()
	generateSqlForJoins (&$aliasCount, &$paramCount, $backTrack=array())
	isJoinFilter ()
	where ($path, $comparatorId=null, $value1=null, $value2=null)
	sortBy ($path, $direction='ASC')
	retrieve ()
	retrieveFirst ()
	retrieveOne ()
Public Member Functions inherited from PntObject
	__construct ()
	copy ()
	getClass ()
	getClassDescriptor ()
	initPropertyDescriptors ()
	getOid ()
	addFieldProp ($name, $type, $readOnly=false, $minValue=null, $maxValue=null, $minLength=0, $maxLength=null, $classDir=null, $persistent=true)
	addDerivedProp ($name, $type, $readOnly=true, $minValue=null, $maxValue=null, $minLength=0, $maxLength=null, $classDir=null)
	addMultiValueProp ($name, $type, $readOnly=true, $minValue=null, $maxValue=null, $minLength=0, $maxLength=null, $classDir=null)
	getPropertyDescriptor ($propertyName)
	get ($propertyName, $filter=true)
	set ($propertyName, $value)
	getOptions ($name, $filter=true)
	getValueValidator ($prop)
	validateGetErrorString ($prop, $value, $validateReadOnly=true)
	basicGetLabel ()
	getLabel ()
	__toString ()
	release ()
	getEditInfo ()
	toString ()
	_getValueValidator ($prop)

Static Public Member Functions
	initPropertyDescriptors ()
Static Public Member Functions inherited from PntObject
static	isPersistent ()
static	getClassDescriptorClass ()
static	getClassDir ()
static	getClassLabel ()
static	getUiColumnPaths ()
static	getReportColumnPaths ()
static	getUiFieldPaths ($clsDes)
static	newNavigation ($key, $itemType)

Data Fields
	$label
	$propLabel
	$itemType

Constructor & Destructor Documentation

__construct

(

$id = null

)

Member Function Documentation

generateSqlForJoins	(	&	$aliasCount,
		&	$paramCount,
			$backTrack = array()
	)

getDescription

(

$conv

)

getId

(

)

getLabel

(

)

getQueryHandler

(

)

getSqlForJoin

(

)

Return a piece of SQL for extending the FROM clause with the tables to be joined

initPropertyDescriptors ( )

static

Returns

String the name of the database table the instances are stored in - override for each subclass

isJoinFilter

(

)

retrieve

(

)

retrieves specified peanuts,

Returns

array of PntObject of >>itemType

Exceptions

PntEror

if a database error occurs

retrieveFirst

(

)

retrieves specified peanuts,

Returns

PntObject of >>itemType first peanut or null

Exceptions

PntEror

if a database error occurs

retrieveOne

(

)

retrieves specified peanuts,

Returns

PntObject of >>itemType a single peanut or null

Exceptions

PntError

if if more then one peanut was retrieved, or if a database error occurred

setDescription

(

$value

)

sortBy	(		$path,
			$direction = 'ASC'
	)

(Navigational query DSL)

Parameters

string	$path	the path to sort by
string	$direction	'ASC' or 'DESC'

Returns

PntSqlSort for sorting the results of this

Exceptions

PntReflectionError

if the path does not exist from >>itemType

where	(		$path,
			$comparatorId = null,
			$value1 = null,
			$value2 = null
	)

(Navigational query DSL)

Returns

the specified PntSqlFilter for >>itemType

Parameters

string	$path	the path to filter by
string	$comparatorId	one id from PntComparator::getInstances
mixed	$value1	dynamically typed by >>valueType
mixed	$value2	dynamically typed by >>valueType

Returns

PntSqlFilter $this

Exceptions

PntReflectionError

Field Documentation

$itemType

$label

$propLabel

---

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

• upload/classes/pnt/db/query/classPntSqlSpec.php