From 06f945f27840b53e57795dadbc38e76f7e11ab1c Mon Sep 17 00:00:00 2001 From: Horus3 Date: Mon, 24 Feb 2014 16:42:14 +0100 Subject: init --- .../manual/core/en/zend.gdata.clientlogin.html | 218 +++++++++++++++++++++ 1 file changed, 218 insertions(+) create mode 100644 zend/documentation/manual/core/en/zend.gdata.clientlogin.html (limited to 'zend/documentation/manual/core/en/zend.gdata.clientlogin.html') diff --git a/zend/documentation/manual/core/en/zend.gdata.clientlogin.html b/zend/documentation/manual/core/en/zend.gdata.clientlogin.html new file mode 100644 index 0000000..ef4a7f7 --- /dev/null +++ b/zend/documentation/manual/core/en/zend.gdata.clientlogin.html @@ -0,0 +1,218 @@ + + + + + Authenticating with ClientLogin - Zend Framework Manual + + + + + + + + +
+ + + + + + + + +
+ Using the Book Search Data API + +
Zend_Gdata
+ Programmer's Reference Guide
+ 		+ +
+
+

Authenticating with ClientLogin

+ + +

+ The ClientLogin mechanism enables you to write PHP application + that acquire authenticated access to Google Services, + specifying a user's credentials in the HTTP Client. +

+ +

+ See » http://code.google.com/apis/accounts/AuthForInstalledApps.html + for more information about Google Data ClientLogin authentication. +

+ +

+ The Google documentation says the ClientLogin mechanism is appropriate + for "installed applications" whereas the AuthSub mechanism is + for "web applications." The difference is that AuthSub requires + interaction from the user, and a browser interface that can react + to redirection requests. The ClientLogin solution uses PHP code to + supply the account credentials; the user is not required to enter her + credentials interactively. +

+ +

+ The account credentials supplied via the ClientLogin mechanism must + be valid credentials for Google services, but they are not required + to be those of the user who is using the PHP application. +

+ +

Creating a ClientLogin authenticated Http Client

+ + +

+ The process of creating an authenticated HTTP client using + the ClientLogin mechanism is to call the static function + Zend_Gdata_ClientLogin::getHttpClient() + and pass the Google account credentials in plain text. + The return value of this function is an object of class + Zend_Http_Client. +

+ +

+ The optional third parameter is the name of the Google Data + service. For instance, this can be 'cl' for Google Calendar. + The default is "xapi", which is recognized by Google Data + servers as a generic service name. +

+ +

+ The optional fourth parameter is an instance of Zend_Http_Client. + This allows you to set options in the client, such as proxy + server settings. If you pass NULL for this + parameter, a generic Zend_Http_Client object is created. +

+ +

+ The optional fifth parameter is a short string that Google Data + servers use to identify the client application for logging + purposes. By default this is string "Zend-ZendFramework"; +

+ +

+ The optional sixth parameter is a string ID for a + CAPTCHA challenge that has been issued by + the server. It is only necessary when logging in after receiving + a CAPTCHA challenge from a previous + login attempt. +

+ +

+ The optional seventh parameter is a user's response to a + CAPTCHA challenge that has been issued by + the server. It is only necessary when logging in after receiving + a CAPTCHA challenge from a previous + login attempt. +

+ +

+ Below is an example of PHP code for a web application + to acquire authentication to use the Google Calendar service + and create a Zend_Gdata client object using that authenticated + Zend_Http_Client. +

+ +
  1. // Enter your Google account credentials
    2. +
  2. $email = 'johndoe@gmail.com';
    3. +
  3. $passwd = 'xxxxxxxx';
    4. +
  4. try {
    5. +
  5.    $client = Zend_Gdata_ClientLogin::getHttpClient($email, $passwd, 'cl');
    6. +
  6. } catch (Zend_Gdata_App_CaptchaRequiredException $cre) {
    7. +
  7.     echo 'URL of CAPTCHA image: ' . $cre->getCaptchaUrl() . "\n";
    8. +
  8.     echo 'Token ID: ' . $cre->getCaptchaToken() . "\n";
    9. +
  9. } catch (Zend_Gdata_App_AuthException $ae) {
    10. +
  10.    echo 'Problem authenticating: ' . $ae->exception() . "\n";
    11. +
  11. }
    12. +
  12.  
    13. +
  13. $cal = new Zend_Gdata_Calendar($client);
+ +
+ +

Terminating a ClientLogin authenticated Http Client

+ + +

+ There is no method to revoke ClientLogin authentication as there + is in the AuthSub token-based solution. The credentials used + in the ClientLogin authentication are the login and password + to a Google account, and therefore these can be used repeatedly + in the future. +

+
+
+
+ + + + + + + + + +
+ Using the Book Search Data API + +
Zend_Gdata
+ Programmer's Reference Guide
+ 		+ +
+		 + +
+ + \ No newline at end of file -- cgit v1.2.3