Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nao-pon/flysystem-google-drive
Flysystem adapter for Google Drive
https://github.com/nao-pon/flysystem-google-drive
Last synced: about 3 hours ago
JSON representation
Flysystem adapter for Google Drive
- Host: GitHub
- URL: https://github.com/nao-pon/flysystem-google-drive
- Owner: nao-pon
- License: mit
- Created: 2016-02-06T15:49:05.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-11-19T22:51:07.000Z (12 months ago)
- Last Synced: 2024-04-21T22:44:51.620Z (7 months ago)
- Language: PHP
- Size: 92.8 KB
- Stars: 345
- Watchers: 15
- Forks: 126
- Open Issues: 55
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# Flysystem Adapter for Google Drive
[](http://xoops.hypweb.net/)
[](LICENSE)
## Installation
- For Google Drive API V3
```bash
composer require nao-pon/flysystem-google-drive:~1.1
```
- For Google Drive API V2 "**Deprecated**"
```bash
composer require nao-pon/flysystem-google-drive:~1.0.0
```
## Usage
#### Follow [Google Docs](https://developers.google.com/drive/v3/web/enable-sdk) to obtain your `ClientId, ClientSecret & refreshToken` in addition you can also check this [easy-to-follow tutorial](https://gist.github.com/ivanvermeyen/cc7c59c185daad9d4e7cb8c661d7b89b)
- you can also check [This Example](https://github.com/nao-pon/flysystem-google-drive/blob/master/example/GoogleUpload.php) for a better understanding.
```php
$client = new \Google_Client();
$client->setClientId('[app client id].apps.googleusercontent.com');
$client->setClientSecret('[app client secret]');
$client->refreshToken('[your refresh token]');
$service = new \Google_Service_Drive($client);
$adapter = new \Hypweb\Flysystem\GoogleDrive\GoogleDriveAdapter($service, '['root' or folder ID]');
/* Recommended cached adapter use */
// $adapter = new \League\Flysystem\Cached\CachedAdapter(
// new \Hypweb\Flysystem\GoogleDrive\GoogleDriveAdapter($service, '['root' or folder ID]'),
// new \League\Flysystem\Cached\Storage\Memory()
// );
$filesystem = new \League\Flysystem\Filesystem($adapter);
```
### Usage to with [elFinder](https://github.com/Studio-42/elFinder)
```bash
composer require nao-pon/elfinder-flysystem-driver-ext
composer require nao-pon/flysystem-google-drive:~1.1
```
```php
// Load composer autoloader
require 'vender/autoload.php';
// Google API Client
$client = new \Google_Client();
$client->setClientId('xxxxx CLIENTID xxxxx');
$client->setClientSecret('xxxxx CLIENTSECRET xxxxx');
$client->refreshToken('xxxxx REFRESH TOKEN xxxxx');
// Google Drive Adapter
$googleDrive = new \Hypweb\Flysystem\GoogleDrive\GoogleDriveAdapter(
new \Google_Service_Drive($client), // Client service
'root', // Folder ID as root ('root' or Folder ID)
[ 'useHasDir' => true ] // options (elFinder need hasDir method)
);
// Extended cached strage adapter class for cache enabled of hasDir() method
class myCachedStrageAdapter extends \League\Flysystem\Cached\Storage\Adapter
{
use \Hypweb\Flysystem\Cached\Extra\Hasdir;
use \Hypweb\Flysystem\Cached\Extra\DisableEnsureParentDirectories;
}
// Make Flysystem adapter and cache object
$useCache = true;
if ($useCache) {
// Example to Flysystem cacheing
$cache = new myCachedStrageAdapter(
new \League\Flysystem\Adapter\Local('flycache'),
'gdcache',
300
);
// Flysystem cached adapter
$adapter = new \League\Flysystem\Cached\CachedAdapter(
$googleDrive,
$cache
);
} else {
// Not use cached adapter
$cache = null;
$adapter = $googleDrive;
}
// Google Drive elFinder Volume driver
$gdrive = [
// require
'driver' => 'FlysystemExt',
'filesystem' => new \League\Flysystem\Filesystem($adapter),
'fscache' => $cache,
'separator' => '/',
// optional
'alias' => 'GoogleDrive',
'rootCssClass' => 'elfinder-navbar-root-googledrive'
];
// elFinder volume roots options
$elFinderOpts = [
'roots' => []
];
$elFinderOpts['roots'][] = $gdrive;
// run elFinder
$connector = new elFinderConnector(new elFinder($elFinderOpts));
$connector->run();
```
## Tips
- [Setup a Laravel Storage driver with Google Drive API](https://gist.github.com/ivanvermeyen/cc7c59c185daad9d4e7cb8c661d7b89b)
- [Issue list with "HowTo" tag](https://github.com/nao-pon/flysystem-google-drive/issues?utf8=%E2%9C%93&q=label%3AHowTo%20)
## TODO
* Unit tests to be written