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.
Assists in constructing queries for Google Apps email list recipient 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.

__construct(
string $domain
=
null, string $emailListName
=
null, string $startRecipient
=
null
)
:
void
Create a new instance.
Name | Type | Description |
---|---|---|
$domain | string | (optional) The Google Apps-hosted domain to use when constructing query URIs. |
$emailListName | string | (optional) Value for the emailListName property. |
$startRecipient | string | (optional) Value for the startRecipient property. |

__get(
$name
)
:
void
Name | Type | Description |
---|---|---|
$name |

__set(
$name, $val
)
:
void
Name | Type | Description |
---|---|---|
$name | ||
$val |

getAlt(
)
:
string
Type | Description |
---|---|
string | rss or atom |

getAuthor(
)
:
string
Type | Description |
---|---|
string | author |

getBaseUrl(
string $domain
=
null
)
:
void
Returns the base URL used to access the Google Apps service, based on the current domain. The current domain can be temporarily overridden by providing a fully qualified domain as $domain.
Inherited from: \Zend_Gdata_Gapps_Query::getBaseUrl()Name | Type | Description |
---|---|---|
$domain | string | (optional) A fully-qualified domain to use instead of the default domain for this service instance. |

getDomain(
)
:
string
Get domain for this service instance. This should be a fully qualified domain, such as 'foo.example.com'. If no domain is set, null will be returned.
Inherited from: \Zend_Gdata_Gapps_Query::getDomain()Type | Description |
---|---|
string | The domain to be used for this session, or null if not set. |

getEmailListName(
)
:
void
Get the email list name to query for. If no name is set, null will be returned.

getMaxResults(
)
:
int
Type | Description |
---|---|
int | maxResults |

getParam(
string $name
)
:
void
Name | Type | Description |
---|---|---|
$name | string |

getPublishedMax(
)
:
string
Type | Description |
---|---|
string | publishedMax |

getPublishedMin(
)
:
string
Type | Description |
---|---|
string | publishedMin |

getQuery(
)
:
string
Type | Description |
---|---|
string | query |

getQueryString(
)
:
string
Type | Description |
---|---|
string | querystring |

getQueryUrl(
)
:
string
Returns the URL generated for this query, based on it's current parameters.
Type | Description |
---|---|
string | A URL generated based on the state of this query. |
Exception | Description |
---|---|
\Zend_Gdata_App_InvalidArgumentException |

getStartIndex(
)
:
int
Type | Description |
---|---|
int | startIndex |

getStartRecipient(
)
:
string
Get the first recipient which should be displayed when retrieving a list of email list recipients.
Type | Description |
---|---|
string | The first recipient to be returned, or null if disabled. |

getUpdatedMax(
)
:
string
Type | Description |
---|---|
string | updatedMax |

getUpdatedMin(
)
:
string
Type | Description |
---|---|
string | updatedMin |

setAlt(
string $value
)
:
\Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setAuthor(
string $value
)
:
\Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setCategory(
string $value
)
:
\Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setDomain(
string $value
)
:
void
Set domain for this service instance. This should be a fully qualified domain, such as 'foo.example.com'.
Inherited from: \Zend_Gdata_Gapps_Query::setDomain()This value is used when calculating URLs for retrieving and posting entries. If no value is specified, a URL will have to be manually constructed prior to using any methods which interact with the Google Apps provisioning service.
Name | Type | Description |
---|---|---|
$value | string | The domain to be used for this session. |

setEmailListName(
string $value
)
:
void
Set the email list name to query for. When set, only lists with a name matching this value will be returned in search results. Set to null to disable filtering by list name.
Name | Type | Description |
---|---|---|
$value | string | The email list name to filter search results by, or null to disable. |

setMaxResults(
int $value
)
:
\Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | int |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setParam(
string $name, string $value
)
:
\Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$name | string | |
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setPublishedMax(
string $value
)
:
\Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setPublishedMin(
string $value
)
:
\Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setQuery(
string $value
)
:
\Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setStartIndex(
int $value
)
:
\Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | int |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setStartRecipient(
string $value
)
:
void
Set the first recipient which should be displayed when retrieving a list of email list recipients.
Name | Type | Description |
---|---|---|
$value | string | The first recipient to be returned, or null to disable. |

setUpdatedMax(
string $value
)
:
\Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |

setUpdatedMin(
string $value
)
:
\Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |