API Documentation

Zend/Gdata/Gapps/OwnerQuery.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_Gdata  
Subpackage
Gapps  
Version
$Id:$  

\Zend_Gdata_Gapps_OwnerQuery

Package: Zend\Gdata\Gapps

Assists in constructing queries for Google Apps owner entries.

Instances of this class can be provided in many places where a URL is required.

For information on submitting queries to a server, see the Google Apps service class, Zend_Gdata_Gapps.

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

Properties

Propertyprotectedstring  $_groupId= 'null'

Group owner is refering to

Default valuenullDetails
Type
string
Propertyprotectedstring  $_ownerEmail= 'null'

The email of the owner

Default valuenullDetails
Type
string

Methods

methodpublic__construct( string $domain = null, string $groupId = null, string $ownerEmail = null ) : void

Create a new instance.

Parameters
Name Type Description
$domain string

(optional) The Google Apps-hosted domain to use when constructing query URIs.

$groupId string

(optional) Value for the groupId property.

$ownerEmail string

(optional) Value for the OwnerEmail property.

methodpublicgetGroupId( ) : string

Get the group id to query for.

Returns
Type Description
string
methodpublicgetOwnerEmail( ) : string

Get the owner email to query for.

Returns
Type Description
string
methodpublicgetQueryUrl( ) : string

Returns the query URL generated by this query instance.

Returns
Type Description
string The query URL for this instance.
methodpublicsetGroupId( string $value ) : void

Set the group id to query for.

Parameters
Name Type Description
$value string
Details
See
\getGroupId  
methodpublicsetOwnerEmail( string $value ) : void

Set the owner email to query for.

Parameters
Name Type Description
$value string
Details
See
\getOwnerEmail  
Documentation was generated by DocBlox 0.15.1.