laravel-google-drive-storage

Install the package using composer to enable Google Drive storage as a filesystem driver in your Laravel application.

composer require yaza/laravel-google-drive-storage

Register the google driver in your config/filesystems.php file. This allows you to use the standard Laravel Storage facade with the Google Drive driver.

'disks' => [
    'google' => [
      'driver' => 'google',
      'clientId' => env('GOOGLE_DRIVE_CLIENT_ID'),
      'clientSecret' => env('GOOGLE_DRIVE_CLIENT_SECRET'),
      'accessToken' => env('GOOGLE_DRIVE_ACCESS_TOKEN'), // optional
      'refreshToken' => env('GOOGLE_DRIVE_REFRESH_TOKEN'),
      'folder' => env('GOOGLE_DRIVE_FOLDER'),
    ]
]

Add the following keys to your .env file to provide the necessary Google API credentials. The GOOGLE_DRIVE_FOLDER option is used to define a base directory for your files.

FILESYSTEM_CLOUD=google
GOOGLE_DRIVE_CLIENT_ID=xxx.apps.googleusercontent.com
GOOGLE_DRIVE_CLIENT_SECRET=xxx
GOOGLE_DRIVE_REFRESH_TOKEN=xxx
GOOGLE_DRIVE_ACCESS_TOKEN=xxx
GOOGLE_DRIVE_FOLDER=

Once configured, you can interact with Google Drive using the standard Laravel Storage facade by specifying the google disk.

Storage::disk('google')->put($filename, File::get($filepath));

If you need to upload files to a specific user's Google Drive, you can build a disk on-the-fly using their unique accessToken.

// Build an on-demand disk
$disk = Storage::build([
    'driver' => 'google',
    'clientId' => env('GOOGLE_DRIVE_CLIENT_ID'),
    'clientSecret' => env('GOOGLE_DRIVE_CLIENT_SECRET'),
    'accessToken' => auth()->user()->google_access_token, // Get from authenticated user
    'refreshToken' => env('GOOGLE_DRIVE_REFRESH_TOKEN'),
    'folder' => env('GOOGLE_DRIVE_FOLDER'),
]);

$disk->put($filename, File::get($filepath));

The package provides a Yaza\LaravelGoogleDriveStorage\Gdrive helper class for simplified file and directory management.

use Yaza\
LaravelGoogleDriveStorage\
Gdrive;

// Put File
Gdrive::put('location/filename.png', $request->file('file'));
// or
Gdrive::put('filename.png', public_path('path/filename.png'));

// Get File
$data = Gdrive::get('path/filename.png');

// Get Large File with stream
$readStream = Gdrive::readStream('path/filename.png');

// Delete file
Gdrive::delete('path/filename.png');

// Delete directory
Gdrive::deleteDir('foldername');

// Make directory
Gdrive::makeDir('foldername');

// Rename directory
Gdrive::renameDir('oldfolderpath', 'newfolder');

Use Gdrive::all() to retrieve a collection of files and directories. You can pass a path and an optional boolean to include subfolders (recursive search). The output is an Illuminate\Support\Collection containing League\Flysystem\DirectoryAttributes and League\Flysystem\FileAttributes objects.

use Yaza\LaravelGoogleDriveStorage\Gdrive;

// All files and folders in a directory
Gdrive::all('/');

// All files and folders in a directory (recursive)
Gdrive::all('foldername', true);

The LaravelGoogleDriveStorage facade provides a static proxy to the underlying Yaza\LaravelGoogleDriveStorage\LaravelGoogleDriveStorage service. Use this facade to interact with Google Drive storage within your Laravel application without manually resolving the service from the container.

use Yaza\LaravelGoogleDriveStorage\Facades\LaravelGoogleDriveStorage;

// Example usage (actual methods depend on the underlying service implementation)
LaravelGoogleDriveStorage::someMethod();

Use Gdrive::getFileInfo($file_path) to retrieve metadata about a file without downloading its content. It returns a GdriveFileInfo object containing:

• filename: The name of the file.
• ext: The file extension.
• path: The normalized path (using forward slashes).

use Yaza\LaravelGoogleDriveStorage\Gdrive;

$info = Gdrive::getFileInfo('folder/subfolder/document.pdf');

echo $info->filename; // 'document.pdf'
echo $info->ext;      // 'pdf'
echo $info->path;     // 'folder/subfolder/document.pdf'

You can remove individual files or entire directories using the following methods:

• Gdrive::delete($path): Deletes a specific file at the provided path.
• Gdrive::deleteDir($dirpath): Deletes an entire directory and its contents.

use Yaza\LaravelGoogleDriveStorage\Gdrive;

// Delete a file
Gdrive::delete('documents/old_file.txt');

// Delete a directory
Gdrive::deleteDir('temp_folder/');