- User Authorization/Authentication
- User Credentials Flow Authentication
- Access to all GET, PUT, POST and DELETE Resources
- Media File Download/Upload
PHP 5.3 or higher.
Notice: We'll be dropping official support for PHP versions 5.3, 5.4 and 5.5
after the 30th of June 2016.
The package may still work with those versions of PHP after the above date, but it will not be guaranteed.
Recommended installation is through composer.
Include njasm\soundcloud
in your project, by adding it to your composer.json
file.
{
"require": {
"njasm/soundcloud": "dev-master"
}
}
If you don't use composer
to manage your project dependencies, this library provides your with an
autoload.php
You just need to include autoload.php in your project to start using the library as you would if installed through
composer
.
Include Njasm\Soundcloud\
namespace in the script where you intend to use SoundcloudFacade
or Soundcloud
class.
use Njasm\Soundcloud\SoundcloudFacade;
// or soundcloud if you don't need a facade for specific tasks
use Njasm\Soundcloud\Soundcloud;
SoundcloudFacade.php
provides you with boilerplate code to get authorization url, change a code for a token, etc etc..
$facade = new SoundcloudFacade($clientID, $clientSecret, $callbackUri);
$url = $facade->getAuthUrl();
// or inject your specific request params
$url = $facade->getAuthUrl(
array(
'response_type' => 'code',
'scope' => '*',
'state' => 'my_app_state_code'
)
);
$facade = new SoundcloudFacade($clientID, $clientSecret, $callbackUri);
// this is your callbackUri script that will receive the $_GET['code']
$code = $_GET['code'];
$facade->codeForToken($code);
If an access token is returned from soundcloud, it will be automatically set for future requests. The Response object will always be returned to the client.
$facade = new SoundcloudFacade($clientID, $clientSecret);
$facade->userCredentials($username, $password); // on success, access_token is set by default for next requests.
$response = $facade->get('/me')->request();
// raw/string body response
echo $response->bodyRaw();
// as object
echo $response->bodyObject()->id;
// as array
$array = $response->bodyArray();
Note: Soundcloud.com stopped sending responses in xml format, the methods are kept in the 2.x.x versions, but calling them will have no effect on the request, all requests will have an accept header of application/json.
...
$response = $facade->get('/tracks')->asJson()->request();
// or
$response = $facade->get('/tracks')->asXml()->request();
// argument array style
$facade->get('/resolve', array('url' => 'http://www.soundcloud.com/hybrid-species'));
// chaining-methods
$response = $facade
->get('/resolve')
->setParams(array('url' => 'http://www.soundcloud.com/hybrid-species'));
// or not
$facade->get('/resolve');
$facade->setParams(array('url' => 'http://www.soundcloud.com/hybrid-species'));
To allow different ways to set the Resource parameters that you are accessing - by submitting an array or setParams() method injection. The request will only be sent to soundcloud, when you invoke the request() method. Take in considerations that specific operations like userCredentials(), download(), etc. will invoke request() automatically.
$soundcloud = new Soundcloud($clientID, $clientSecret);
$soundcloud->get('/resolve', array('url' => 'http://www.soundcloud.com/hybrid-species'));
// only this invocation will send the request
$response = $soundcloud->request();
...
$theBodyString = $facade->request()->bodyRaw();
// after having the access token
// build the playlist data array
$playlistData = array(
'playlist' => array('title' => 'Great Playlist!', 'sharing' => 'public')
);
$response = $soundcloud->post('/playlists', $playlistData)->request();
// now add tracks, get playlist id from response
// build tracks array
$tracks = array(
'playlist' => array(
'tracks' => array(
array('id' => 29720509), // track id
array('id' => 26057359) // other track id
)
)
);
// put tracks into playlist
$response = $soundcloud->put('/playlists/' . $response->bodyObject()->id, $tracks)->request();
// if you want the CURL response object from last CURL request.
$response = $facade->getCurlResponse();
// this will redirect user, sending a header Location to the track.
$response = $facade->download($trackID);
// redirect user to download URL suplied by soundcloud.
header('Loacation: ' . $response->getHeader('Location'));
// CAUTION: this will get the track into an in-memory variable in your server.
$response = $facade->download($trackID, true);
// save it to a file.
file_put_contents("great_track.mp3", $response->bodyRaw());
$trackPath = '/home/njasm/great.mp3';
$trackData = array(
'title' => 'Cool track title',
'downloadable' => true,
'artwork_data' => new \CURLFile('artwork.jpg'),
// .... more metadata maybe?
);
$response = $facade->upload($trackPath, $trackData);
// or old-school trackdata array declaration also work, example.
$trackData = array(
'track[title]' => 'Cool track title',
'track[downloadable]' => true,
'track[artwork_data]' => new \CURLFile('artwork.jpg'),
// .... more metadata maybe?
);
$response = $facade->upload($trackPath, $trackData);