[ class tree: ] [ index: ] [ all elements ]

Index of all elements

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ l ] [ r ] [ s ] [ t ] [ u ] [ v ] [ _ ]

a

$account
in file Scribd.php, variable Services_Scribd::$account
    The Scribd account to use for requests
$account
in file Common.php, variable Services_Scribd_Common::$account
    The Scribd account to use for requests
$arguments
in file Common.php, variable Services_Scribd_Common::$arguments
    An array of arguments to send to the API
addDoc
in file Collections.php, method Services_Scribd_Collections::addDoc()
    Adds a document to an existing collection.
API
in file Scribd.php, class constant Services_Scribd::API
    URI of the API
Account.php
procedural page Account.php
top

b

browse
in file Docs.php, method Services_Scribd_Docs::browse()
    Returns a list of documents that meet filter criteria
top

c

call
in file Common.php, method Services_Scribd_Common::call()
    Builds, sends, and returns the response for an API request
changeSettings
in file Docs.php, method Services_Scribd_Docs::changeSettings()
    Changes metadata for one or many documents
create
in file Collections.php, method Services_Scribd_Collections::create()
    Creates a new collection.
Collections.php
procedural page Collections.php
Common.php
procedural page Common.php
top

d

delete
in file Collections.php, method Services_Scribd_Collections::delete()
    Deletes a collection.
delete
in file Docs.php, method Services_Scribd_Docs::delete()
    Deletes a document
Docs.php
procedural page Docs.php
Dummy.php
procedural page Dummy.php
top

e

Exception.php
procedural page Exception.php
top

f

featured
in file Docs.php, method Services_Scribd_Docs::featured()
    Return a list of featured documents
top

g

get
in file Thumbnail.php, method Services_Scribd_Thumbnail::get()
    Retrieves a URL to the thumbnail of a document, in a given size. Note that docs.getSettings and docs.getList also retrieve thumbnail URLs in default size - this method is really for resizing those.
getAccount
in file Scribd.php, method Services_Scribd::getAccount()
    Returns the current account instance
getAutoSigninUrl
in file User.php, method Services_Scribd_User::getAutoSigninUrl()
    Returns a URL that, when visited, will automatically log a user in and then redirect to the URL provided
getAvailableEndpoints
in file Common.php, method Services_Scribd_Common::getAvailableEndpoints()
    Returns an array of endpoints for this driver
getCategories
in file Docs.php, method Services_Scribd_Docs::getCategories()
    Fetch a list of categories
getConversionStatus
in file Docs.php, method Services_Scribd_Docs::getConversionStatus()
    Retrieves the conversion status of a document
getDownloadUrl
in file Docs.php, method Services_Scribd_Docs::getDownloadUrl()
    Gets a download URL for a particular document
getList
in file Docs.php, method Services_Scribd_Docs::getList()
    Revtrieves a list of documents owned by a user
getList
in file Collections.php, method Services_Scribd_Collections::getList()
    Retrieves a list of collections for a given user.
getSettings
in file Docs.php, method Services_Scribd_Docs::getSettings()
    Gets metadata about a particular document
getStats
in file Docs.php, method Services_Scribd_Docs::getStats()
    Retrieves statistics of a document
top

l

listDocs
in file Collections.php, method Services_Scribd_Collections::listDocs()
    Retrieves a list of documents in a given collection.
login
in file User.php, method Services_Scribd_User::login()
    Signs in as an existing Scribd user and executes methods as that user
top

r

$requestAdapter
in file Common.php, variable Services_Scribd_Common::$requestAdapter
    The HTTP request adapter to use
removeDoc
in file Collections.php, method Services_Scribd_Collections::removeDoc()
    Removes a document to an existing collection.
top

s

search
in file Docs.php, method Services_Scribd_Docs::search()
    Searches for the text string within Scribd documents
sendHeadRequest
in file Dummy.php, method Services_Scribd_Dummy::sendHeadRequest()
    Attempts to send a request with an unspported HTTP method
sendRequest
in file Common.php, method Services_Scribd_Common::sendRequest()
    Sends the request to the Scribd API
sendRequestThrowsException
in file Dummy.php, method Services_Scribd_Dummy::sendRequestThrowsException()
    Used for testing Services_Scribd_Common::sendRequest()
