• Home
• TijsVerkoyen
• Dropbox
• Dropbox

PHP Class TijsVerkoyen\Dropbox\Dropbox

Datei anzeigen Open project: tijsverkoyen/dropbox Class Usage Examples

Public Methods

Method	Description
__construct ( string $applicationKey, string $applicationSecret )	Default constructor
__destruct ( )	Default destructor
accountInfo ( ) : array	Retrieves information about the user's account.
copyRef ( string $path, bool[optional] $sandbox = false ) : array	Creates and returns a copy_ref to a file. This reference string can be used to copy that file to another user's Dropbox by passing it in as the fromCopyRef parameter on fileopsCopy.
delta ( string[optional] $cursor = null, string[optional] $locale = null ) : array	A way of letting you keep up with changes to files and folders in a user's Dropbox. You can periodically call /delta to get a list of "delta entries", which are instructions on how to update your local state to match the server's state.
fileopsCopy ( string[optional] $fromPath = null, string $toPath, string[optional] $fromCopyRef = null, string[optional] $locale = null, bool[optional] $sandbox = false ) : array	Copies a file or folder to a new location.
fileopsCreateFolder ( string $path, string[optional] $locale = null, bool[optional] $sandbox = false ) : array	Creates a folder.
fileopsDelete ( string $path, string[optional] $locale = null, bool[optional] $sandbox = false ) : array	Deletes a file or folder.
fileopsMove ( string $fromPath, string $toPath, string[optional] $locale = null, bool[optional] $sandbox = false ) : array	Moves a file or folder to a new location.
filesGet ( string $path, string[optional] $rev = null, bool[optional] $sandbox = false ) : array	Downloads a file.
filesPost ( string $path, string $localFile, bool[optional] $overwrite = null, string[optional] $parentRev = null, $locale = null, bool[optional] $sandbox = false ) : array	Uploads a file.
getTimeOut ( ) : integer	Get the timeout
getUserAgent ( ) : string	Get the useragent that will be used.
media ( string $path, string[optional] $locale = null, bool[optional] $sandbox = false ) : array	Returns a link directly to a file.
metadata ( string[optional] $path = '', int[optional] $fileLimit = 10000, string[optional] $hash = false, bool[optional] $list = true, bool[optional] $includeDeleted = false, string[optional] $rev = null, string[optional] $locale = null, bool[optional] $sandbox = false ) : array	Retrieves file and folder metadata.
oAuthAccessToken ( string $oauthToken ) : array	Step 3 of authentication. After the /oauth/authorize step is complete, the application can call /oauth/access_token to acquire an access token.
oAuthAuthorize ( string $oauthToken, string[optional] $oauthCallback = null, string[optional] $locale = null )	Step 2 of authentication. Applications should direct the user to /oauth/authorize. This isn't an API call per se, but rather a web endpoint that lets the user sign in to Dropbox and choose whether to grant the application the ability to access files on their behalf. The page served by /oauth/authorize should be presented to the user through their web browser. Without the user's authorization in this step, it isn't possible for your application to obtain an access token from /oauth/access_token.
oAuthRequestToken ( ) : array	Step 1 of authentication. Obtain an OAuth request token to be used for the rest of the authentication process.
restore ( string $path, string $rev, string[optional] $locale = null, bool[optional] $sandbox = false ) : array	Restores a file path to a previous revision.
revisions ( string $path, int[optional] $revLimit = 10, string[optional] $locale = null, bool[optional] $sandbox = false ) : array	Obtains metadata for the previous revisions of a file.
search ( string $path, string $query, int[optional] $fileLimit = 1000, bool[optional] $includeDeleted = null, string[optional] $locale = null, bool[optional] $sandbox = false ) : array	Returns metadata for all files and folders whose filename contains the given search string as a substring.
setOAuthToken ( string $token )	Set the oAuth-token
setOAuthTokenSecret ( string $secret )	Set the oAuth-secret
setTimeOut ( integer $seconds )	Set the timeout
setUserAgent ( string $userAgent )	Get the useragent that will be used.
shares ( string $path, boolean $shortUrl = true, string[optional] $locale = null, bool[optional] $sandbox = false ) : array	Creates and returns a Dropbox link to files or folders users can use to view a preview of the file in a web browser.
thumbnails ( string[optional] $path, string[optional] $size = 'small', string[optional] $format = 'jpeg', bool[optional] $sandbox = false ) : string	Gets a thumbnail for an image.

Private Methods

Method	Description
buildQuery ( array $parameters ) : string	Format the parameters as a querystring
calculateHeader ( array $parameters, string $url ) : string	Build the Authorization header
doCall ( string $url, array $parameters = null, string[optional] $method = 'GET', $filePath = null, $expectJSON = true, $isContent = false ) : string	Make the call
doOAuthCall ( string $url, array $parameters = null, string[optional] $method = 'POST', bool[optional] $expectJSON = true ) : mixed	Make an call to the oAuth
getApplicationKey ( ) : string	Get the application key
getApplicationSecret ( ) : string	Get the application secret
getOAuthToken ( ) : string	Get the oAuth-token
getOAuthTokenSecret ( ) : string	Get the oAuth-token-secret
setApplicationKey ( string $key )	Set the application key
setApplicationSecret ( string $secret )	Set the application secret
urlencode_rfc3986 ( mixed $value ) : string	URL-encode method for internal use

Method Details