Cloud/DocumentService/Adapter/SimpleDb/Query.php

Show:

inherited

Classes
- \Zend_Cloud_DocumentService_Adapter_SimpleDb_Query

Table of Contents

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_Cloud
Subpackage: DocumentService

\Zend_Cloud_DocumentService_Adapter_SimpleDb_Query
jump to top

Package: Zend\Cloud\DocumentService

Class implementing Query adapter for working with SimpleDb queries in a structured way

Aggregates operations in an array of clauses, where the first element describes the clause type, and the next element describes the criteria.

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

Constants

 
                QUERY_SELECT
                = 'select'

inherited

Known query types

Inherited from: \Zend_Cloud_DocumentService_Query::QUERY_SELECT

Inherited_from: \Zend_Cloud_DocumentService_Query::QUERY_SELECT

 
                QUERY_FROM
                = 'from'

inheritedInherited from: \Zend_Cloud_DocumentService_Query::QUERY_FROM

Inherited_from: \Zend_Cloud_DocumentService_Query::QUERY_FROM

 
                QUERY_WHERE
                = 'where'

inheritedInherited from: \Zend_Cloud_DocumentService_Query::QUERY_WHERE

Inherited_from: \Zend_Cloud_DocumentService_Query::QUERY_WHERE

 
                QUERY_WHEREID
                = 'whereid'

inheritedInherited from: \Zend_Cloud_DocumentService_Query::QUERY_WHEREID

Inherited_from: \Zend_Cloud_DocumentService_Query::QUERY_WHEREID

 
                QUERY_LIMIT
                = 'limit'

inheritedInherited from: \Zend_Cloud_DocumentService_Query::QUERY_LIMIT

Inherited_from: \Zend_Cloud_DocumentService_Query::QUERY_LIMIT

 
                QUERY_ORDER
                = 'order'

inheritedInherited from: \Zend_Cloud_DocumentService_Query::QUERY_ORDER

Inherited_from: \Zend_Cloud_DocumentService_Query::QUERY_ORDER

Properties

\Zend_Cloud_DocumentService_Adapter_SimpleDb $_adapter

Details

Type: \Zend_Cloud_DocumentService_Adapter_SimpleDb

array $_clauses = array()

inherited

Clause list

Inherited from: \Zend_Cloud_DocumentService_Query::$$_clauses

Default valuearray()Details

Type: array
Inherited_from: \Zend_Cloud_DocumentService_Query::$$_clauses

Methods

__call(string $name, mixed $args) : \Zend_Cloud_DocumentService_Query

inherited

Generic clause

Inherited from: \Zend_Cloud_DocumentService_Query::__call()

You can use any clause by doing $query->foo('bar') but concrete adapters should be able to recognise it

The call will be iterpreted as clause 'foo' with argument 'bar'

Parameters

Name	Type	Description
$name	string	Clause/method name
$args	mixed

Returns

Type	Description
\Zend_Cloud_DocumentService_Query

__construct(\Zend_Cloud_DocumentService_Adapter_SimpleDb $adapter, null | string $collectionName = null) : void

Constructor

Parameters

Name	Type	Description
$adapter	\Zend_Cloud_DocumentService_Adapter_SimpleDb
$collectionName	null \| string

_parseWhere(string $where, array $args) : string

Parse a where statement into service-specific language

Parameters

Name	Type	Description
$where	string
$args	array

Returns

Type	Description
string

Details

Todo: Ensure this fulfills the entire SimpleDB query specification for WHERE

assemble( $collectionName = null) : string

Assemble the query into a format the adapter can utilize

Simply returns the clauses present.

Parameters

Name	Type	Description
$collectionName

Returns

Type	Description
string

Details

: string

Name of collection from which to select

from(string $name) : \Zend_Cloud_DocumentService_Query

inherited

FROM clause

Inherited from: \Zend_Cloud_DocumentService_Query::from()

Parameters

Name	Type	Description
$name	string	Field names

Returns

Type	Description
\Zend_Cloud_DocumentService_Query

getAdapter() : \Zend_Cloud_DocumentService_Adapter_SimpleDb

Get adapter

Returns

Type	Description
\Zend_Cloud_DocumentService_Adapter_SimpleDb

getClauses() : array

inherited

Return query clauses as an array

Inherited from: \Zend_Cloud_DocumentService_Query::getClauses()

Returns

Type	Description
array	Clauses in the query

limit(int $limit) : \Zend_Cloud_DocumentService_Query

inherited

LIMIT clause (how many items to return)

Inherited from: \Zend_Cloud_DocumentService_Query::limit()

Parameters

Name	Type	Description
$limit	int

Returns

Type	Description
\Zend_Cloud_DocumentService_Query

order(string | int | array $sort, string $direction = 'asc') : \Zend_Cloud_DocumentService_Query

inherited

ORDER clause; field or fields to sort by, and direction to sort

Inherited from: \Zend_Cloud_DocumentService_Query::order()

Parameters

Name	Type	Description
$sort	string \| int \| array
$direction	string

Returns

Type	Description
\Zend_Cloud_DocumentService_Query

select(null | string | array $select) : \Zend_Cloud_DocumentService_Query

inherited

SELECT clause (fields to be selected)

Inherited from: \Zend_Cloud_DocumentService_Query::select()

Parameters

Name	Type	Description
$select	null \| string \| array

Returns

Type	Description
\Zend_Cloud_DocumentService_Query

where(string $cond, $value = null, string $op = 'and') : \Zend_Cloud_DocumentService_Query

inherited

WHERE query

Inherited from: \Zend_Cloud_DocumentService_Query::where()

Parameters

Name	Type	Description
$cond	string	Condition
$value
$op	string	relation to other clauses - and/or

Returns

Type	Description
\Zend_Cloud_DocumentService_Query

whereId(string | int $value) : \Zend_Cloud_DocumentService_Query

inherited

Select record or fields by ID

Inherited from: \Zend_Cloud_DocumentService_Query::whereId()

This one should be used when fetching specific rows since some adapters have special syntax for primary keys

Parameters

Name	Type	Description
$value	string \| int	Identifier to select by

Returns

Type	Description
\Zend_Cloud_DocumentService_Query

Cloud/DocumentService/Adapter/SimpleDb/Query.php

\Zend_Cloud_DocumentService_Adapter_SimpleDb_Queryjump to top

Constants

Properties

Methods

\Zend_Cloud_DocumentService_Adapter_SimpleDb_Query
jump to top