Skip to main content

Storage

Introduction​

You can use the Storage Vania class to store file in storage/app/public path insted of usinf Dart file class

Configuration​

To configure your storage settings, update the env file with the appropriate information.

Local Storage​

For local storage, specify the following:

STORAGE=local

AWS S3 Storage​

To use AWS S3 as your storage solution, update the env file with the following details:

STORAGE=s3
STORAGE_S3_BUCKET='your-s3-bucket-name'
STORAGE_S3_SECRET_KEY='your-secret-key'
STORAGE_S3_ACCESS_KEY='your-access-key'
STORAGE_S3_REGION='your-region'

Replace the placeholders with your actual AWS S3 credentials and bucket information.

Storage Usage​

Obtaining a Storage Instance​

To obtain a Storage instance, you may use the Storage , which is what we will use throughout this documentation. The Storage provides convenient, terse access to the underlying implementations of the Vania Storage contracts:

class UserController extends Controller
{

    Future<Response> index() async
    {
        String? value = Storage.get('file name');
 
        return Response.json();
    }
}

Retrieving Files​

The get method may be used to retrieve the contents of a file.


Uint8List? value = Storage.getAsBytes('image.jps');

String? value = Storage.get('text.txt');

If the file you are retrieving contains Map, you may use the map method to retrieve the file and decode its contents:


Map<String,dynamic>? value = Storage.map('image.jps');

``

## Storing Files

The `put` method may be used to store file contents on a disk. The content can be list of ints or Strig

```dart

await Storage.put('image.jpg',content);

Deleting Files​

The delete method may be used to delete file from storage.


await Storage.delete('image.jpg');

Exists Files​

The exists method may be used to determine if a file exists on the disk:


await Storage.exists('image.jpg');

File Metadata​

In addition to reading and writing files, Vania can also provide information about the files themselves. For example, the size method may be used to get the size of a file in bytes:


int? size = await Storage.size('image.jpg');

The MIME type of a given file may be obtained via the mimeType method:


String? mimeType = await Storage.mimeType('image.jpg');