Gdata/Gapps.php
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-2011 Zend Technologies USA Inc.
(http://www.zend.com)
- license
- New
BSD License
- package
- Zend_Gdata
- subpackage
- Gapps
- version
- $Id: Gapps.php 23775 2011-03-01 17:25:24Z ralph $
Functions


addMemberToGroup(
string $recipientAddress, string $groupId ) : \Zend_Gdata_Gapps_MemberEntry
Add an email address to a group as a
member
Parameters
Name |
Type |
Description |
$recipientAddress |
string |
Email address, member id, or group id |
$groupId |
string |
The unique id of the group |
Returns


addOwnerToGroup(
string $email, string $groupId ) : \Zend_Gdata_Gapps_OwnerEntry
Add an email as an owner of a group
Parameters
Name |
Type |
Description |
$email |
string |
Owner's email
|
$groupId |
string |
Group ownership to be checked for |
Returns


addRecipientToEmailList( string $recipientAddress,
string $emailList ) : \Zend_Gdata_Gapps_EmailListRecipientEntry
Add a specified recipient to an
existing emailList.
Parameters
Name |
Type |
Description |
$recipientAddress |
string |
The address of the recipient to be added to the
email list. |
$emailList |
string |
The name of the email address to which the recipient
should be added. |
Returns
Throws


createEmailList(
string $emailList ) : \Zend_Gdata_Gapps_EmailListEntry
Parameters
Name |
Type |
Description |
$emailList |
string |
The name of the email list to be created. |
Returns
Throws


createGroup(
string $groupId, string $groupName, string $description = null,
string $emailPermission = null ) : \Zend_Gdata_Gapps_GroupEntry
Parameters
Name |
Type |
Description |
$groupId |
string |
A unique identifier for the group |
$groupName |
string |
The name of the group |
$description |
string |
A description of the group |
$emailPermission |
string |
The subscription permission of the group |
Returns


createNickname(
string $username, string $nickname ) : \Zend_Gdata_Gapps_NicknameEntry
Create a nickname for a given user.
Parameters
Name |
Type |
Description |
$username |
string |
The username to which the new nickname should be
associated. |
$nickname |
string |
The new nickname to be created. |
Returns
Throws


createUser(
string $username, string $givenName, string $familyName,
string $password, $passwordHashFunction = null, string $quotaLimitInMB
= null ) : \Zend_Gdata_Gapps_UserEntry
Create a new user entry and send it to
the Google Apps servers.
Parameters
Name |
Type |
Description |
$username |
string |
The username for the new user. |
$givenName |
string |
The given name for the new user. |
$familyName |
string |
The family name for the new user. |
$password |
string |
The password for the new user as a plaintext string (if
$passwordHashFunction is null) or a SHA-1 hashed value (if
$passwordHashFunction = 'SHA-1').
|
$passwordHashFunction |
|
|
$quotaLimitInMB |
string |
(optional) The quota limit for the new user in MB.
|
Returns
Throws


deleteEmailList(
string $emailList ) : void
Delete a specified email list.
Parameters
Name |
Type |
Description |
$emailList |
string |
The name of the emailList to be deleted. |
Throws


deleteGroup(
string $groupId ) : void
Parameters
Name |
Type |
Description |
$groupId |
string |
The unique identifier for the group |


deleteNickname(
string $nickname ) : void
Delete a specified nickname.
Parameters
Name |
Type |
Description |
$nickname |
string |
The name of the nickname to be deleted. |
Throws


deleteUser(
string $username ) : void
Delete a user by username.
Parameters
Name |
Type |
Description |
$username |
string |
The username associated with the user who should be
deleted. |
Throws


isMember(
string $memberId, string $groupId ) : bool
Check to see if a member id or group id
is a member of group
Parameters
Name |
Type |
Description |
$memberId |
string |
Member id or group group id |
$groupId |
string |
Group to be checked for |
Returns
Type |
Description |
bool |
True, if given entity is a member |


isOwner(
string $email, string $groupId ) : bool
Checks to see if an email is an owner
of a group
Parameters
Name |
Type |
Description |
$email |
string |
Owner's email
|
$groupId |
string |
Group ownership to be checked for |
Returns
Type |
Description |
bool |
True, if given entity is an owner |


removeMemberFromGroup( string $memberId, string $groupId ) :
void
Remove a member id from a group
Parameters
Name |
Type |
Description |
$memberId |
string |
Member id or group id |
$groupId |
string |
The unique id of the group |


removeOwnerFromGroup( string $email, string $groupId ) : void
Remove email as an owner of a group
Parameters
Name |
Type |
Description |
$email |
string |
Owner's email
|
$groupId |
string |
The unique identifier for the group |


removeRecipientFromEmailList( string $recipientAddress,
string $emailList ) : void
Remove a specified recipient from an
email list.
Parameters
Name |
Type |
Description |
$recipientAddress |
string |
The recipient to be removed. |
$emailList |
string |
The list from which the recipient should be removed. |
Throws


restoreUser(
string $username ) : \Zend_Gdata_Gapps_UserEntry
Mark a given user as not suspended.
Parameters
Name |
Type |
Description |
$username |
string |
The username associated with the user who should be
restored. |
Returns
Throws


retrieveAllEmailLists( ) : \Zend_Gdata_Gapps_EmailListFeed
Retrieve all email lists associated
with the curent domain. Be aware that calling this function on a domain
with many email lists will take a signifigant amount of time to
complete. On larger domains this may may cause execution to timeout
without proper precautions in place.


retrieveAllGroups(
) : \Zend_Gdata_Gapps_GroupFeed
Retrieve all groups in the current
domain. Be aware that calling this function on a domain with many groups
will take a signifigant amount of time to complete. On larger domains
this may may cause execution to timeout without proper precautions in
place.


retrieveAllMembers(
string $groupId ) : \Zend_Gdata_Gapps_MemberFeed
Retrieves all the members of a group
Parameters
Name |
Type |
Description |
$groupId |
string |
The unique id of the group |
Returns


retrieveAllNicknames( ) : \Zend_Gdata_Gapps_NicknameFeed
Retrieve all nicknames in the current
domain. Be aware that calling this function on a domain with many
nicknames will take a signifigant amount of time to complete. On larger
domains this may may cause execution to timeout without proper
precautions in place.


retrieveAllRecipients( $emailList ) : \Zend_Gdata_Gapps_EmailListRecipientFeed
Retrieve all recipients associated with
an email list. Be aware that calling this function on a domain with many
email lists will take a signifigant amount of time to complete. On
larger domains this may may cause execution to timeout without proper
precautions in place.
Parameters
Name |
Type |
Description |
$emailList |
|
|
Returns
Throws


retrieveAllUsers(
) : \Zend_Gdata_Gapps_UserFeed
Retrieve all users in the current
domain. Be aware that calling this function on a domain with many users
will take a signifigant amount of time to complete. On larger domains
this may may cause execution to timeout without proper precautions in
place.


retrieveEmailLists(
$recipient ) : \Zend_Gdata_Gapps_EmailListFeed
Retrieve all email lists associated
with a recipient.
Parameters
Name |
Type |
Description |
$recipient |
|
|
Returns
Throws


retrieveGroup(
string $groupId ) : \Zend_Gdata_Gapps_GroupEntry
Retrieves a group based on group id
Parameters
Name |
Type |
Description |
$groupId |
string |
The unique identifier for the group |
Returns


retrieveGroupOwners(
string $groupId ) : \Zend_Gdata_Gapps_OwnerFeed
Retrieves all the owners of a group
Parameters
Name |
Type |
Description |
$groupId |
string |
The unique identifier for the group |
Returns


retrieveGroups(
string $memberId, bool $directOnly = null ) : \Zend_Gdata_Gapps_GroupFeed
Retrieve all of the groups that a user
is a member of
Parameters
Name |
Type |
Description |
$memberId |
string |
Member username |
$directOnly |
bool |
(Optional) If true, members with direct association only will
be considered
|
Returns
Type |
Description |
\Zend_Gdata_Gapps_GroupFeed |
Collection of Zend_Gdata_GroupEntry objects representing all
groups member is apart of in the domain. |


retrieveNickname(
string $nickname ) : \Zend_Gdata_Gapps_NicknameEntry
Retrieve the entry for a specified
nickname.
Parameters
Name |
Type |
Description |
$nickname |
string |
The nickname to be retrieved. |
Returns
Throws


retrieveNicknames(
string $username ) : \Zend_Gdata_Gapps_NicknameFeed
Retrieve all nicknames associated with
a specific username.
Parameters
Name |
Type |
Description |
$username |
string |
The username whose nicknames should be returned. |
Returns
Throws


retrievePageOfEmailLists( $startNickname = null ) : \Zend_Gdata_Gapps_EmailListFeed
Retrieve a page of email lists in
alphabetical order, starting with the provided email list.
Parameters
Name |
Type |
Description |
$startNickname |
|
|
Returns
Throws


retrievePageOfGroups( string $startGroup = null ) : \Zend_Gdata_Gapps_GroupFeed
Retrieve a page of groups in
alphabetical order, starting with the provided group.
Parameters
Name |
Type |
Description |
$startGroup |
string |
(optional) The first group to retrieve. If null or not defined,
the page will begin with the first group in the domain.
|
Returns
Throws


retrievePageOfMembers( string $groupId, string $startMember =
null ) : \Zend_Gdata_Gapps_MemberFeed
Parameters
Name |
Type |
Description |
$groupId |
string |
The group id which should be searched. |
$startMember |
string |
(optinal) The address of the first member, or null to start
with the first member in the list.
|
Returns


retrievePageOfNicknames( string $startNickname = null ) : \Zend_Gdata_Gapps_NicknameFeed
Retrieve a page of nicknames in
alphabetical order, starting with the provided nickname.
Parameters
Name |
Type |
Description |
$startNickname |
string |
(optional) The first nickname to retrieve. If null or not
declared, the page will begin with the first nickname in the domain.
|
Returns
Throws


retrievePageOfRecipients( $emailList, string $startRecipient =
null ) : \Zend_Gdata_Gapps_EmailListRecipientFeed
Retrieve a page of email list
recipients in alphabetical order, starting with the provided email list
recipient.
Parameters
Name |
Type |
Description |
$emailList |
|
|
$startRecipient |
string |
(optinal) The address of the first recipient, or null to start
with the first recipient in the list.
|
Returns
Throws


retrievePageOfUsers(
string $startUsername = null ) : \Zend_Gdata_Gapps_UserFeed
Retrieve a page of users in
alphabetical order, starting with the provided username.
Parameters
Name |
Type |
Description |
$startUsername |
string |
(optional) The first username to retrieve. If null or not
declared, the page will begin with the first user in the domain.
|
Returns
Throws


retrieveUser(
string $username ) : \Zend_Gdata_Gapps_UserEntry
Retrieve a user based on their
username.
Parameters
Name |
Type |
Description |
$username |
string |
The username to search for. |
Returns
Throws


suspendUser(
string $username ) : \Zend_Gdata_Gapps_UserEntry
Mark a given user as suspended.
Parameters
Name |
Type |
Description |
$username |
string |
The username associated with the user who should be
suspended. |
Returns
Throws


updateGroup(
string $groupId, string $groupName = null, string $description = null,
string $emailPermission = null ) : \Zend_Gdata_Gapps_GroupEntry
Update group properties with new
values. any property not defined will not be updated
Parameters
Name |
Type |
Description |
$groupId |
string |
A unique identifier for the group |
$groupName |
string |
The name of the group |
$description |
string |
A description of the group |
$emailPermission |
string |
The subscription permission of the group |
Returns


updateUser(
string $username, \Zend_Gdata_Gapps_UserEntry $userEntry
) : \Zend_Gdata_Gapps_UserEntry
Overwrite a specified username with the
provided UserEntry. The UserEntry does not need to contain an edit link.
This method is provided for compliance with the Google Apps
Provisioning API specification. Normally users will instead want to call
UserEntry::save() instead.
Parameters
Name |
Type |
Description |
$username |
string |
The username whose data will be overwritten. |
$userEntry |
\Zend_Gdata_Gapps_UserEntry |
The user entry which will be overwritten. |
Returns
Throws
Details
- see
- \Zend_Gdata_App_Entry::save
Service class for interacting with the
Google Apps Provisioning API.
Like other service classes in this module, this class provides
access via an HTTP client to Google servers for working with entries and
feeds.
Because of the nature of this API, all access must occur over an
authenticated connection.
- Extends from
- \Zend_Gdata
- category
- Zend
- copyright
- Copyright (c) 2005-2011 Zend Technologies USA Inc.
(http://www.zend.com)
- license
- New
BSD License
- link
- http://code.google.com/apis/apps/gdata_provisioning_api_v2.0_reference.html
- package
- Zend_Gdata
- subpackage
- Gapps
Constants
Properties



string $_domain=
'null'
The domain which is being administered
via the Provisioning API.
Default valuenull
Details
- Type
- string



array $namespaces=
'array'
static
Namespaces used for Zend_Gdata_Gapps
Default valuearray
Details
- Type
- array
Methods



__call( string $method, array $args ) : void
Provides a magic factory method to
instantiate new objects with shorter syntax than would otherwise be
required by the Zend Framework naming conventions. For more information,
see Zend_Gdata_App::__call().
This overrides the default behavior of __call() so that query
classes do not need to have their domain manually set when created with
a magic factory method.
Parameters
Name |
Type |
Description |
$method |
string |
The method name being called |
$args |
array |
The arguments passed to the call |
Throws
Details
- see
- \Zend_Gdata_App::__call()



__construct( \Zend_Http_Client $client
= null, string $domain = null, string $applicationId =
MyCompany-MyApp-1.0 ) : void
Create Gdata_Gapps object
Parameters
Name |
Type |
Description |
$client |
\Zend_Http_Client |
(optional) The HTTP client to use when when communicating with
the Google Apps servers.
|
$domain |
string |
(optional) The Google Apps domain which is to be accessed.
|
$applicationId |
string |
The identity of the app in the form of Company-AppName-Version
|



delete( mixed $data, integer $remainingRedirects
= null ) : void
DELETE entry with client object This
method overrides the default behavior of Zend_Gdata_App, providing
support for Zend_Gdata_Gapps_ServiceException.
Parameters
Name |
Type |
Description |
$data |
mixed |
The Zend_Gdata_App_Entry or URL to delete |
$remainingRedirects |
integer |
(optional)
|
Throws



get( string $uri, array $extraHeaders = array
) : \Zend_Http_Response
GET a URI using client object.
This method overrides the default behavior of Zend_Gdata_App,
providing support for Zend_Gdata_Gapps_ServiceException.
Parameters
Name |
Type |
Description |
$uri |
string |
GET URI |
$extraHeaders |
array |
Extra headers to add to the request, as an array of
string-based key/value pairs.
|
Returns
Throws



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.
Parameters
Name |
Type |
Description |
$domain |
string |
(optional) A fully-qualified domain to use instead of the
default domain for this service instance.
|
Throws



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.
Returns
Type |
Description |
string |
The domain to be used for this session, or null if not set. |



getEmailListEntry( mixed $location ) : \Zend_Gdata_Gapps_EmailListEntry
Retreive a single EmailListEntry
object.
Parameters
Name |
Type |
Description |
$location |
mixed |
The location for the feed, as a URL or Query. |
Returns
Throws



getEmailListFeed( mixed $location = null ) : \Zend_Gdata_Gapps_EmailListFeed
Retreive EmailListFeed object
containing multiple EmailListEntry objects.
Parameters
Name |
Type |
Description |
$location |
mixed |
(optional) The location for the feed, as a URL or Query.
|
Returns
Throws



getEmailListRecipientEntry( mixed $location ) : \Zend_Gdata_Gapps_EmailListRecipientEntry
Retreive a single
EmailListRecipientEntry object.
Parameters
Name |
Type |
Description |
$location |
mixed |
The location for the feed, as a URL or Query. |
Returns
Throws



getEmailListRecipientFeed( mixed $location ) : \Zend_Gdata_Gapps_EmailListRecipientFeed
Retreive EmailListRecipientFeed object
containing multiple EmailListRecipientEntry objects.
Parameters
Name |
Type |
Description |
$location |
mixed |
The location for the feed, as a URL or Query. |
Returns
Throws



getGroupEntry( mixed $location = null ) : \Zend_Gdata_Gapps_GroupEntry
Retreive a single GroupEntry object.
Parameters
Name |
Type |
Description |
$location |
mixed |
The location for the feed, as a URL or Query. |
Returns
Throws



getGroupFeed( mixed $location = null ) : \Zend_Gdata_Gapps_GroupFeed
Retreive GroupFeed object containing
multiple GroupEntry objects.
Parameters
Name |
Type |
Description |
$location |
mixed |
(optional) The location for the feed, as a URL or Query.
|
Returns
Throws



getMemberEntry( mixed $location = null ) : \Zend_Gdata_Gapps_MemberEntry
Retreive a single MemberEntry object.
Parameters
Name |
Type |
Description |
$location |
mixed |
The location for the feed, as a URL or Query. |
Returns
Throws



getMemberFeed( mixed $location = null ) : \Zend_Gdata_Gapps_MemberFeed
Retreive MemberFeed object containing
multiple MemberEntry objects.
Parameters
Name |
Type |
Description |
$location |
mixed |
(optional) The location for the feed, as a URL or Query.
|
Returns
Throws



getNicknameEntry( mixed $location ) : \Zend_Gdata_Gapps_NicknameEntry
Retreive a single NicknameEntry object.
Parameters
Name |
Type |
Description |
$location |
mixed |
The location for the feed, as a URL or Query. |
Returns
Throws



getNicknameFeed( mixed $location = null ) : \Zend_Gdata_Gapps_NicknameFeed
Retreive NicknameFeed object containing
multiple NicknameEntry objects.
Parameters
Name |
Type |
Description |
$location |
mixed |
(optional) The location for the feed, as a URL or Query.
|
Returns
Throws



getOwnerEntry( mixed $location = null ) : \Zend_Gdata_Gapps_OwnerEntry
Retreive a single OwnerEntry object.
Parameters
Name |
Type |
Description |
$location |
mixed |
The location for the feed, as a URL or Query. |
Returns
Throws



getOwnerFeed( mixed $location = null ) : \Zend_Gdata_Gapps_OwnerFeed
Retreive OwnerFeed object containing
multiple OwnerEntry objects.
Parameters
Name |
Type |
Description |
$location |
mixed |
(optional) The location for the feed, as a URL or Query.
|
Returns
Throws



getUserEntry( mixed $location ) : \Zend_Gdata_Gapps_UserEntry
Retreive a single UserEntry object.
Parameters
Name |
Type |
Description |
$location |
mixed |
The location for the feed, as a URL or Query. |
Returns
Throws



getUserFeed( mixed $location = null ) : \Zend_Gdata_Gapps_UserFeed
Retrieve a UserFeed containing multiple
UserEntry objects.
Parameters
Name |
Type |
Description |
$location |
mixed |
(optional) The location for the feed, as a URL or Query.
|
Returns
Throws



import( string $uri, \Zend_Http_Client $client
= null, string $className = Zend_Gdata_App_Feed ) : \Zend_Gdata_App_Feed
static
Imports a feed located at $uri.
This method overrides the default behavior of Zend_Gdata_App,
providing support for Zend_Gdata_Gapps_ServiceException.
Parameters
Name |
Type |
Description |
$uri |
string |
|
$client |
\Zend_Http_Client |
(optional) The client used for communication
|
$className |
string |
(optional) The class which is used as the return type
|
Returns
Throws



importUrl( string $url, string $className =
Zend_Gdata_App_Feed, array $extraHeaders = array ) : string|\Zend_Gdata_App_Feed
Parameters
Name |
Type |
Description |
$url |
string |
The URL to import |
$className |
string |
The class which is used as the return type |
$extraHeaders |
array |
Extra headers to add to the request, as an array of
string-based key/value pairs.
|
Returns
Type |
Description |
string\Zend_Gdata_App_Feed
|
Returns string only if the object mapping has been disabled
explicitly by passing false to the useObjectMapping() function. |
Throws



insertEntry( mixed $data, string $uri,
string $className = Zend_Gdata_App_Entry, array $extraHeaders = array )
: \Zend_Gdata_App_Entry
Parameters
Name |
Type |
Description |
$data |
mixed |
The Zend_Gdata_App_Entry or XML to post |
$uri |
string |
POST URI |
$className |
string |
The class of entry to be returned. |
$extraHeaders |
array |
Extra headers to add to the request, as an array of
string-based key/value pairs.
|
Returns



performHttpRequest( string $method, string $url,
array $headers = array, string $body = null, string $contentType = null,
int $remainingRedirects = null ) : \Zend_Http_Response
Overrides the definition in the parent (Zend_Gdata_App) and uses
the Zend_Gdata_HttpClient functionality to filter the HTTP requests and
responses.
Parameters
Name |
Type |
Description |
$method |
string |
The HTTP method for the request - 'GET', 'POST', 'PUT',
'DELETE'
|
$url |
string |
The URL to which this request is being performed, or null if
found in $data
|
$headers |
array |
An associative array of HTTP headers for this
request |
$body |
string |
The body of the HTTP request |
$contentType |
string |
The value for the content type of the request body |
$remainingRedirects |
int |
Number of redirects to follow if requests results in
one |
Returns



post( mixed $data, string $uri = null,
integer $remainingRedirects = null, string $contentType = null,
$extraHeaders = null ) : \Zend_Http_Response
POST data with client object.
This method overrides the default behavior of Zend_Gdata_App,
providing support for Zend_Gdata_Gapps_ServiceException.
Parameters
Name |
Type |
Description |
$data |
mixed |
The Zend_Gdata_App_Entry or XML to post |
$uri |
string |
(optional) POST URI
|
$remainingRedirects |
integer |
(optional)
|
$contentType |
string |
Content-type of the data
|
$extraHeaders |
|
|
Returns
Throws



prepareRequest( string $method, string $url = null,
array $headers = array, mixed $data = null, string $contentTypeOverride
= null ) : array
- Checks the $data element and, if it's an entry, extracts the
XML, multipart data, edit link (PUT,DELETE), etc.
- If $data is a string, sets the default content-type header as
'application/atom+xml' if it's not already been set.
- Adds a x-http-method override header and changes the HTTP
method to 'POST' if necessary as per getHttpMethodOverride()
Parameters
Name |
Type |
Description |
$method |
string |
The HTTP method for the request - 'GET', 'POST', 'PUT',
'DELETE'
|
$url |
string |
The URL to which this request is being performed, or null if
found in $data
|
$headers |
array |
An associative array of HTTP headers for this
request |
$data |
mixed |
The Zend_Gdata_App_Entry or XML for the body of the
request |
$contentTypeOverride |
string |
The override value for the content type of the
request body |
Returns
Type |
Description |
array |
An associative array containing the determined 'method',
'url', 'data', 'headers', 'contentType' |



put( mixed $data, string $uri = null,
integer $remainingRedirects = null, string $contentType = null,
$extraHeaders = null ) : \Zend_Http_Response
PUT data with client object This method
overrides the default behavior of Zend_Gdata_App, providing support for
Zend_Gdata_Gapps_ServiceException.
Parameters
Name |
Type |
Description |
$data |
mixed |
The Zend_Gdata_App_Entry or XML to post |
$uri |
string |
(optional) PUT URI
|
$remainingRedirects |
integer |
(optional)
|
$contentType |
string |
Content-type of the data
|
$extraHeaders |
|
|
Returns
Throws



registerPackage( string $name ) : void
This array is searched when using the magic __call method below
to instantiante new objects.
Parameters
Name |
Type |
Description |
$name |
string |
The name of the package (eg Zend_Gdata_App)
|



setDomain( string $value ) : void
Set domain for this service instance.
This should be a fully qualified domain, such as 'foo.example.com'.
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.
Parameters
Name |
Type |
Description |
$value |
string |
The domain to be used for this session. |



setMinorProtocolVersion( \(int|\NULL) $value ) : void
Set the minor protocol version that
should be used. If set to NULL, no minor protocol version will be sent
to the server. Values < 0 will cause a
Zend_Gdata_App_InvalidArgumentException to be thrown.
Inherited from: \Zend_Gdata_App::setMinorProtocolVersion()
Parameters
Name |
Type |
Description |
$value |
\(int|\NULL) |
The minor protocol version to use. |
Throws
Details
- see
- \_minorProtocolVersion



throwServiceExceptionIfDetected( \Zend_Gdata_Exception $e ) : void
static
Convert an exception to an
ServiceException if an AppsForYourDomain XML document is contained
within the original exception's HTTP response. If conversion fails,
throw the original error.
Parameters
Name |
Type |
Description |
$e |
\Zend_Gdata_Exception |
The exception to convert. |
Throws



updateEntry( mixed $data, string|null $uri = null,
string|null $className = null, array $extraHeaders = array ) : \Zend_Gdata_App_Entry
Parameters
Name |
Type |
Description |
$data |
mixed |
Zend_Gdata_App_Entry or XML (w/ID and link rel='edit')
|
$uri |
string|null |
The URI to send requests to, or null if $data contains the URI.
|
$className |
string|null |
The name of the class that should be deserialized from the
server response. If null, then 'Zend_Gdata_App_Entry' will be used.
|
$extraHeaders |
array |
Extra headers to add to the request, as an array of
string-based key/value pairs.
|
Returns
Throws