Class Xyster_Orm_Query_Report

Description
Description | Vars | Methods (details) Constants (details)

A report query object

  • copyright: Copyright (c) 2007-2008 Irrational Logic (http://irrationallogic.net)
  • license: New BSD License

Located in /Orm/Query/Report.php (line 32) 

Xyster_Orm_Query
   |
   --Xyster_Orm_Query_Report
Class Constant Summary
Description | Constants (details) Vars | | Methods (details)
DISTINCT = 'distinct'
FIELDS = 'fields'
GROUP = 'group'
HAVING = 'having'
Method Summary
Description | Constants (details) Vars | Methods (details)
void distinct ([boolean $distinct = true])
Xyster_Data_Set execute ()
Xyster_Orm_Query_Report field ( $field)
Xyster_Data_Field_Clause getFields ()
Xyster_Data_Field_Clause getGroup ()
array getHaving ()
Xyster_Orm_Query_Report group ( $group)
boolean hasRuntimeFields ()
boolean hasRuntimeGroup ()
Xyster_Orm_Query_Report having ( $having)
boolean isDistinct ()
boolean isRuntime ()
void _initParts ()
Variables
Description | Vars (details) Constants (details) | Methods (details)

Inherited Variables

Inherited from Xyster_Orm_Query

Xyster_Orm_Query::$_backend
 Xyster_Orm_Query::$_class
 Xyster_Orm_Query::$_manager
 Xyster_Orm_Query::$_meta
 Xyster_Orm_Query::$_parts
 Xyster_Orm_Query::$_runtime
Methods
Description | Vars Constants (details) Methods (details)
distinct (line 44)

Turns excluding duplicate records on or off

  • access: public
void distinct ([boolean $distinct = true])
  • boolean $distinct: True excludes duplicates
execute (line 61)

Executes the report query

If the entire query cannot be executed in the backend, this method will return full entities from the data store, put them in the cache, then do any runtime calculations it needs to do.

  • return: The query result set
  • throws: Xyster_Orm_Query_Exception if there's a select column not aggregated or grouped
  • access: public
Xyster_Data_Set execute ()
Redefinition of:
Xyster_Orm_Query::execute()
Executes the query
field (line 177)

Adds a projected field to this query

  • return: provides a fluent interface
  • access: public
Xyster_Orm_Query_Report field ( $field)
getFields (line 195)

Gets the non-group Xyster_Data_Field objects added to the statement

  • access: public
Xyster_Data_Field_Clause getFields ()
getGroup (line 205)

Gets the grouped Xyster_Data_Field objects added to the statement

  • access: public
Xyster_Data_Field_Clause getGroup ()
getHaving (line 215)

Gets the Xyster_Data_Aggregate Xyster_Data_Criterion objects added to the statement

  • access: public
array getHaving ()
group (line 226)

Adds grouped field to this report query

  • return: provides a fluent interface
  • access: public
Xyster_Orm_Query_Report group ( $group)
hasRuntimeFields (line 274)

Gets whether or not this report query has fields that evaluate at runtime

  • access: public
boolean hasRuntimeFields ()
hasRuntimeGroup (line 284)

Gets whether or not this report query has groups that evaluate at runtime

  • access: public
boolean hasRuntimeGroup ()
having (line 246)

Adds a group-criterion to this query

All fields in the criterion must be instances of Xyster_Data_Field_Aggregate, as a "having" clause is applied to groups.

  • return: provides a fluent interface
  • throws: Xyster_Orm_Query_Exception if not all fields are aggregated
  • access: public
Xyster_Orm_Query_Report having ( $having)
isDistinct (line 294)

Gets whether or not to exclude duplicate results

  • access: public
boolean isDistinct ()
isRuntime (line 304)

Gets whether this query has parts that are evaluated at runtime

  • access: public
boolean isRuntime ()
Redefinition of:
Xyster_Orm_Query::isRuntime()
Gets whether this query has parts that are evaluated at runtime
_initParts (line 314)

Inits the parts of the query

  • access: protected
void _initParts ()
Redefinition of:
Xyster_Orm_Query::_initParts()
Initializes the parts container

Inherited Methods

Inherited From Xyster_Orm_Query

Xyster_Orm_Query::__construct()
Xyster_Orm_Query::execute()
Xyster_Orm_Query::getBackendWhere()
Xyster_Orm_Query::getFrom()
Xyster_Orm_Query::getLimit()
Xyster_Orm_Query::getOffset()
Xyster_Orm_Query::getOrder()
Xyster_Orm_Query::getPart()
Xyster_Orm_Query::getWhere()
Xyster_Orm_Query::hasRuntimeOrder()
Xyster_Orm_Query::hasRuntimeWhere()
Xyster_Orm_Query::isRuntime()
Xyster_Orm_Query::limit()
Xyster_Orm_Query::order()
Xyster_Orm_Query::where()
Xyster_Orm_Query::_initParts()
Class Constants
Description | Constants (details) Vars | Methods (details)
DISTINCT = 'distinct' (line 34)
FIELDS = 'fields' (line 35)
GROUP = 'group' (line 36)
HAVING = 'having' (line 37)

Inherited Constants

Inherited from Xyster_Orm_Query

Xyster_Orm_Query::LIMIT
 Xyster_Orm_Query::OFFSET
 Xyster_Orm_Query::ORDER
 Xyster_Orm_Query::WHERE

Documentation generated on Mon, 19 May 2008 17:07:32 -0400 by phpDocumentor 1.4.2