Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Dean Sofer
committed
Jun 11, 2012
1 parent
c5ed3f5
commit 41dd1f0
Showing
1 changed file
with
3 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,61 +1,4 @@ | ||
# Vimeo API Plugin for CakePHP | ||
CakePHP PhotoBucket | ||
================= | ||
|
||
## Installation | ||
|
||
1. Clone/download the plugin to `plugins/vimeo` | ||
2. Clone/download the [apis plugin](https://github.com/ProLoser/CakePHP-Api-Datasources) to `plugins/apis` | ||
3. Add your configuration to `database.php` and set it to the model | ||
|
||
``` | ||
:: database.php :: | ||
var $codaset = array( | ||
'datasource' => 'Apis.Apis', | ||
'driver' => 'Vimeo.Vimeo', | ||
// These are only required for authenticated requests (write-access) | ||
'login' => '--Your API Key--', | ||
'password' => '--Your API Secret--', | ||
); | ||
:: my_model.php :: | ||
var $useDbConfig = 'codaset'; | ||
``` | ||
|
||
## Commands | ||
|
||
There are a variety of options available to you, however some combinations are required (for example 'wiki' requires 'username' and 'project') | ||
You can get an idea what's available to you by reading the [Vimeo API Documentation](https://developer.vimeo.com/apis) | ||
|
||
|
||
### Read: `find('all', $params)` | ||
|
||
Conditions: | ||
|
||
* username | ||
* find_email | ||
* user_id | ||
* video_id | ||
|
||
Fields: pass only one of these at a time as a string | ||
|
||
* people (requires username condition) | ||
* albums (requires user_id condition) | ||
* photos (requires video_id condition) | ||
|
||
**Example:** | ||
``` | ||
$data = $this->Model->find('all', array( | ||
'conditions' => array( | ||
'user_id' => $userId, | ||
), | ||
'fields' => 'sets', | ||
)); | ||
``` | ||
### Update | ||
Bold items are required | ||
|
||
### Delete | ||
Bold items are required | ||
|
||
### Create | ||
Bold items are required | ||
Refer to the [CakePHP Api Datasources project](https://github.com/ProLoser/CakePHP-Api-Datasources) for documentation |