diff options
Diffstat (limited to 'Auth/OpenID')
-rw-r--r-- | Auth/OpenID/Interface.php | 3 | ||||
-rw-r--r-- | Auth/OpenID/SQLStore.php | 8 |
2 files changed, 8 insertions, 3 deletions
diff --git a/Auth/OpenID/Interface.php b/Auth/OpenID/Interface.php index 511f0f8..adc0475 100644 --- a/Auth/OpenID/Interface.php +++ b/Auth/OpenID/Interface.php @@ -17,7 +17,8 @@ * This is the interface for the store objects the OpenID library * uses. It is a single class that provides all of the persistence * mechanisms that the OpenID library needs, for both servers and - * consumers. + * consumers. If you want to create an SQL-driven store, please see + * then {@link Auth_OpenID_SQLStore} class. * * @package OpenID * @author JanRain, Inc. <openid@janrain.com> diff --git a/Auth/OpenID/SQLStore.php b/Auth/OpenID/SQLStore.php index b5237dd..a23c045 100644 --- a/Auth/OpenID/SQLStore.php +++ b/Auth/OpenID/SQLStore.php @@ -37,12 +37,16 @@ require_once 'Auth/OpenID/Interface.php'; * * This class shouldn't be used directly. Use one of its subclasses * instead, as those contain the code necessary to use a specific - * database. + * database. If you're an OpenID integrator and you'd like to create + * an SQL-driven store that wraps an application's database + * abstraction, be sure to create a subclass of + * {@link Auth_OpenID_DatabaseConnection} that calls the application's + * database abstraction calls. Then, pass an instance of your new + * database connection class to your SQLStore subclass constructor. * * All methods other than the constructor and createTables should be * considered implementation details. * - * @access private * @package OpenID */ class Auth_OpenID_SQLStore extends Auth_OpenID_OpenIDStore { |