# Contract

abstract class Contract

## Properties

protected | $adapter | Default propperty |
protected | $filesystem |  |
protected | $diskName |  |
protected | $path |  |
protected | $error |  |

## Methods

void
directories(string $directoryName = '/')

Retrieve all content of directory

void
makeDirectory(string $directoryName)

Make a directory

bool
isExists(string $path)

Check if file or directory exists or not

void
move(string $from, string $to)

Move file

void
copy(string $from, string $to)

Copy file

void
delete(string $inputPath)

Delete file

void
deleteDirectory(string $path)

Delete directory

void
put(string $path, mixed $content)

Create file

void
putStream(string $path, mixed $content)

Create stream file

void
read(string $path)

Read a file

void
readStream(string $path)

Read a file with stream

lastModified(string $path)

Get last modified

object
upload(string $fileToUpload, closure $validation)

Upload

string
getProviderName()

Get class name

getFilesystem()

Get filesystem instance

getDiskName()

Get filesystem instance

void
getPath(string $additionalPath = '')

Get main path

void
getSize(string $path)

Get size of file

getError()

No description

## Details

###
at line 34
`void directories(string $directoryName = '/')`

Retrieve all content of directory

#### Parameters

string | $directoryName |

#### Return Value

void |

###
at line 45
`void makeDirectory(string $directoryName)`

Make a directory

#### Parameters

string | $directoryName |

#### Return Value

void |

###
at line 56
`bool isExists(string $path)`

Check if file or directory exists or not

#### Parameters

string | $path |

#### Return Value

bool |

###
at line 68
`void move(string $from, string $to)`

Move file

#### Parameters

string | $from |
string | $to |

#### Return Value

void |

###
at line 80
`void copy(string $from, string $to)`

Copy file

#### Parameters

string | $from |
string | $to |

#### Return Value

void |

###
at line 91
`void delete(string $inputPath)`

Delete file

#### Parameters

string | $inputPath |

#### Return Value

void |

###
at line 102
`void deleteDirectory(string $path)`

Delete directory

#### Parameters

string | $path |

#### Return Value

void |

###
at line 114
`void put(string $path, mixed $content)`

Create file

#### Parameters

string | $path |
mixed | $content |

#### Return Value

void |

###
at line 126
`void putStream(string $path, mixed $content)`

Create stream file

#### Parameters

string | $path |
mixed | $content |

#### Return Value

void |

###
at line 137
`void read(string $path)`

Read a file

#### Parameters

string | $path |

#### Return Value

void |

###
at line 148
`void readStream(string $path)`

Read a file with stream

#### Parameters

string | $path |

#### Return Value

void |

###
at line 156
`lastModified(string $path)`

Get last modified

#### Parameters

string | $path |

###
at line 168
`abstract object upload(string $fileToUpload, closure $validation)`

Upload

#### Parameters

string | $fileToUpload |
closure | $validation |

#### Return Value

object |

###
at line 175
`string getProviderName()`

Get class name

#### Return Value

string |

###
at line 184
`getFilesystem()`

Get filesystem instance

###
at line 192
`getDiskName()`

Get filesystem instance

###
at line 202
`void getPath(string $additionalPath = '')`

Get main path

#### Parameters

string | $additionalPath |

#### Return Value

void |

###
at line 213
`void getSize(string $path)`

Get size of file

#### Parameters

string | $path |

#### Return Value

void |

###
at line 219
`getError()`

No description