Para establecer el dominio de las peticiones realizadas por la clase de servicio, llame a setDomain() o especifique el dominio al instanciar la clase de servicio. Por ejemplo:

$domain = "example.com";
$gdata = new Zend_Gdata_Gapps($client, $domain);

Establecer el dominio para las peticiones realizadas por las clases de consulta es similar a establecerlo para la clase de servicio: llame a setDomain() o especifique el dominio al crear la consulta. Por ejemplo:

$domain = "example.com";
$query = new Zend_Gdata_Gapps_UserQuery($domain, $arg);

Cuando se usa un método de fábrica de la clase de servicio para crear una consulta, la clase de servicio establecerá automáticamente el dominio de la consulta para que coincida con el suyo propio. Como resultado, no es necesario especificar el dominio como parte de los argumentos del constructor.

$domain = "example.com";
$gdata = new Zend_Gdata_Gapps($client, $domain);
$query = $gdata->newUserQuery($arg);

Las cuentas de usuario se pueden crear llamando al método de conveniencia createUser():

$gdata->createUser('foo', 'Random', 'User', '••••••••');

Los usuarios también se pueden crear instanciando UserEntry, proporcionando un nombre de usuario, nombre, apellido y contraseña, y luego llamando a insertUser() sobre un objeto de servicio para subir la entrada al servidor.

$user = $gdata->newUserEntry();
$user->login = $gdata->newLogin();
$user->login->username = 'foo';
$user->login->password = '••••••••';
$user->name = $gdata->newName();
$user->name->givenName = 'Random';
$user->name->familyName = 'User';
$user = $gdata->insertUser($user);

La contraseña del usuario normalmente debe proporcionarse en texto plano. Opcionalmente, la contraseña se puede proporcionar como un resumen SHA-1 si login->passwordHashFunction se establece a 'SHA-1'.

Las cuentas de usuario individuales se pueden obtener llamando al método de conveniencia retrieveUser(). Si el usuario no se encuentra, se devolverá NULL.

$user = $gdata->retrieveUser('foo');

echo 'Username: ' . $user->login->userName . "\n";
echo 'Given Name: ' . $user->name->givenName . "\n";
echo 'Family Name: ' . $user->name->familyName . "\n";
echo 'Suspended: ' . ($user->login->suspended ? 'Yes' : 'No') . "\n";
echo 'Admin: ' . ($user->login->admin ? 'Yes' : 'No') . "\n"
echo 'Must Change Password: ' .
     ($user->login->changePasswordAtNextLogin ? 'Yes' : 'No') . "\n";
echo 'Has Agreed To Terms: ' .
     ($user->login->agreedToTerms ? 'Yes' : 'No') . "\n";

Los usuarios también se pueden obtener creando una instancia de Zend_Gdata_Gapps_UserQuery, estableciendo su propiedad username para que coincida con el nombre de usuario del usuario que se desea obtener, y llamando a getUserEntry() sobre un objeto de servicio con esa consulta.

$query = $gdata->newUserQuery('foo');
$user = $gdata->getUserEntry($query);

echo 'Username: ' . $user->login->userName . "\n";
echo 'Given Name: ' . $user->login->givenName . "\n";
echo 'Family Name: ' . $user->login->familyName . "\n";
echo 'Suspended: ' . ($user->login->suspended ? 'Yes' : 'No') . "\n";
echo 'Admin: ' . ($user->login->admin ? 'Yes' : 'No') . "\n"
echo 'Must Change Password: ' .
     ($user->login->changePasswordAtNextLogin ? 'Yes' : 'No') . "\n";
echo 'Has Agreed To Terms: ' .
     ($user->login->agreedToTerms ? 'Yes' : 'No') . "\n";

Si no se puede localizar el usuario especificado, se lanzará una ServiceException con un código de error Zend_Gdata_Gapps_Error::ENTITY_DOES_NOT_EXIST. Las ServiceExceptions se tratarán en el capítulo de excepciones.

Para obtener todos los usuarios de un dominio, llame al método de conveniencia retrieveAllUsers().

$feed = $gdata->retrieveAllUsers();

