Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

initial commit

  • Loading branch information...
commit 50a53c2b0a1f0413bb923a09803ccf33cf26052a 0 parents
@zachgraves zachgraves authored
Showing with 7,343 additions and 0 deletions.
  1. +22 −0 INSTALL.txt
  2. +86 −0 LICENSE.txt
  3. +43 −0 README.txt
  4. +39 −0 docs/html/annotated.html
  5. +38 −0 docs/html/classCookieSessionStore-members.html
  6. +238 −0 docs/html/classCookieSessionStore.html
  7. +35 −0 docs/html/classOAuthClient-members.html
  8. +292 −0 docs/html/classOAuthClient.html
  9. +33 −0 docs/html/classYahooApplication-members.html
  10. +148 −0 docs/html/classYahooApplication.html
  11. +36 −0 docs/html/classYahooConfig-members.html
  12. +56 −0 docs/html/classYahooConfig.html
  13. +35 −0 docs/html/classYahooLogger-members.html
  14. +210 −0 docs/html/classYahooLogger.html
  15. +39 −0 docs/html/classYahooSession-members.html
  16. +356 −0 docs/html/classYahooSession.html
  17. +45 −0 docs/html/classYahooUser-members.html
  18. +552 −0 docs/html/classYahooUser.html
  19. +35 −0 docs/html/classes.html
  20. +48 −0 docs/html/deprecated.html
  21. +441 −0 docs/html/doxygen.css
  22. BIN  docs/html/doxygen.png
  23. +177 −0 docs/html/functions.html
  24. +177 −0 docs/html/functions_func.html
  25. +25 −0 docs/html/index.html
  26. +38 −0 docs/html/interfaceYahooSessionStore-members.html
  27. +238 −0 docs/html/interfaceYahooSessionStore.html
  28. +27 −0 docs/html/pages.html
  29. BIN  docs/html/tab_b.gif
  30. BIN  docs/html/tab_l.gif
  31. BIN  docs/html/tab_r.gif
  32. +105 −0 docs/html/tabs.css
  33. +806 −0 lib/JSON.php
  34. +819 −0 lib/OAuth.php
  35. +1,818 −0 lib/Yahoo.inc
  36. +83 −0 lib/YahooSessionStore.inc
  37. +77 −0 sample/popupmanager.js
  38. +126 −0 sample/sampleapp.php
