From 55acd476034c353a7dda00f05ed2987e7d9828b7 Mon Sep 17 00:00:00 2001 From: Anuj Sharma Date: Wed, 20 Jun 2018 14:37:41 +0530 Subject: [PATCH] Update README.md --- README.md | 111 +++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 106 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1d48ad3..326535e 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,11 @@ Google Drive Manager composer require tbetool/google-drive-manager ``` +### Permission required +``` +https://www.googleapis.com/auth/drive +``` + ### Initialize ``` $drive = new GoogleDriveManager('client_id', 'client_secret', 'access_token'); @@ -26,10 +31,16 @@ response will contain ``` [ (int) 0 => [ - 'id' => '1BEfQmdMja45M3ewc548OhiQLh9or9P6KGpqYECipV6c', - 'name' => 'Resume of Anuj Sharma', - 'mime_type' => 'application/vnd.google-apps.document', - 'kind' => 'drive#file' + 'id' => '1YoSEbFDSOejkZmtPmfOyBIoWODhllPjJ', + 'name' => 'Selling Digital Items Modules to be updated ', + 'kind' => null, + 'type' => 'folder', + 'created_time' => null, + 'file_extension' => null, + 'mime_type' => null, + 'modified_time' => null, + 'original_filename' => null, + 'size' => null ], ] ``` @@ -46,6 +57,7 @@ Response: 'id' => '1YoSEbFDSOejkZmtPmfOyBIoWODhllPjJ', 'name' => 'Selling Digital Items Modules to be updated ', 'kind' => null, + 'type' => 'folder', 'created_time' => null, 'file_extension' => null, 'mime_type' => null, @@ -61,7 +73,96 @@ Response: *currently in development* ``` -$drive->download('item_id'); +$drive->download('item_id', $save_to_path); ``` +**save_to_path** should be absolute local path where to save file + +Response: +``` +[ + 'id' => '1lJNyeIx5BpyK88Vj31YFG6WVVNY_g9Hj', + 'name' => 'file.zip', + 'kind' => 'drive#file', + 'type' => 'application/zip', + 'created_time' => null, + 'file_extension' => null, + 'mime_type' => 'application/zip', + 'modified_time' => null, + 'original_filename' => null, + 'size' => null, + 'download_path' => '/home/path/to/local/save/to/file.zip' +] +``` + +### create folder +``` +$drive->createFolder('folder name', $parent_folder_id); +``` +if **$parent_folder_id** is not provided, folder will be created in root folder +Response: + +``` +[ + 'id' => '1Q6fozdc2JK32HO2nimSKz1lQ0AVxl413', + 'name' => 'New Folder 123', + 'kind' => 'drive#file', + 'type' => 'folder', + 'created_time' => null, + 'file_extension' => null, + 'mime_type' => 'application/vnd.google-apps.folder', + 'modified_time' => null, + 'original_filename' => null, + 'size' => null +] +``` + + +### upload file to folder +``` +$drive->upload('file/path/', $folder_id); +``` +**file_path** must be absolute path of local file + +if **folder_id** is not provided, file will be uploaded to root folder + +Response: +``` +[ + 'id' => '1Q6fozdc2JK32HO2nimSKz1lQ0AVxl413', + 'name' => 'New Folder 123', + 'kind' => 'drive#file', + 'type' => 'folder', + 'created_time' => null, + 'file_extension' => null, + 'mime_type' => 'application/vnd.google-apps.folder', + 'modified_time' => null, + 'original_filename' => null, + 'size' => null +] +``` + +### move file to another folder +``` +$drive->move($file_id, $folder_id); +``` + +both **file_id** and **folder_id** are required. + +Response: +``` +[ + 'id' => '1Q6fozdc2JK32HO2nimSKz1lQ0AVxl413', + 'name' => 'New Folder 123', + 'kind' => 'drive#file', + 'type' => 'folder', + 'created_time' => null, + 'file_extension' => null, + 'mime_type' => 'application/vnd.google-apps.folder', + 'modified_time' => null, + 'original_filename' => null, + 'size' => null +] +``` +