foreach ($feed as $user) {
    echo "  * " . $user->login->username . ' (' . $user->name->givenName .
        ' ' . $user->name->familyName . ")\n";
}

Esto creará un objeto Zend_Gdata_Gapps_UserFeed que contiene cada usuario del dominio.

Alternativamente, llame a getUserFeed() sin opciones. Tenga en cuenta que en dominios más grandes este feed puede estar paginado por el servidor. Para más información sobre paginación, consulte el capítulo de paginación.

$feed = $gdata->getUserFeed();

foreach ($feed as $user) {
    echo "  * " . $user->login->username . ' (' . $user->name->givenName .
        ' ' . $user->name->familyName . ")\n";
}

La forma más sencilla de actualizar una cuenta de usuario es obtener el usuario tal como se describe en las secciones anteriores, realizar los cambios deseados y luego llamar a save() sobre ese usuario. Cualquier cambio realizado se propagará al servidor.

$user = $gdata->retrieveUser('foo');
$user->name->givenName = 'Foo';
$user->name->familyName = 'Bar';
$user = $user->save();

$user = $gdata->retrieveUser('foo');
$user->login->password = '••••••••';
$user = $user->save();

$user = $gdata->retrieveUser('foo');
$user->login->changePasswordAtNextLogin = true;
$user = $user->save();

$gdata->suspendUser('foo');
$gdata->restoreUser('foo');

$user = $gdata->retrieveUser('foo');
$user->login->suspended = true;
$user = $user->save();

$user = $gdata->retrieveUser('foo');
$user->login->admin = true;
$user = $user->save();

Eliminar una cuenta de usuario para la que ya se dispone de un UserEntry es tan sencillo como llamar a delete() sobre esa entrada.

$user = $gdata->retrieveUser('foo');
$user->delete();

Si no se dispone de acceso a un objeto UserEntry para una cuenta, use el método de conveniencia deleteUser().

$gdata->deleteUser('foo');

Los apodos se pueden crear llamando al método de conveniencia createNickname():

$gdata->createNickname('foo', 'bar');

Los apodos también se pueden crear instanciando NicknameEntry, proporcionando al apodo un nombre y un propietario, y luego llamando a insertNickname() sobre un objeto de servicio para subir la entrada al servidor.

$nickname = $gdata->newNicknameEntry();
$nickname->login = $gdata->newLogin('foo');
$nickname->nickname = $gdata->newNickname('bar');
$nickname = $gdata->insertNickname($nickname);

Los apodos se pueden obtener llamando al método de conveniencia retrieveNickname(). Esto devolverá NULL si no se encuentra un usuario.

$nickname = $gdata->retrieveNickname('bar');

echo 'Nickname: ' . $nickname->nickname->name . "\n";
echo 'Owner: ' . $nickname->login->username . "\n";

Los apodos individuales también se pueden obtener creando una instancia de Zend_Gdata_Gapps_NicknameQuery, estableciendo su propiedad nickname para que coincida con el apodo que se desea obtener, y llamando a getNicknameEntry() sobre un objeto de servicio con esa consulta.

$query = $gdata->newNicknameQuery('bar');
$nickname = $gdata->getNicknameEntry($query);

echo 'Nickname: ' . $nickname->nickname->name . "\n";
echo 'Owner: ' . $nickname->login->username . "\n";

Al igual que con los usuarios, si no se encuentra ningún apodo correspondiente se lanzará una ServiceException con un código de error Zend_Gdata_Gapps_Error::ENTITY_DOES_NOT_EXIST. De nuevo, esto se tratará en el capítulo de excepciones.

Para obtener todos los apodos asociados a un usuario determinado, llame al método de conveniencia retrieveNicknames().

$feed = $gdata->retrieveNicknames('foo');

foreach ($feed as $nickname) {
    echo '  * ' . $nickname->nickname->name . "\n";
}

Esto creará un objeto Zend_Gdata_Gapps_NicknameFeed que contiene cada apodo asociado al usuario especificado.

