mirror of
https://github.com/SociallyDev/Spaces-API.git
synced 2024-11-21 01:31:50 -08:00
53 lines
1.4 KiB
Markdown
53 lines
1.4 KiB
Markdown
# This library is deprecated
|
|
We recommend using the [official SDK](https://github.com/DigitalOceanPHP/Client) or the [Laravel package](https://github.com/GrahamCampbell/Laravel-DigitalOcean)
|
|
|
|
All issues will be closed and new PRs will not be accepted
|
|
|
|
## Installation
|
|
Install via composer
|
|
```
|
|
composer require sociallydev/spaces-api
|
|
```
|
|
|
|
## Quick start
|
|
|
|
Obtain API keys from the [Digital Ocean Applications & API dashboard](https://cloud.digitalocean.com/account/api/tokens)
|
|
|
|
```php
|
|
use SpacesAPI\Spaces;
|
|
|
|
// Connect to a space
|
|
$spaces = new Spaces('api-key', 'api-secret');
|
|
$space = $spaces->space('space-name');
|
|
|
|
// Download a file
|
|
$file = $space->file('remote-file-1.txt');
|
|
$file->download('local/file/path/file.txt');
|
|
|
|
// Upload text to a file
|
|
$file2 = $space->uploadText("Lorem ipsum","remote-file-2.txt");
|
|
|
|
// Get a signed public link, valid for 2 hours
|
|
$file2url = $file2->getSignedURL("2 hours");
|
|
|
|
// Make a copy
|
|
$file3 = $file2->copy('remote-file-3.txt');
|
|
|
|
// Move or rename a file
|
|
$file2->move('new-filename.txt')
|
|
|
|
// Make a file public and get the URL
|
|
$file3->makePublic();
|
|
$file3url = $file3->getURL();
|
|
```
|
|
|
|
See more examples in [docs/Examples.md](docs/Examples.md)
|
|
|
|
## Upgrading?
|
|
Version 3 has many changes over version 2, so we have written a [migration guide](docs/Upgrade2-3.md)
|
|
|
|
## API reference
|
|
* [\SpacesAPI\Spaces](docs/Spaces.md)
|
|
* [\SpacesAPI\Space](docs/Space.md)
|
|
* [\SpacesAPI\File](docs/File.md)
|