Class: Services_Scribd_User

Source Location: /Services_Scribd-0.2.0/Services/Scribd/User.php

Class Overview

Services_Scribd
   |
   --Services_Scribd_Common
      |
      --Services_Scribd_User

The interface for the "user" API endpoint. Allows the user to create an account and login to different accounts.

Author(s):

Rich Schumacher <rich.schu at gmail.com>

Copyright:

2009 Rich Schumacher <rich.schu@gmail.com>

Variables

$validEndpoints

Methods

Inherited Variables

Class: Services_Scribd_Common

Services_Scribd_Common::$account
Services_Scribd_Common::$arguments
Services_Scribd_Common::$requestAdapter

Class: Services_Scribd

Services_Scribd::$timeout

Inherited Methods

Class: Services_Scribd_Common

Services_Scribd_Common::__construct(): Prevents calls from bubbling up to Serices_Scribd::_construct()
Services_Scribd_Common::call(): Builds, sends, and returns the response for an API request
Services_Scribd_Common::getAvailableEndpoints(): Returns an array of endpoints for this driver
Services_Scribd_Common::sendRequest(): Sends the request to the Scribd API
Services_Scribd_Common::setRequestAdapter(): Sets the request adapter to use for this request
Services_Scribd_Common::__call(): Traps any requests to endpoints that are not defined

Class: Services_Scribd

Services_Scribd::__construct(): Sets the API key and optional API secret
Services_Scribd::getAccount(): Returns the current account instance
Services_Scribd::setAccount(): Sets the Scribd account to use
Services_Scribd::__get(): Loads individual endpoint drivers

Class Details

[line 35]
The interface for the "user" API endpoint. Allows the user to create an account and login to different accounts.

Author: Rich Schumacher <rich.schu@gmail.com>
Copyright: 2009 Rich Schumacher <rich.schu@gmail.com>
Link: http://www.scribd.com/developers/platform
License: New BSD License

[ Top ]

Class Variables

$validEndpoints = array(
        'getAutoSigninUrl',
        'login',
        'signup'
    )

[line 42]

Array of API endpoints that are supported

Access: public

Type:

array

[ Top ]

Method Detail

getAutoSigninUrl [line 57]

string getAutoSigninUrl(
[string
$redirectUrl = '/'])

Returns a URL that, when visited, will automatically log a user in and then redirect to the URL provided

Link: http://www.scribd.com/developers/platform/api/user_getautosigninurl
Access: public

Parameters:

string $redirectUrl — The URL to redirect to after logging in

[ Top ]

login [line 75]

SimpleXMLElement login(
string
$username, string
$password)

Signs in as an existing Scribd user and executes methods as that user

Link: http://www.scribd.com/developers/platform/api/user_login
Access: public

Parameters:

string	`$username`	—	The username or email address to login with
string	`$password`	—	Password of the account

[ Top ]

signup [line 98]

SimpleXMLElement signup(
string
$username, string
$password, [string
$email = null], [string
$name = null])

Creates a new Scribd account

Link: http://www.scribd.com/developers/platform/api/user_signup
Access: public

Parameters:

string	`$username`	—	The username to create
string	`$password`	—	Password to set
string	`$email`	—	Email to use for this account
string	`$name`	—	The user's name

[ Top ]

Class: Services_Scribd_User

Class Overview

Author(s):

Copyright:

Variables

Methods

Inherited Variables

Class: Services_Scribd_Common

Class: Services_Scribd

Inherited Methods

Class: Services_Scribd_Common

Class: Services_Scribd

Class Details

Class Variables

$validEndpoints = array( 'getAutoSigninUrl', 'login', 'signup' )

Method Detail

getAutoSigninUrl [line 57]

Parameters:

login [line 75]

Parameters:

signup [line 98]

Parameters:

$validEndpoints = array(
'getAutoSigninUrl',
'login',
'signup'
)