Alternativamente, cree un nuevo Zend_Gdata_Gapps_NicknameQuery, establezca su propiedad username al usuario deseado, y envíe la consulta llamando a getNicknameFeed() sobre un servicio objeto.

$query = $gdata->newNicknameQuery();
$query->setUsername('foo');
$feed = $gdata->getNicknameFeed($query);

foreach ($feed as $nickname) {
    echo '  * ' . $nickname->nickname->name . "\n";
}

Para obtener todos los apodos en un feed, simplemente llame al método de conveniencia retrieveAllNicknames()

$feed = $gdata->retrieveAllNicknames();

foreach ($feed as $nickname) {
    echo '  * ' . $nickname->nickname->name . ' => ' .
        $nickname->login->username . "\n";
}

Esto creará un objeto Zend_Gdata_Gapps_NicknameFeed que contiene cada apodo del dominio.

Alternativamente, llame a getNicknameFeed() sobre un objeto de servicio sin argumentos.

$feed = $gdata->getNicknameFeed();

foreach ($feed as $nickname) {
    echo '  * ' . $nickname->nickname->name . ' => ' .
        $nickname->login->username . "\n";
}

Eliminar un apodo para el que ya se dispone de un NicknameEntry es tan sencillo como llamar a delete() sobre esa entrada.

$nickname = $gdata->retrieveNickname('bar');
$nickname->delete();

Para los apodos de los que no se dispone de un NicknameEntry, use el método de conveniencia deleteNickname().

$gdata->deleteNickname('bar');

Los grupos se pueden crear llamando al método de conveniencia createGroup():

$gdata->createGroup('friends', 'The Friends Group');

Los grupos también se pueden crear instanciando GroupEntry, proporcionando un id de grupo y un nombre para el grupo, y luego llamando a insertGroup() sobre un objeto de servicio para subir la entrada al servidor.

$group = $gdata->newGroupEntry();

$properties[0] = $this->newProperty();
$properties[0]->name = 'groupId';
$properties[0]->value = 'friends';
$properties[1] = $this->newProperty();
$properties[1]->name = 'groupName';
$properties[1]->value = 'The Friends Group';

$group->property = $properties;

$group = $gdata->insertGroup($group);

Para obtener un grupo individual, llame al método de conveniencia retrieveGroup():

$entry = $gdata->retrieveGroup('friends');

foreach ($entry->property as $p) {
    echo "Property Name: " . $p->name;
    echo "\nProperty Value: " . $p->value . "\n\n";
}

Esto creará un objeto Zend_Gdata_Gapps_GroupEntry que contiene las propiedades sobre el grupo.

Alternativamente, cree un nuevo Zend_Gdata_Gapps_GroupQuery, establezca su propiedad groupId al id de grupo deseado, y envíe la consulta llamando a getGroupEntry() sobre un objeto de servicio.

$query = $gdata->newGroupQuery();
$query->setGroupId('friends');
$entry = $gdata->getGroupEntry($query);

foreach ($entry->property as $p) {
    echo "Property Name: " . $p->name;
    echo "\nProperty Value: " . $p->value . "\n\n";
}

Para obtener todos los grupos de un dominio, llame al método de conveniencia retrieveAllGroups().

$feed = $gdata->retrieveAllGroups();

foreach ($feed->entry as $entry) {
    foreach ($entry->property as $p) {
        echo "Property Name: " . $p->name;
        echo "\nProperty Value: " . $p->value . "\n\n";
    }
    echo "\n\n";
}

Esto creará un objeto Zend_Gdata_Gapps_GroupFeed que contiene cada grupo del dominio.

Alternativamente, llame a getGroupFeed() sobre un objeto de servicio sin argumentos.

$feed = $gdata->getGroupFeed();

foreach ($feed->entry as $entry) {
    foreach ($entry->property as $p) {
        echo "Property Name: " . $p->name;
        echo "\nProperty Value: " . $p->value . "\n\n";
    }
    echo "\n\n";
}

Para eliminar un grupo, llame al método de conveniencia deleteGroup():

$gdata->deleteGroup('friends');

Los grupos se pueden actualizar llamando al método de conveniencia updateGroup():