22 INSTALL.txt
@@ -0,0 +1,22 @@
+Yahoo! OS PHP SDK
+=============
+After downloading and unpackaging the release, copy the contents of yosdk/lib
+to a directory that is accessible via the PHP require/require_once methods. In
+your PHP scripts, require the Yahoo.inc file:
+
+ require("Yahoo.inc");
+
+or
+
+ require_once("Yahoo.inc");
+
+Now you should be ready to instantiate your YahooSession object and get
+started.
+
+Sample Application
+==================
+In the yosdk/sample directory you'll find sampleapp.php, a sample application
+that will get you started. Put the file in your hosting directory and fill
+in the consumer key, consumer key secret and application ID. When you're done,
+point your browser at the URL. You will be directed to verify access to the
+application and then you will be redirected back to your application.
86 LICENSE.txt
@@ -0,0 +1,86 @@
+Yahoo! Social API PHP SDK
+Software License Agreement (BSD License)
+Copyright (c) 2009, Yahoo! Inc.
+All rights reserved.
+
+Redistribution and use of this software in source and binary forms, with
+or without modification, are permitted provided that the following
+conditions are met:
+
+* Redistributions of source code must retain the above
+ copyright notice, this list of conditions and the
+ following disclaimer.
+
+* Redistributions in binary form must reproduce the above
+ copyright notice, this list of conditions and the
+ following disclaimer in the documentation and/or other
+ materials provided with the distribution.
+
+* Neither the name of Yahoo! Inc. nor the names of its
+ contributors may be used to endorse or promote products
+ derived from this software without specific prior
+ written permission of Yahoo! Inc.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+This code also contains software from the following sources -
+
+MIT License - for PHP OAuth Library
+
+Copyright © 2007 Andy Smith
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+------------------------------------------------------------------------------
+
+BSD License - for JSON encoder and decoder
+
+Copyright © 2008 Michal Migurski
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
+NO EVENT SHALL CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
43 README.txt
@@ -0,0 +1,43 @@
+This project only accepts contributions licensed under the BSD open source license. See the Open Source Initiative’s approved template below.
+Each file submitted should contain the following information in the header:
+
+// Created by [contributor]
+// Copyright (c) [enter owning person entity, year]. All Rights Reserved.
+// Licensed under the BSD (revised) open source license.
+
+Here is the Open Source Initiative BSD License Template (http://opensource.org/licenses/bsd-license.php ):
+
+-------------------------------------
+Copyright (c) <YEAR>, <OWNER>
+All rights reserved.
+
+Redistribution and use of this software in source and binary forms, with
+or without modification, are permitted provided that the following
+conditions are met:
+
+* Redistributions of source code must retain the above
+ copyright notice, this list of conditions and the
+ following disclaimer.
+
+* Redistributions in binary form must reproduce the above
+ copyright notice, this list of conditions and the
+ following disclaimer in the documentation and/or other
+ materials provided with the distribution.
+
+* Neither the name of <ORGANIZATION> nor the names of its
+ contributors may be used to endorse or promote products
+ derived from this software without specific prior
+ written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+-------------------------------------
39 docs/html/annotated.html
@@ -0,0 +1,39 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Yahoo! OS SDK - PHP: Class List</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li class="current"><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+ <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table>
+ <tr><td class="indexkey"><a class="el" href="classCookieSessionStore.html">CookieSessionStore</a></td><td class="indexvalue">Cookie-based implementation of the session store </td></tr>
+ <tr><td class="indexkey"><a class="el" href="classOAuthClient.html">OAuthClient</a></td><td class="indexvalue">A simple OAuth client class for making 2 and 3 legged OAuth HTTP requests </td></tr>
+ <tr><td class="indexkey"><a class="el" href="classYahooApplication.html">YahooApplication</a></td><td class="indexvalue">Represents a Yahoo! application </td></tr>
+ <tr><td class="indexkey"><a class="el" href="classYahooConfig.html">YahooConfig</a></td><td class="indexvalue"></td></tr>
+ <tr><td class="indexkey"><a class="el" href="classYahooLogger.html">YahooLogger</a></td><td class="indexvalue">Logging wrapper for the Yahoo objects </td></tr>
+ <tr><td class="indexkey"><a class="el" href="classYahooSession.html">YahooSession</a></td><td class="indexvalue">Defines a session between an application and the Yahoo! platform </td></tr>
+ <tr><td class="indexkey"><a class="el" href="interfaceYahooSessionStore.html">YahooSessionStore</a></td><td class="indexvalue">The session store interface </td></tr>
+ <tr><td class="indexkey"><a class="el" href="classYahooUser.html">YahooUser</a></td><td class="indexvalue">Represents a Yahoo! user </td></tr>
+</table>
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 12 11:42:06 2009 for Yahoo! OS SDK - PHP by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>
38 docs/html/classCookieSessionStore-members.html
@@ -0,0 +1,38 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Yahoo! OS SDK - PHP: Member List</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+ <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>CookieSessionStore Member List</h1>This is the complete list of members for <a class="el" href="classCookieSessionStore.html">CookieSessionStore</a>, including all inherited members.<p><table>
+ <tr class="memlist"><td><a class="el" href="classCookieSessionStore.html#8b218a8e777af8195206a2f8c7584bfb">clearAccessToken</a>()</td><td><a class="el" href="classCookieSessionStore.html">CookieSessionStore</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classCookieSessionStore.html#1cfd7b2849eb6b6689e824db6e0b78b8">clearRequestToken</a>()</td><td><a class="el" href="classCookieSessionStore.html">CookieSessionStore</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classCookieSessionStore.html#d8e5789977d7c58325cd638f9818e08e">fetchAccessToken</a>()</td><td><a class="el" href="classCookieSessionStore.html">CookieSessionStore</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classCookieSessionStore.html#55c14bb37f6667036cad0df169b94e00">fetchRequestToken</a>()</td><td><a class="el" href="classCookieSessionStore.html">CookieSessionStore</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classCookieSessionStore.html#1a78c8cb6016603d770dfd6e63f07e6e">hasAccessToken</a>()</td><td><a class="el" href="classCookieSessionStore.html">CookieSessionStore</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classCookieSessionStore.html#59168c48ddf99d039fb35a808c7efb88">hasRequestToken</a>()</td><td><a class="el" href="classCookieSessionStore.html">CookieSessionStore</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classCookieSessionStore.html#5168ab204a1f9db6261b6adb19bc7e67">storeAccessToken</a>($token)</td><td><a class="el" href="classCookieSessionStore.html">CookieSessionStore</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classCookieSessionStore.html#e3f7951a0e413801766ab7ae9aa509b8">storeRequestToken</a>($token)</td><td><a class="el" href="classCookieSessionStore.html">CookieSessionStore</a></td><td></td></tr>
+</table></div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 12 11:42:06 2009 for Yahoo! OS SDK - PHP by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>
238 docs/html/classCookieSessionStore.html
@@ -0,0 +1,238 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Yahoo! OS SDK - PHP: CookieSessionStore Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+ <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>CookieSessionStore Class Reference</h1><!-- doxytag: class="CookieSessionStore" -->Cookie-based implementation of the session store.
+<a href="#_details">More...</a>
+<p>
+
+<p>
+<a href="classCookieSessionStore-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCookieSessionStore.html#59168c48ddf99d039fb35a808c7efb88">hasRequestToken</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCookieSessionStore.html#1a78c8cb6016603d770dfd6e63f07e6e">hasAccessToken</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCookieSessionStore.html#e3f7951a0e413801766ab7ae9aa509b8">storeRequestToken</a> ($token)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCookieSessionStore.html#55c14bb37f6667036cad0df169b94e00">fetchRequestToken</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCookieSessionStore.html#1cfd7b2849eb6b6689e824db6e0b78b8">clearRequestToken</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCookieSessionStore.html#5168ab204a1f9db6261b6adb19bc7e67">storeAccessToken</a> ($token)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCookieSessionStore.html#d8e5789977d7c58325cd638f9818e08e">fetchAccessToken</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCookieSessionStore.html#8b218a8e777af8195206a2f8c7584bfb">clearAccessToken</a> ()</td></tr>
+
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Cookie-based implementation of the session store. This is the default session storage used by the Y!OS PHP SDK. Developers are free to implement their own session store implementations and pass them to <a class="el" href="classYahooSession.html#7beba218bfb6489e7aad5fe42e71eed7">YahooSession::hasSession</a>, <a class="el" href="classYahooSession.html#c21ba0c858b456ca29ccacac45c77fa1">YahooSession::requireSession</a> and <a class="el" href="classYahooSession.html#a0ba86381b9b0cde07a13bb5993d8ed3">YahooSession::clearSession</a>. By default, if no session store is passed to <a class="el" href="classYahooSession.html#7beba218bfb6489e7aad5fe42e71eed7">YahooSession::hasSession</a> or <a class="el" href="classYahooSession.html#c21ba0c858b456ca29ccacac45c77fa1">YahooSession::requireSession</a>, an instance of a <a class="el" href="classCookieSessionStore.html" title="Cookie-based implementation of the session store.">CookieSessionStore</a> is used. <hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="8b218a8e777af8195206a2f8c7584bfb"></a><!-- doxytag: member="CookieSessionStore::clearAccessToken" ref="8b218a8e777af8195206a2f8c7584bfb" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">CookieSessionStore::clearAccessToken </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Clears the access token from the session store.<p>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, false otherwise. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="1cfd7b2849eb6b6689e824db6e0b78b8"></a><!-- doxytag: member="CookieSessionStore::clearRequestToken" ref="1cfd7b2849eb6b6689e824db6e0b78b8" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">CookieSessionStore::clearRequestToken </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Clears the request token from the session store.<p>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, false otherwise. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="d8e5789977d7c58325cd638f9818e08e"></a><!-- doxytag: member="CookieSessionStore::fetchAccessToken" ref="d8e5789977d7c58325cd638f9818e08e" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">CookieSessionStore::fetchAccessToken </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Fetches and returns the access token from the session store.<p>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>The access token. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="55c14bb37f6667036cad0df169b94e00"></a><!-- doxytag: member="CookieSessionStore::fetchRequestToken" ref="55c14bb37f6667036cad0df169b94e00" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">CookieSessionStore::fetchRequestToken </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Fetches and returns the request token from the session store.<p>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>The request token. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="1a78c8cb6016603d770dfd6e63f07e6e"></a><!-- doxytag: member="CookieSessionStore::hasAccessToken" ref="1a78c8cb6016603d770dfd6e63f07e6e" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">CookieSessionStore::hasAccessToken </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Indicates if the session store has an access token.<p>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if an access token is present, false otherwise. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="59168c48ddf99d039fb35a808c7efb88"></a><!-- doxytag: member="CookieSessionStore::hasRequestToken" ref="59168c48ddf99d039fb35a808c7efb88" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">CookieSessionStore::hasRequestToken </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Indicates if the session store has a request token.<p>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if a request token is present, false otherwise. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="5168ab204a1f9db6261b6adb19bc7e67"></a><!-- doxytag: member="CookieSessionStore::storeAccessToken" ref="5168ab204a1f9db6261b6adb19bc7e67" args="($token)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">CookieSessionStore::storeAccessToken </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>token</em> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Stores the given access token in the session store.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$token</em>&nbsp;</td><td>A PHP stdclass object containing the components of the OAuth access token. </td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, false otherwise. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="e3f7951a0e413801766ab7ae9aa509b8"></a><!-- doxytag: member="CookieSessionStore::storeRequestToken" ref="e3f7951a0e413801766ab7ae9aa509b8" args="($token)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">CookieSessionStore::storeRequestToken </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>token</em> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Stores the given request token in the session store.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$token</em>&nbsp;</td><td>A PHP stdclass object containing the components of the OAuth request token. </td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, false otherwise. </dd></dl>
+
+</div>
+</div><p>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li>lib/Yahoo.inc</ul>
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 12 11:42:06 2009 for Yahoo! OS SDK - PHP by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>
35 docs/html/classOAuthClient-members.html
@@ -0,0 +1,35 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Yahoo! OS SDK - PHP: Member List</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+ <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>OAuthClient Member List</h1>This is the complete list of members for <a class="el" href="classOAuthClient.html">OAuthClient</a>, including all inherited members.<p><table>
+ <tr class="memlist"><td><a class="el" href="classOAuthClient.html#c004d060d34ff29aa72e2e49099f0b9c">delete</a>($url, $queryParameters=array(), $timeout=NULL)</td><td><a class="el" href="classOAuthClient.html">OAuthClient</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classOAuthClient.html#3cfcc565829a32a882a2d42cca6cceb1">get</a>($url, $queryParameters=array(), $timeout=NULL)</td><td><a class="el" href="classOAuthClient.html">OAuthClient</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classOAuthClient.html#d5b399d48cac687dfc942818be08c0ae">OAuthClient</a>($consumer, $token=NULL, $oauthParamsLocation=OAUTH_PARAMS_IN_HEADERS, $signatureMethod=OAUTH_SIGNATURE_HMAC_SHA1)</td><td><a class="el" href="classOAuthClient.html">OAuthClient</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classOAuthClient.html#5d2414f77009af140567fb931c481963">post</a>($url, $contentType=&quot;application/x-www-form-urlencoded&quot;, $content=array(), $timeout=NULL)</td><td><a class="el" href="classOAuthClient.html">OAuthClient</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classOAuthClient.html#f551fd033c64168bbd6165af364bca26">put</a>($url, $contentType, $content, $timeout=NULL)</td><td><a class="el" href="classOAuthClient.html">OAuthClient</a></td><td></td></tr>
+</table></div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 12 11:42:06 2009 for Yahoo! OS SDK - PHP by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>
292 docs/html/classOAuthClient.html
@@ -0,0 +1,292 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Yahoo! OS SDK - PHP: OAuthClient Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+ <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>OAuthClient Class Reference</h1><!-- doxytag: class="OAuthClient" -->A simple OAuth client class for making 2 and 3 legged OAuth HTTP requests.
+<a href="#_details">More...</a>
+<p>
+
+<p>
+<a href="classOAuthClient-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOAuthClient.html#d5b399d48cac687dfc942818be08c0ae">OAuthClient</a> ($consumer, $token=NULL, $oauthParamsLocation=OAUTH_PARAMS_IN_HEADERS, $signatureMethod=OAUTH_SIGNATURE_HMAC_SHA1)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOAuthClient.html#3cfcc565829a32a882a2d42cca6cceb1">get</a> ($url, $queryParameters=array(), $timeout=NULL)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOAuthClient.html#c004d060d34ff29aa72e2e49099f0b9c">delete</a> ($url, $queryParameters=array(), $timeout=NULL)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOAuthClient.html#f551fd033c64168bbd6165af364bca26">put</a> ($url, $contentType, $content, $timeout=NULL)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOAuthClient.html#5d2414f77009af140567fb931c481963">post</a> ($url, $contentType=&quot;application/x-www-form-urlencoded&quot;, $content=array(), $timeout=NULL)</td></tr>
+
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+A simple OAuth client class for making 2 and 3 legged OAuth HTTP requests. <hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="c004d060d34ff29aa72e2e49099f0b9c"></a><!-- doxytag: member="OAuthClient::delete" ref="c004d060d34ff29aa72e2e49099f0b9c" args="($url, $queryParameters=array(), $timeout=NULL)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">OAuthClient::delete </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>url</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>queryParameters</em> = <code>array()</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>timeout</em> = <code>NULL</code></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Executes a properly signed OAuth HTTP DELETE request.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$url</em>&nbsp;</td><td>The URL to request. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$queryParameters</em>&nbsp;</td><td>Any query string parameters to be sent in the request. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$timeout</em>&nbsp;</td><td>Optional, the number of seconds to wait for the request to return. </td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>The response object. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="3cfcc565829a32a882a2d42cca6cceb1"></a><!-- doxytag: member="OAuthClient::get" ref="3cfcc565829a32a882a2d42cca6cceb1" args="($url, $queryParameters=array(), $timeout=NULL)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">OAuthClient::get </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>url</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>queryParameters</em> = <code>array()</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>timeout</em> = <code>NULL</code></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Executes a properly signed OAuth HTTP GET request.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$url</em>&nbsp;</td><td>The URL to request. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$queryParameters</em>&nbsp;</td><td>Any query string parameters to be sent in the request. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$timeout</em>&nbsp;</td><td>Optional, the number of seconds to wait for the request to return. </td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>The response object. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="d5b399d48cac687dfc942818be08c0ae"></a><!-- doxytag: member="OAuthClient::OAuthClient" ref="d5b399d48cac687dfc942818be08c0ae" args="($consumer, $token=NULL, $oauthParamsLocation=OAUTH_PARAMS_IN_HEADERS, $signatureMethod=OAUTH_SIGNATURE_HMAC_SHA1)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">OAuthClient::OAuthClient </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>consumer</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>token</em> = <code>NULL</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>oauthParamsLocation</em> = <code>OAUTH_PARAMS_IN_HEADERS</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>signatureMethod</em> = <code>OAUTH_SIGNATURE_HMAC_SHA1</code></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Constructs a new OAuth client.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$consumer</em>&nbsp;</td><td>The OAuthConsumer object to use for the requests. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$token</em>&nbsp;</td><td>The OAuthToken to use for the requests. Optional. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$oauthParamsLocation</em>&nbsp;</td><td>OAUTH_PARAMS_IN_HEADERS or OAUTH_PARAMS_IN_POST_BODY, depending on where you want the OAuth parameters to show up. Optional, defaults to using the headers. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$signatureMethod</em>&nbsp;</td><td>OAUTH_SIGNATURE_PLAINTEXT or OAUTH_SIGNATURE_HMAC_SHA1, depending on what request signing mechanism to use. Optional, defaults to HMAC SHA1 signatures. </td></tr>
+ </table>
+</dl>
+
+</div>
+</div><p>
+<a class="anchor" name="5d2414f77009af140567fb931c481963"></a><!-- doxytag: member="OAuthClient::post" ref="5d2414f77009af140567fb931c481963" args="($url, $contentType=&quot;application/x&#45;www&#45;form&#45;urlencoded&quot;, $content=array(), $timeout=NULL)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">OAuthClient::post </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>url</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>contentType</em> = <code>&quot;application/x-www-form-urlencoded&quot;</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>content</em> = <code>array()</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>timeout</em> = <code>NULL</code></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Executes a properly signed OAuth HTTP POST request.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$url</em>&nbsp;</td><td>The URL to request. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$contentType</em>&nbsp;</td><td>The Content-Type of the POST data. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$content</em>&nbsp;</td><td>The content to be POST. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$timeout</em>&nbsp;</td><td>Optional, the number of seconds to wait for the request to return. </td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>The response object. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="f551fd033c64168bbd6165af364bca26"></a><!-- doxytag: member="OAuthClient::put" ref="f551fd033c64168bbd6165af364bca26" args="($url, $contentType, $content, $timeout=NULL)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">OAuthClient::put </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>url</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>contentType</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>content</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>timeout</em> = <code>NULL</code></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Executes a properly signed OAuth HTTP PUT request.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$url</em>&nbsp;</td><td>The URL to request. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$contentType</em>&nbsp;</td><td>The Content-Type of the PUT data. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$content</em>&nbsp;</td><td>The raw content to be PUT. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$timeout</em>&nbsp;</td><td>Optional, the number of seconds to wait for the request to return. </td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>The response object. </dd></dl>
+
+</div>
+</div><p>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li>lib/Yahoo.inc</ul>
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 12 11:42:06 2009 for Yahoo! OS SDK - PHP by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>
33 docs/html/classYahooApplication-members.html
@@ -0,0 +1,33 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Yahoo! OS SDK - PHP: Member List</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+ <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>YahooApplication Member List</h1>This is the complete list of members for <a class="el" href="classYahooApplication.html">YahooApplication</a>, including all inherited members.<p><table>
+ <tr class="memlist"><td><a class="el" href="classYahooApplication.html#d7c8a10d2a3e62f841731005ae7e6d8f">query</a>($yql)</td><td><a class="el" href="classYahooApplication.html">YahooApplication</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooApplication.html#fbe6567acf8a84fcc8a282198923d5ba">setSmallView</a>($guid, $content)</td><td><a class="el" href="classYahooApplication.html">YahooApplication</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooApplication.html#23916689357b866cd81e6234095b2cdf">YahooApplication</a>($consumerKey, $consumerKeySecret)</td><td><a class="el" href="classYahooApplication.html">YahooApplication</a></td><td></td></tr>
+</table></div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 12 11:42:06 2009 for Yahoo! OS SDK - PHP by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>
148 docs/html/classYahooApplication.html
@@ -0,0 +1,148 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Yahoo! OS SDK - PHP: YahooApplication Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+ <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>YahooApplication Class Reference</h1><!-- doxytag: class="YahooApplication" -->Represents a Yahoo! application.
+<a href="#_details">More...</a>
+<p>
+
+<p>
+<a href="classYahooApplication-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooApplication.html#23916689357b866cd81e6234095b2cdf">YahooApplication</a> ($consumerKey, $consumerKeySecret)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooApplication.html#fbe6567acf8a84fcc8a282198923d5ba">setSmallView</a> ($guid, $content)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooApplication.html#d7c8a10d2a3e62f841731005ae7e6d8f">query</a> ($yql)</td></tr>
+
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Represents a Yahoo! application. <hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="d7c8a10d2a3e62f841731005ae7e6d8f"></a><!-- doxytag: member="YahooApplication::query" ref="d7c8a10d2a3e62f841731005ae7e6d8f" args="($yql)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">YahooApplication::query </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>yql</em> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Executes the given YQL query.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$yql</em>&nbsp;</td><td>The query to execute. </td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>The response or NULL if the request fails.. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="fbe6567acf8a84fcc8a282198923d5ba"></a><!-- doxytag: member="YahooApplication::setSmallView" ref="fbe6567acf8a84fcc8a282198923d5ba" args="($guid, $content)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">YahooApplication::setSmallView </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>guid</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>content</em></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Sets the small view for the user given by the GUID.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$guid</em>&nbsp;</td><td>The GUID of the user to set the small view for. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$content</em>&nbsp;</td><td>The content to set the small view to. </td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, false otherwise. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="23916689357b866cd81e6234095b2cdf"></a><!-- doxytag: member="YahooApplication::YahooApplication" ref="23916689357b866cd81e6234095b2cdf" args="($consumerKey, $consumerKeySecret)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">YahooApplication::YahooApplication </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>consumerKey</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>consumerKeySecret</em></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Constructs a new <a class="el" href="classYahooApplication.html" title="Represents a Yahoo! application.">YahooApplication</a> object.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$consumerKey</em>&nbsp;</td><td>The consumer key of the application. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$consumerKeySecret</em>&nbsp;</td><td>The consumer key secret of the application. </td></tr>
+ </table>
+</dl>
+
+</div>
+</div><p>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li>lib/Yahoo.inc</ul>
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 12 11:42:06 2009 for Yahoo! OS SDK - PHP by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>
36 docs/html/classYahooConfig-members.html
@@ -0,0 +1,36 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Yahoo! OS SDK - PHP: Member List</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+ <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>YahooConfig Member List</h1>This is the complete list of members for <a class="el" href="classYahooConfig.html">YahooConfig</a>, including all inherited members.<p><table>
+ <tr bgcolor="#f0f0f0"><td><b>setOauthHostname</b>($hostname) (defined in <a class="el" href="classYahooConfig.html">YahooConfig</a>)</td><td><a class="el" href="classYahooConfig.html">YahooConfig</a></td><td></td></tr>
+ <tr bgcolor="#f0f0f0"><td><b>setPresenceWsHostname</b>($hostname) (defined in <a class="el" href="classYahooConfig.html">YahooConfig</a>)</td><td><a class="el" href="classYahooConfig.html">YahooConfig</a></td><td></td></tr>
+ <tr bgcolor="#f0f0f0"><td><b>setQueryWsHostname</b>($hostname) (defined in <a class="el" href="classYahooConfig.html">YahooConfig</a>)</td><td><a class="el" href="classYahooConfig.html">YahooConfig</a></td><td></td></tr>
+ <tr bgcolor="#f0f0f0"><td><b>setSocialWsHostname</b>($hostname) (defined in <a class="el" href="classYahooConfig.html">YahooConfig</a>)</td><td><a class="el" href="classYahooConfig.html">YahooConfig</a></td><td></td></tr>
+ <tr bgcolor="#f0f0f0"><td><b>setUpdatesWsHostname</b>($hostname) (defined in <a class="el" href="classYahooConfig.html">YahooConfig</a>)</td><td><a class="el" href="classYahooConfig.html">YahooConfig</a></td><td></td></tr>
+ <tr bgcolor="#f0f0f0"><td><b>setYapWsHostname</b>($hostname) (defined in <a class="el" href="classYahooConfig.html">YahooConfig</a>)</td><td><a class="el" href="classYahooConfig.html">YahooConfig</a></td><td></td></tr>
+</table></div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 12 11:42:06 2009 for Yahoo! OS SDK - PHP by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>
56 docs/html/classYahooConfig.html
@@ -0,0 +1,56 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Yahoo! OS SDK - PHP: YahooConfig Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+ <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>YahooConfig Class Reference</h1><!-- doxytag: class="YahooConfig" -->
+<p>
+<a href="classYahooConfig-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2497aed012f724315d07b542274a28b2"></a><!-- doxytag: member="YahooConfig::setSocialWsHostname" ref="2497aed012f724315d07b542274a28b2" args="($hostname)" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><b>setSocialWsHostname</b> ($hostname)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3e98c6a9e87cb751f7bdaf179bb2a522"></a><!-- doxytag: member="YahooConfig::setPresenceWsHostname" ref="3e98c6a9e87cb751f7bdaf179bb2a522" args="($hostname)" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><b>setPresenceWsHostname</b> ($hostname)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eac9aa523e1800063da5d6481a6acae7"></a><!-- doxytag: member="YahooConfig::setUpdatesWsHostname" ref="eac9aa523e1800063da5d6481a6acae7" args="($hostname)" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><b>setUpdatesWsHostname</b> ($hostname)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="decffa697d9bfe550c35b16b36eeacbb"></a><!-- doxytag: member="YahooConfig::setQueryWsHostname" ref="decffa697d9bfe550c35b16b36eeacbb" args="($hostname)" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><b>setQueryWsHostname</b> ($hostname)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="341022d5a43d09d133c009cf23c1fb6c"></a><!-- doxytag: member="YahooConfig::setOauthHostname" ref="341022d5a43d09d133c009cf23c1fb6c" args="($hostname)" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><b>setOauthHostname</b> ($hostname)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b19e2a8cfdf21f33cd6d1c73ef8496aa"></a><!-- doxytag: member="YahooConfig::setYapWsHostname" ref="b19e2a8cfdf21f33cd6d1c73ef8496aa" args="($hostname)" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><b>setYapWsHostname</b> ($hostname)</td></tr>
+
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Interface to modify the underlying configuration of the library. <hr>The documentation for this class was generated from the following file:<ul>
+<li>lib/Yahoo.inc</ul>
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 12 11:42:06 2009 for Yahoo! OS SDK - PHP by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>
35 docs/html/classYahooLogger-members.html
@@ -0,0 +1,35 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Yahoo! OS SDK - PHP: Member List</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+ <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>YahooLogger Member List</h1>This is the complete list of members for <a class="el" href="classYahooLogger.html">YahooLogger</a>, including all inherited members.<p><table>
+ <tr class="memlist"><td><a class="el" href="classYahooLogger.html#36f327ced65083bbc70720a0ae8d468b">debug</a>($message, $object=NULL)</td><td><a class="el" href="classYahooLogger.html">YahooLogger</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooLogger.html#8458cd59a5d7e52365afa009749425c9">error</a>($message, $object=NULL)</td><td><a class="el" href="classYahooLogger.html">YahooLogger</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooLogger.html#2d0ffca931fc397692ff82c6beeb5098">info</a>($message, $object=NULL)</td><td><a class="el" href="classYahooLogger.html">YahooLogger</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooLogger.html#61263935ab7c3bda5d0036525dd1d774">setDebug</a>($debug)</td><td><a class="el" href="classYahooLogger.html">YahooLogger</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooLogger.html#c3e51245c704ba441790d53dc1a8472b">setDebugDestination</a>($destination)</td><td><a class="el" href="classYahooLogger.html">YahooLogger</a></td><td></td></tr>
+</table></div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 12 11:42:06 2009 for Yahoo! OS SDK - PHP by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>
210 docs/html/classYahooLogger.html
@@ -0,0 +1,210 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Yahoo! OS SDK - PHP: YahooLogger Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+ <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>YahooLogger Class Reference</h1><!-- doxytag: class="YahooLogger" -->Logging wrapper for the Yahoo objects.
+<a href="#_details">More...</a>
+<p>
+
+<p>
+<a href="classYahooLogger-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooLogger.html#36f327ced65083bbc70720a0ae8d468b">debug</a> ($message, $object=NULL)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooLogger.html#2d0ffca931fc397692ff82c6beeb5098">info</a> ($message, $object=NULL)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooLogger.html#8458cd59a5d7e52365afa009749425c9">error</a> ($message, $object=NULL)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooLogger.html#61263935ab7c3bda5d0036525dd1d774">setDebug</a> ($debug)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooLogger.html#c3e51245c704ba441790d53dc1a8472b">setDebugDestination</a> ($destination)</td></tr>
+
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Logging wrapper for the Yahoo objects. <hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="36f327ced65083bbc70720a0ae8d468b"></a><!-- doxytag: member="YahooLogger::debug" ref="36f327ced65083bbc70720a0ae8d468b" args="($message, $object=NULL)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">YahooLogger::debug </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>message</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>object</em> = <code>NULL</code></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Log a message at the debug level.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$message</em>&nbsp;</td><td>The message to log. </td></tr>
+ </table>
+</dl>
+
+</div>
+</div><p>
+<a class="anchor" name="8458cd59a5d7e52365afa009749425c9"></a><!-- doxytag: member="YahooLogger::error" ref="8458cd59a5d7e52365afa009749425c9" args="($message, $object=NULL)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">YahooLogger::error </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>message</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>object</em> = <code>NULL</code></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Log a message at the error level.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$message</em>&nbsp;</td><td>The message to log. </td></tr>
+ </table>
+</dl>
+
+</div>
+</div><p>
+<a class="anchor" name="2d0ffca931fc397692ff82c6beeb5098"></a><!-- doxytag: member="YahooLogger::info" ref="2d0ffca931fc397692ff82c6beeb5098" args="($message, $object=NULL)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">YahooLogger::info </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>message</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>object</em> = <code>NULL</code></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Log a message at the info level.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$message</em>&nbsp;</td><td>The message to log. </td></tr>
+ </table>
+</dl>
+
+</div>
+</div><p>
+<a class="anchor" name="61263935ab7c3bda5d0036525dd1d774"></a><!-- doxytag: member="YahooLogger::setDebug" ref="61263935ab7c3bda5d0036525dd1d774" args="($debug)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">YahooLogger::setDebug </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>debug</em> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Enables/disables session debugging.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$debug</em>&nbsp;</td><td>Boolean to enable/disable debugging. </td></tr>
+ </table>
+</dl>
+
+</div>
+</div><p>
+<a class="anchor" name="c3e51245c704ba441790d53dc1a8472b"></a><!-- doxytag: member="YahooLogger::setDebugDestination" ref="c3e51245c704ba441790d53dc1a8472b" args="($destination)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">YahooLogger::setDebugDestination </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>destination</em> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Allows callers to configure where debugging output is sent.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$destination</em>&nbsp;</td><td>"LOG" to use error_log, "CONSOLE" to use printf, "NULL" to disable all logging output. </td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>boolean True on success, false on failure. </dd></dl>
+
+</div>
+</div><p>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li>lib/Yahoo.inc</ul>
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 12 11:42:06 2009 for Yahoo! OS SDK - PHP by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>
39 docs/html/classYahooSession-members.html
@@ -0,0 +1,39 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Yahoo! OS SDK - PHP: Member List</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+ <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>YahooSession Member List</h1>This is the complete list of members for <a class="el" href="classYahooSession.html">YahooSession</a>, including all inherited members.<p><table>
+ <tr class="memlist"><td><a class="el" href="classYahooSession.html#a0ba86381b9b0cde07a13bb5993d8ed3">clearSession</a>($sessionStore=NULL)</td><td><a class="el" href="classYahooSession.html">YahooSession</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooSession.html#6bfb9d946487fa2087a73bac0a3deb12">createAuthorizationUrl</a>($consumerKey, $consumerSecret, $callback=NULL, $sessionStore=NULL)</td><td><a class="el" href="classYahooSession.html">YahooSession</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooSession.html#4980bdd193cf09e4947aa4ccb0a2b15b">getOwner</a>()</td><td><a class="el" href="classYahooSession.html">YahooSession</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooSession.html#97ad3a29ea16880703add423f2085de0">getSessionedUser</a>()</td><td><a class="el" href="classYahooSession.html">YahooSession</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooSession.html#666aa94b4442e4c12f78fdc9f9060d7a">getUser</a>($guid)</td><td><a class="el" href="classYahooSession.html">YahooSession</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooSession.html#7beba218bfb6489e7aad5fe42e71eed7">hasSession</a>($consumerKey, $consumerSecret, $applicationId=NULL, $sessionStore=NULL, $verifier=NULL)</td><td><a class="el" href="classYahooSession.html">YahooSession</a></td><td></td></tr>
+ <tr bgcolor="#f0f0f0"><td><b>initSessionFromYAP</b>($consumerKey, $consumerSecret, $appid) (defined in <a class="el" href="classYahooSession.html">YahooSession</a>)</td><td><a class="el" href="classYahooSession.html">YahooSession</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooSession.html#0c8ada338fb4fa4e280213d7caa75b58">query</a>($yql)</td><td><a class="el" href="classYahooSession.html">YahooSession</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooSession.html#c21ba0c858b456ca29ccacac45c77fa1">requireSession</a>($consumerKey, $consumerSecret, $applicationId=NULL, $callback=NULL, $sessionStore=NULL, $verifier=NULL)</td><td><a class="el" href="classYahooSession.html">YahooSession</a></td><td></td></tr>
+</table></div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 12 11:42:06 2009 for Yahoo! OS SDK - PHP by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>
356 docs/html/classYahooSession.html
@@ -0,0 +1,356 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Yahoo! OS SDK - PHP: YahooSession Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+ <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>YahooSession Class Reference</h1><!-- doxytag: class="YahooSession" -->Defines a session between an application and the Yahoo! platform.
+<a href="#_details">More...</a>
+<p>
+
+<p>
+<a href="classYahooSession-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooSession.html#97ad3a29ea16880703add423f2085de0">getSessionedUser</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooSession.html#4980bdd193cf09e4947aa4ccb0a2b15b">getOwner</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooSession.html#666aa94b4442e4c12f78fdc9f9060d7a">getUser</a> ($guid)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooSession.html#0c8ada338fb4fa4e280213d7caa75b58">query</a> ($yql)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooSession.html#a0ba86381b9b0cde07a13bb5993d8ed3">clearSession</a> ($sessionStore=NULL)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooSession.html#7beba218bfb6489e7aad5fe42e71eed7">hasSession</a> ($consumerKey, $consumerSecret, $applicationId=NULL, $sessionStore=NULL, $verifier=NULL)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooSession.html#c21ba0c858b456ca29ccacac45c77fa1">requireSession</a> ($consumerKey, $consumerSecret, $applicationId=NULL, $callback=NULL, $sessionStore=NULL, $verifier=NULL)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classYahooSession.html#6bfb9d946487fa2087a73bac0a3deb12">createAuthorizationUrl</a> ($consumerKey, $consumerSecret, $callback=NULL, $sessionStore=NULL)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8bba0ce779ea5e0e377175ccf0802383"></a><!-- doxytag: member="YahooSession::initSessionFromYAP" ref="8bba0ce779ea5e0e377175ccf0802383" args="($consumerKey, $consumerSecret, $appid)" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><b>initSessionFromYAP</b> ($consumerKey, $consumerSecret, $appid)</td></tr>
+
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Defines a session between an application and the Yahoo! platform. <hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="a0ba86381b9b0cde07a13bb5993d8ed3"></a><!-- doxytag: member="YahooSession::clearSession" ref="a0ba86381b9b0cde07a13bb5993d8ed3" args="($sessionStore=NULL)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">YahooSession::clearSession </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>sessionStore</em> = <code>NULL</code> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Destroys the current session, effectively logging out the current user.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$sessionStore</em>&nbsp;</td><td>The session store implementation to clear. See <a class="el" href="interfaceYahooSessionStore.html" title="The session store interface.">YahooSessionStore</a> for more information. If no session store is provided, clearSession will instantiate a <a class="el" href="classCookieSessionStore.html" title="Cookie-based implementation of the session store.">CookieSessionStore</a> and use that. </td></tr>
+ </table>
+</dl>
+
+</div>
+</div><p>
+<a class="anchor" name="6bfb9d946487fa2087a73bac0a3deb12"></a><!-- doxytag: member="YahooSession::createAuthorizationUrl" ref="6bfb9d946487fa2087a73bac0a3deb12" args="($consumerKey, $consumerSecret, $callback=NULL, $sessionStore=NULL)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">YahooSession::createAuthorizationUrl </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>consumerKey</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>consumerSecret</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>callback</em> = <code>NULL</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>sessionStore</em> = <code>NULL</code></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Creates authorization URLs, allowing applications to manage their user experience when the user needs to be sent to Yahoo! to authorize the application to access their account.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$consumerKey</em>&nbsp;</td><td>The OAuth consumer key. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$consumerSecret</em>&nbsp;</td><td>The OAuth consumer key secret. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$callback</em>&nbsp;</td><td>The callback URL to redirect the user to after they verify the application access. If no callback is provided, the current page URL will be used. Use the "oob" callback for desktop clients or for web clients where no callback should be used. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$sessionStore</em>&nbsp;</td><td>The session store implementation to use. See <a class="el" href="interfaceYahooSessionStore.html" title="The session store interface.">YahooSessionStore</a> for more information. If no session store is provided, createAuthorizationUrl will instantiate a <a class="el" href="classCookieSessionStore.html" title="Cookie-based implementation of the session store.">CookieSessionStore</a> and use that. </td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>stdclass A PHP object with two properties: "urlWithCallback" and "urlWithoutCallback". This allows the application to mix and match authorizations that do and don't have callbacks in the URLs. urlWithoutCallback is useful for JavaScript popup windows while urlWithCallback is useful for normal tags. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="4980bdd193cf09e4947aa4ccb0a2b15b"></a><!-- doxytag: member="YahooSession::getOwner" ref="4980bdd193cf09e4947aa4ccb0a2b15b" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">YahooSession::getOwner </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Gets the user who owns the application install. Only valid when viewed in YAP, otherwise will default to the logged-in user.<p>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classYahooUser.html" title="Represents a Yahoo! user.">YahooUser</a> The currently sessioned <a class="el" href="classYahooUser.html" title="Represents a Yahoo! user.">YahooUser</a>. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="97ad3a29ea16880703add423f2085de0"></a><!-- doxytag: member="YahooSession::getSessionedUser" ref="97ad3a29ea16880703add423f2085de0" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">YahooSession::getSessionedUser </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Gets the currently sessioned user.<p>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classYahooUser.html" title="Represents a Yahoo! user.">YahooUser</a> The currently sessioned <a class="el" href="classYahooUser.html" title="Represents a Yahoo! user.">YahooUser</a>. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="666aa94b4442e4c12f78fdc9f9060d7a"></a><!-- doxytag: member="YahooSession::getUser" ref="666aa94b4442e4c12f78fdc9f9060d7a" args="($guid)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">YahooSession::getUser </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>guid</em> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Gets the user indicated by the GUID given.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$guid</em>&nbsp;</td><td>The GUID of the user to get. </td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classYahooUser.html" title="Represents a Yahoo! user.">YahooUser</a> The user indicated by the GUID given. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="7beba218bfb6489e7aad5fe42e71eed7"></a><!-- doxytag: member="YahooSession::hasSession" ref="7beba218bfb6489e7aad5fe42e71eed7" args="($consumerKey, $consumerSecret, $applicationId=NULL, $sessionStore=NULL, $verifier=NULL)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">YahooSession::hasSession </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>consumerKey</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>consumerSecret</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>applicationId</em> = <code>NULL</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>sessionStore</em> = <code>NULL</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>verifier</em> = <code>NULL</code></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Checks to see if there is a session in this PHP page request. Doesn't cause any redirects for the user to log in, for that you should call <a class="el" href="classYahooSession.html#c21ba0c858b456ca29ccacac45c77fa1">requireSession()</a>.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$consumerKey</em>&nbsp;</td><td>The OAuth consumer key. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$consumerSecret</em>&nbsp;</td><td>The OAuth consumer key secret. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$applicationId</em>&nbsp;</td><td>The application ID, optional. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$sessionStore</em>&nbsp;</td><td>The session store implementation to use. See <a class="el" href="interfaceYahooSessionStore.html" title="The session store interface.">YahooSessionStore</a> for more information. If no session store is provided, clearSession will instantiate a <a class="el" href="classCookieSessionStore.html" title="Cookie-based implementation of the session store.">CookieSessionStore</a> and use that. </td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>boolean True if a session is present, false otherwise. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="0c8ada338fb4fa4e280213d7caa75b58"></a><!-- doxytag: member="YahooSession::query" ref="0c8ada338fb4fa4e280213d7caa75b58" args="($yql)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">YahooSession::query </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>yql</em> </td>
+ <td>&nbsp;)&nbsp;</td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Executes the given YQL query.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$yql</em>&nbsp;</td><td>The query to execute. </td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>The response or NULL if the request fails.. </dd></dl>
+
+</div>
+</div><p>
+<a class="anchor" name="c21ba0c858b456ca29ccacac45c77fa1"></a><!-- doxytag: member="YahooSession::requireSession" ref="c21ba0c858b456ca29ccacac45c77fa1" args="($consumerKey, $consumerSecret, $applicationId=NULL, $callback=NULL, $sessionStore=NULL, $verifier=NULL)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">YahooSession::requireSession </td>
+ <td>(</td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>consumerKey</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>consumerSecret</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>applicationId</em> = <code>NULL</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>callback</em> = <code>NULL</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>sessionStore</em> = <code>NULL</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">$&nbsp;</td>
+ <td class="paramname"> <em>verifier</em> = <code>NULL</code></td><td>&nbsp;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Requires that there be a session in this PHP page request. Generates a redirect for the user to log in, if necessary. You must call <a class="el" href="classYahooSession.html#c21ba0c858b456ca29ccacac45c77fa1">requireSession()</a> before any data is sent back to the user in order for the redirect to work.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>$consumerKey</em>&nbsp;</td><td>The OAuth consumer key. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$consumerSecret</em>&nbsp;</td><td>The OAuth consumer key secret. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$applicationId</em>&nbsp;</td><td>The application ID, optional. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$callback</em>&nbsp;</td><td>The callback URL to redirect the user to after they verify the application access. If no callback is provided, the current page URL will be used. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$sessionStore</em>&nbsp;</td><td>The session store implementation to use. See <a class="el" href="interfaceYahooSessionStore.html" title="The session store interface.">YahooSessionStore</a> for more information. If no session store is provided, clearSession will instantiate a <a class="el" href="classCookieSessionStore.html" title="Cookie-based implementation of the session store.">CookieSessionStore</a> and use that. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>$verifier</em>&nbsp;</td><td>The oauth_verifier returned by the OAuth servers after authorization. Passing NULL indicates that authorization was completed previously or that <a class="el" href="classYahooSession.html#c21ba0c858b456ca29ccacac45c77fa1">requireSession()</a> should look for oauth_verifier in the $_GET superglobal. </td></tr>
+ </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classYahooSession.html" title="Defines a session between an application and the Yahoo! platform.">YahooSession</a> The current session or NULL if a session cannot be established. </dd></dl>
+
+</div>
+</div><p>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li>lib/Yahoo.inc</ul>
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 12 11:42:06 2009 for Yahoo! OS SDK - PHP by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>
45 docs/html/classYahooUser-members.html
@@ -0,0 +1,45 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Yahoo! OS SDK - PHP: Member List</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+ <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>YahooUser Member List</h1>This is the complete list of members for <a class="el" href="classYahooUser.html">YahooUser</a>, including all inherited members.<p><table>
+ <tr class="memlist"><td><a class="el" href="classYahooUser.html#ef6cd0384d6d227ac2c561971e39dd20">deleteUpdate</a>($suid)</td><td><a class="el" href="classYahooUser.html">YahooUser</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooUser.html#1ff589a497ed5df46ac6d851a98e8f21">getConnections</a>(&amp;$start, &amp;$count, &amp;$total)</td><td><a class="el" href="classYahooUser.html">YahooUser</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooUser.html#43254dd1b4f363a94d5a4933b55244d3">getConnectionUpdates</a>($start=0, $count=10)</td><td><a class="el" href="classYahooUser.html">YahooUser</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooUser.html#d6f99252a4a6ba143a7aa45fab00c201">getContacts</a>($start=0, $count=10)</td><td><a class="el" href="classYahooUser.html">YahooUser</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooUser.html#876f2ac2bbb82da7687c33669ba3cc20">getPresence</a>()</td><td><a class="el" href="classYahooUser.html">YahooUser</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooUser.html#b718aac08956a14b4883f68ac7bf6b66">getProfile</a>()</td><td><a class="el" href="classYahooUser.html">YahooUser</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooUser.html#03034a5f53aef6a171a9cb2b386b5bd5">getStatus</a>()</td><td><a class="el" href="classYahooUser.html">YahooUser</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooUser.html#f34db1bdd5bf591d8ee4dff81d8bf3f2">getUpdates</a>($start=0, $count=10)</td><td><a class="el" href="classYahooUser.html">YahooUser</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooUser.html#a4b775a1aac79440f4d03e5227ac135c">insertUpdate</a>($suid, $title, $link, $description=&quot;&quot;, $date=NULL)</td><td><a class="el" href="classYahooUser.html">YahooUser</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooUser.html#0fd2cca3152f6aea52571e145ef53090">listConnectionUpdates</a>($start=0, $count=10)</td><td><a class="el" href="classYahooUser.html">YahooUser</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooUser.html#1f1fdcb76405a74ff4343d430cb4842f">listUpdates</a>($start=0, $count=10)</td><td><a class="el" href="classYahooUser.html">YahooUser</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooUser.html#fea794b1eb8fa4ea07a4234db9c0e5ed">loadProfile</a>()</td><td><a class="el" href="classYahooUser.html">YahooUser</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooUser.html#792c2334495150a108114abcd9f591bd">setPresence</a>($status)</td><td><a class="el" href="classYahooUser.html">YahooUser</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooUser.html#0013a7a526c09293cc1fd935f08805d3">setSmallView</a>($content)</td><td><a class="el" href="classYahooUser.html">YahooUser</a></td><td></td></tr>
+ <tr class="memlist"><td><a class="el" href="classYahooUser.html#0dc1d31c5ae5825f9d03d927a7550e68">setStatus</a>($message)</td><td><a class="el" href="classYahooUser.html">YahooUser</a></td><td></td></tr>
+</table></div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 12 11:42:06 2009 for Yahoo! OS SDK - PHP by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>
552 docs/html/classYahooUser.html
@@ -0,0 +1,552 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Yahoo! OS SDK - PHP: YahooUser Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+ <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>YahooUser Class Reference</h1><!-- doxytag: class="YahooUser" -->Represents a Yahoo! user.