Services_Scribd
in file Scribd.php, class Services_Scribd
    The base class for the Scribd API interface. Takes care of defining common variables and loading the individual drivers.
Scribd.php
procedural page Scribd.php
Services_Scribd_Account
in file Account.php, class Services_Scribd_Account
    Basic value object that contains information for a Scribd account. Can be passed into Services_Scribd::__construct() and Services_Scribd_Common::__construct() to make requests.
Services_Scribd_Collections
in file Collections.php, class Services_Scribd_Collections
    The interface for the "collections" API endpoints. Provides all interaction that is associated with a collection of documents, such as creating and deleting collections as well as adding and removing documents to those collections.
Services_Scribd_Common
in file Common.php, class Services_Scribd_Common
    This class contains common logic needed for all the API endpoints. Handles tasks such as sending requests, signing the requests, etc.
Services_Scribd_Docs
in file Docs.php, class Services_Scribd_Docs
    The interface for the "docs" API endpoint. Provides all interaction that is associated with a specific document or several documents, such as uploading, editing, etc.
Services_Scribd_Dummy
in file Dummy.php, class Services_Scribd_Dummy
    Contains two simple methods that are only used to satisfy unit testing.
Services_Scribd_Exception
in file Exception.php, class Services_Scribd_Exception
    Generic exception thrown by Services_Scribd.
Services_Scribd_Thumbnail
in file Thumbnail.php, class Services_Scribd_Thumbnail
    The interface for the "thumbnail" API endpoint. Allows the user to retrieve a URL to the thumbnail of a document in a given size.
Services_Scribd_User
in file User.php, class Services_Scribd_User
    The interface for the "user" API endpoint. Allows the user to create an account and login to different accounts.
setAccount
in file Scribd.php, method Services_Scribd::setAccount()
    Sets the Scribd account to use
setAPISignatureManually
in file Dummy.php, method Services_Scribd_Dummy::setAPISignatureManually()
    Manually sets the api_sig value for the request
setRequestAdapter
in file Common.php, method Services_Scribd_Common::setRequestAdapter()
    Sets the request adapter to use for this request
signup
in file User.php, method Services_Scribd_User::signup()
    Creates a new Scribd account
top

t

$timeout
in file Scribd.php, variable Services_Scribd::$timeout
    Timeout to use when making the request
Thumbnail.php
procedural page Thumbnail.php
top

u

User.php
procedural page User.php
update
in file Collections.php, method Services_Scribd_Collections::update()
    Updates a new collection's name, description or privacy_type.
upload
in file Docs.php, method Services_Scribd_Docs::upload()
    Uploads and publishes a document from the filesystem
uploadFromUrl
in file Docs.php, method Services_Scribd_Docs::uploadFromUrl()
    Uploads and publishes a document from a URL
uploadThumb
in file Docs.php, method Services_Scribd_Docs::uploadThumb()
    XXX: This doesn't appear to be working; throwing 500's consistently.
top

v

$validEndpoints
in file User.php, variable Services_Scribd_User::$validEndpoints
    Array of API endpoints that are supported
$validEndpoints
in file Thumbnail.php, variable Services_Scribd_Thumbnail::$validEndpoints
    Array of API endpoints that are supported
$validEndpoints
in file Docs.php, variable Services_Scribd_Docs::$validEndpoints
    Array of API endpoints that are supported
$validEndpoints
in file Collections.php, variable Services_Scribd_Collections::$validEndpoints
    Array of API endpoints that are supported
top

_

__call
in file Common.php, method Services_Scribd_Common::__call()
    Traps any requests to endpoints that are not defined
__construct
in file Scribd.php, method Services_Scribd::__construct()
    Sets the API key and optional API secret
__construct
in file Account.php, method Services_Scribd_Account::__construct()
    Sets up the API key and secret if passed in
__construct
in file Common.php, method Services_Scribd_Common::__construct()
    Prevents calls from bubbling up to Serices_Scribd::_construct()
__get
in file Scribd.php, method Services_Scribd::__get()
    Loads individual endpoint drivers
__get
in file Account.php, method Services_Scribd_Account::__get()
    Gets a property of the class
__set
in file Account.php, method Services_Scribd_Account::__set()
    Sets a property of the class
top

Documentation generated on Sat, 06 Apr 2013 14:30:02 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.