$gdata->updateGroup('group-id-here', 'Group Name Here');

El primer parámetro es obligatorio. El segundo, tercer y cuarto parámetro, que representan el nombre del grupo, la descripción del grupo y el permiso de correo, respectivamente, son opcionales. Establecer cualquiera de estos parámetros opcionales a null no actualizará ese elemento.

Para obtener todos los grupos de los que una persona en particular es miembro, llame al método de conveniencia retrieveGroups():

$feed = $gdata->retrieveGroups('baz@somewhere.com');

foreach ($feed->entry as $entry) {
    foreach ($entry->property as $p) {
        echo "Property Name: " . $p->name;
        echo "\nProperty Value: " . $p->value . "\n\n";
    }
    echo "\n\n";
}

Esto creará un objeto Zend_Gdata_Gapps_GroupFeed que contiene cada grupo asociado al miembro especificado.

Alternativamente, cree un nuevo Zend_Gdata_Gapps_GroupQuery, establezca su propiedad member a la dirección de correo deseada, y envíe la consulta llamando a getGroupFeed() sobre un objeto de servicio.

$query = $gdata->newGroupQuery();
$query->setMember('baz@somewhere.com');
$feed = $gdata->getGroupFeed($query);

foreach ($feed->entry as $entry) {
    foreach ($entry->property as $p) {
        echo "Property Name: " . $p->name;
        echo "\nProperty Value: " . $p->value . "\n\n";
    }
    echo "\n\n";
}

Para añadir un miembro a un grupo, simplemente llame al método de conveniencia addMemberToGroup():

$gdata->addMemberToGroup('bar@somewhere.com', 'friends');

Para comprobar si un miembro pertenece a un grupo, simplemente llame al método de conveniencia isMember():

$isMember = $gdata->isMember('bar@somewhere.com', 'friends');
var_dump($isMember);

El método devuelve un valor booleano. Si el miembro pertenece al grupo especificado, el método devuelve true; en caso contrario, devuelve false.

Para eliminar un miembro de un grupo, llame al método de conveniencia removeMemberFromGroup():

$gdata->removeMemberFromGroup('baz', 'friends');

El método de conveniencia retrieveAllMembers() se puede usar para obtener la lista de miembros de un grupo:

$feed = $gdata->retrieveAllMembers('friends');

foreach ($feed as $member) {
    foreach ($member->property as $p) {
        echo "Property Name: " . $p->name;
        echo "\nProperty Value: " . $p->value . "\n\n";
    }
}

Alternativamente, construya un nuevo MemberQuery, establezca su propiedad groupId para que coincida con el id de grupo deseado, y llame a getMemberFeed() sobre un objeto de servicio.

$query = $gdata->newMemberQuery();
$query->setGroupId('friends');
$feed = $gdata->getMemberFeed($query);

foreach ($feed as $member) {
    foreach ($member->property as $p) {
        echo "Property Name: " . $p->name;
        echo "\nProperty Value: " . $p->value . "\n\n";
    }
}

Esto creará un objeto Zend_Gdata_Gapps_MemberFeed que contiene cada miembro del grupo seleccionado.

Para añadir un propietario a un grupo, simplemente llame al método de conveniencia addOwnerToGroup():

$gdata->addOwnerToGroup('bar@somewhere.com', 'friends');

El método de conveniencia retrieveGroupOwners() se puede usar para obtener la lista de propietarios de un grupo:

$feed = $gdata->retrieveGroupOwners('friends');

foreach ($feed as $owner) {
    foreach ($owner->property as $p) {
        echo "Property Name: " . $p->name;
        echo "\nProperty Value: " . $p->value . "\n\n";
    }
}

Alternativamente, construya un nuevo OwnerQuery, establezca su propiedad groupId para que coincida con el id de grupo deseado, y llame a getOwnerFeed() sobre un objeto de servicio.

$query = $gdata->newOwnerQuery();
$query->setGroupId('friends');
$feed = $gdata->getOwnerFeed($query);

foreach ($feed as $owner) {
    foreach ($owner->property as $p) {
        echo "Property Name: " . $p->name;
        echo "\nProperty Value: " . $p->value . "\n\n";
    }
}

