API Documentation

Zend/Db/Table/Select.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Db  
Subpackage
Select  
Version
$Id: Select.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Db_Table_Select

Package: Zend\Db\Table

Class for SQL SELECT query manipulation for the Zend_Db_Table component.

Parent(s)
\Zend_Db_Select
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedarray  $_info= ''

Table schema for parent Zend_Db_Table.

Details
Type
array
Propertyprotectedarray  $_integrityCheck= 'true'

Table integrity override.

Default valuetrueDetails
Type
array
Propertyprotected\Zend_Db_Table_Abstract  $_table= ''

Table instance that created this select object

Methods

methodpublic__construct(  $table ) : void

Class constructor

Parameters
Name Type Description
$table
methodpublicassemble( ) : string|null

Performs a validation on the select query before passing back to the parent class.

Ensures that only columns from the primary Zend_Db_Table are returned in the result.

Returns
Type Description
string|null This object as a SELECT string (or null if a string cannot be produced)
methodpublicfrom( array|string|\Zend_Db_Expr|\Zend_Db_Table_Abstract $name, array|string|\Zend_Db_Expr $cols = self::SQL_WILDCARD, string $schema = null ) : \Zend_Db_Table_Select

Adds a FROM table and optional columns to the query.

The table name can be expressed

Parameters
Name Type Description
$name array|string|\Zend_Db_Expr|\Zend_Db_Table_Abstract

The table name or an associative array relating table name to correlation name.

$cols array|string|\Zend_Db_Expr

The columns to select from this table.

$schema string

The schema name to specify, if any.

Returns
Type Description
\Zend_Db_Table_Select This Zend_Db_Table_Select object.
methodpublicgetTable( ) : \Zend_Db_Table_Abstract

Return the table that created this select object

Returns
Type Description
\Zend_Db_Table_Abstract
methodpublicisReadOnly( ) : boolean

Tests query to determine if expressions or aliases columns exist.

Returns
Type Description
boolean
methodpublicsetIntegrityCheck(  $flag = true ) : \Zend_Db_Select

Sets the integrity check flag.

Setting this flag to false skips the checks for table joins, allowing 'hybrid' table rows to be created.

Parameters
Name Type Description
$flag
Returns
Type Description
\Zend_Db_Select This Zend_Db_Select object.
methodpublicsetTable(  $table ) : \Zend_Db_Select

Sets the primary table name and retrieves the table schema.

Parameters
Name Type Description
$table
Returns
Type Description
\Zend_Db_Select This Zend_Db_Select object.
Documentation was generated by DocBlox 0.15.1.