If the file was returned from a [[Hazaar\File\Dir]] object, then it will have a stored relative path. Otherwise any file/path can be provided in the form of another [[Hazaar\File\ object, [[Hazaar\File\Dir]] object, or string path, and the relative path to the file will be returned.

Parameters

Parameter	Type	Description
`$path`	`string`

setRelativePath

public  setRelativePath({Array})

Parameters

Parameter	Type	Description
`$path`	`string`

realpath

public  realpath({Array})

dirname

public  dirname({Array})

name

public  name({Array})

extension

public  extension({Array})

basename

public  basename({Array})

size

public  size({Array})

type

public  type({Array})

exists

public  exists({Array})

Parameters

Parameter	Type	Description
`$filename`	`string`

isReadable

public  isReadable({Array})

isWritable

public  isWritable({Array})

isFile

public  isFile({Array})

isDir

public  isDir({Array})

isLink

public  isLink({Array})

parent

public  parent({Array})

ctime

public  ctime({Array})

mtime

public  mtime({Array})

touch

public  touch({Array})

atime

public  atime({Array})

allowHidden

public  allowHidden({Array})

Parameters

Parameter	Type	Description
`$toggle`	`bool`

create

public  create({Array})

Parameters

Parameter	Type	Description
`$recursive`	`bool`

rename

public  rename({Array})

Parameters

Parameter	Type	Description
`$newname`	`string`

delete

Delete the directory, optionally removing all it's contents.

public  delete({Array})

Executing this method will simply delete or "unlink" the directory. Normally it must be empty to succeed. However specifying the $recursive parameter as TRUE will delete everything inside the directory, recursively (obviously).

Parameters

Parameter	Type	Description
`$recursive`	`bool`

unlink

File::unlink() compatible delete that removes dir and all contents (ie: recursive).

public  unlink({Array})

isEmpty

public  isEmpty({Array})

Empty a directory of all it's contents.

public  ({Array})

This is the same as calling delete(true) except that the directory itself is not deleted.

By default hidden files are not deleted. This is for protection. You can choose to delete them as well by setting $include_hidden to true.

Parameters

Parameter	Type	Description
`$include_hidden`	`boolean`	also delete hidden files

close

public  close({Array})

read

public  read({Array})

Parameters

Parameter	Type	Description
`$regex_filter`	`string`

rewind

public  rewind({Array})

find

Find files in the current path optionally recursing into sub directories.

public  find({Array})

Parameters

Parameter	Type	Description
`$pattern`	`string`	The pattern to match against. This can be either a wildcard string, such as

                          "*.txt" or a regex pattern.  Regex is detected if the string is longer than a
                          single character and first character is the same as the last. |

copyTo

public  copyTo({Array})

Parameters

Parameter	Type	Description
`$target`	`string`
`$recursive`	`bool`
`$transport_callback`	`\Closure`

get

public  get({Array})

Parameters

Parameter	Type	Description
`$child`	`string`
`$force_dir`	`bool`

getDir

public  getDir({Array})

Parameters

Parameter	Type	Description
`$path`	`string`

mimeContentType

public  mimeContentType({Array})

dir

public  dir({Array})

Parameters

Parameter	Type	Description
`$child`	`string`

toArray

public  toArray({Array})

put

Copy a file object into the current directory.

public  put({Array})

Parameters

Parameter	Type	Description
`$file`	`File`	The file to put in this directory
`$overwrite`	`bool`

download

Download a file from a URL directly to the directory and return a new File object.

public  download({Array})

This is useful for download large files as this method will write the file directly to storage. Currently, only local storage is supported as this uses OS file access.

Parameters

Parameter	Type	Description
`$source_url`	`mixed`	The source URL of the file to download
`$timeout`	`int`	The download timeout after which an exception will be thrown

mediaURL

public  mediaURL({Array})

Parameters

Parameter	Type	Description
`$set_path`	`URL`

sync

public  sync({Array})

Parameters

Parameter	Type	Description
`$source`	`Dir`
`$recursive`	`bool`
`$progress_callback`	`\Closure`
`$max_retries`	`int`

write

public  write({Array})

Parameters

Parameter	Type	Description
`$file`	`string`
`$bytes`	`string`
`$content_type`	`string`

callSyncCallback

private  callSyncCallback({Array})

Generated by Hazaar API Doc Generator