Esto creará un objeto Zend_Gdata_Gapps_OwnerFeed que contiene cada miembro del grupo seleccionado.

Para comprobar si un correo es el propietario de un grupo, simplemente llame al método de conveniencia isOwner():

$isOwner = $gdata->isOwner('bar@somewhere.com', 'friends');
var_dump($isOwner);

El método devuelve un valor booleano. Si el correo es el propietario de el grupo especificado, el método devuelve true; en caso contrario, devuelve false.

Para eliminar un propietario de un grupo, llame al método de conveniencia removeOwnerFromGroup():

$gdata->removeOwnerFromGroup('baz@somewhere.com', 'friends');

Las listas de correo se pueden crear llamando al método de conveniencia createEmailList():

$gdata->createEmailList('friends');

Las listas de correo también se pueden crear instanciando EmailListEntry, proporcionando un nombre para la lista, y luego llamando a insertEmailList() sobre un objeto de servicio para subir la entrada al servidor.

$list = $gdata->newEmailListEntry();
$list->emailList = $gdata->newEmailList('friends');
$list = $gdata->insertEmailList($list);

Para obtener todas las listas de correo a las que un destinatario particular está suscrito, llame al método de conveniencia retrieveEmailLists():

$feed = $gdata->retrieveEmailLists('baz@somewhere.com');

foreach ($feed as $list) {
    echo '  * ' . $list->emailList->name . "\n";
}

Esto creará un objeto Zend_Gdata_Gapps_EmailListFeed que contiene cada lista de correo asociada al destinatario especificado.

Alternativamente, cree un nuevo Zend_Gdata_Gapps_EmailListQuery, establezca su propiedad recipient a la dirección de correo deseada, y envíe la consulta llamando a getEmailListFeed() sobre un objeto de servicio.

$query = $gdata->newEmailListQuery();
$query->setRecipient('baz@somewhere.com');
$feed = $gdata->getEmailListFeed($query);

foreach ($feed as $list) {
    echo '  * ' . $list->emailList->name . "\n";
}

Para obtener todas las listas de correo de un dominio, llame al método de conveniencia retrieveAllEmailLists().

$feed = $gdata->retrieveAllEmailLists();

foreach ($feed as $list) {
    echo '  * ' . $list->emailList->name . "\n";
}

Esto creará un objeto Zend_Gdata_Gapps_EmailListFeed que contiene cada lista de correo del dominio.

Alternativamente, llame a getEmailListFeed() sobre un objeto de servicio sin argumentos.

$feed = $gdata->getEmailListFeed();

foreach ($feed as $list) {
    echo '  * ' . $list->emailList->name . "\n";
}

Para eliminar una lista de correo, llame al método de conveniencia deleteEmailList():

$gdata->deleteEmailList('friends');

Para añadir un destinatario a una lista de correo, simplemente llame al método de conveniencia addRecipientToEmailList():

$gdata->addRecipientToEmailList('bar@somewhere.com', 'friends');

El método de conveniencia retrieveAllRecipients() se puede usar para obtener la lista de suscriptores de una lista de correo:

$feed = $gdata->retrieveAllRecipients('friends');

foreach ($feed as $recipient) {
    echo '  * ' . $recipient->who->email . "\n";
}

Alternativamente, construya un nuevo EmailListRecipientQuery, establezca su propiedad emailListName para que coincida con la lista de correo deseada, y llame a getEmailListRecipientFeed() sobre un objeto de servicio.

$query = $gdata->newEmailListRecipientQuery();
$query->setEmailListName('friends');
$feed = $gdata->getEmailListRecipientFeed($query);

foreach ($feed as $recipient) {
    echo '  * ' . $recipient->who->email . "\n";
}

Esto creará un objeto Zend_Gdata_Gapps_EmailListRecipientFeed que contiene cada destinatario de la lista de correo seleccionada.

Para eliminar un destinatario de una lista de correo, llame al método de conveniencia removeRecipientFromEmailList():

$gdata->removeRecipientFromEmailList('baz@somewhere.com', 'friends');