OpenID.pkg 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. <refentry id="{@id}">
  2. <refnamediv>
  3. <refname>PHP OpenID API</refname>
  4. </refnamediv>
  5. <refsynopsisdiv>
  6. <author>
  7. JanRain, Inc.
  8. <authorblurb>
  9. {@link mailto:openid@janrain.com openid@janrain.com}
  10. </authorblurb>
  11. </author>
  12. </refsynopsisdiv>
  13. <para>
  14. This is a complete implementation of the OpenID authentication
  15. protocol. This package contains:
  16. <itemizedlist>
  17. <listitem>An OpenID server</listitem>
  18. <listitem>An OpenID consumer</listitem>
  19. <listitem>Stores for MySQL, PostgreSQL, SQLite, and filesystem-based OpenID data storage</listitem>
  20. <listitem>PHPUnit unit tests</listitem>
  21. <listitem>An example server and consumer</listitem>
  22. </itemizedlist>
  23. </para>
  24. <refsect1 id="{@id users}">
  25. <title>For Package Users</title>
  26. <para>
  27. To install this package, copy the <literal>Auth/</literal>
  28. directory in this package to a directory in your PHP include path.
  29. Alternatively, modify your PHP include path to include the
  30. directory that contains <literal>Auth/</literal>. Any
  31. applications that need this package will then be able to use it.
  32. </para>
  33. </refsect1>
  34. <refsect1 id="{@id developers}">
  35. <title>For Developers</title>
  36. <para>
  37. See the server and consumer examples in the
  38. <literal>examples/</literal> directory of the package. For
  39. details on how to run the examples, see
  40. <literal>examples/README</literal>. If you want to create your
  41. own OpenID data storage class, please see the {@link Auth_OpenID_OpenIDStore}
  42. class. For information on integrating OpenID relying party support into your site, see
  43. the class documentation for {@link Consumer.php}.
  44. </para>
  45. </refsect1>
  46. <refsect1 id="{@id references}">
  47. <title>References</title>
  48. <para>
  49. <itemizedlist>
  50. <listitem>
  51. {@link http://github.com/openid/php-openid PHP OpenID Library}
  52. </listitem>
  53. <listitem>
  54. {@link http://www.janrain.com JanRain, Inc.}
  55. </listitem>
  56. <listitem>
  57. {@link http://openid.net/developers/dev-mailing-lists/ OpenID Development Discussion Lists}
  58. </listitem>
  59. </itemizedlist>
  60. </para>
  61. </refsect1>
  62. </refentry>