Class File

__construct(string $path) 

Builds a File object.

exists() : boolean

Allows you to know if the file system element exists.

True if the file exists, else, false.

get_path() : string

Returns the element full path.

The element full path.

get_path_from_root() : string

Returns the element path from the phpboost root.

The element from the phpboost root.

get_name() : string

Returns the element name.

The element name.

is_writable(boolean $force_chmod = false) : true

Returns true if the file or the folder is writable.

if the file or the folder is writable.

change_chmod(integer $chmod) : true

Changes the chmod of the element.

if the chmod has been successfully changed.

delete() 

Deletes the file.

\IOException

if the file cannot been deleted

get_name_without_extension() : string

Returns the element name without extension.

The element name without extension.

get_extension() : string

Returns the extension of the element.

Element extension.

read(integer $start, integer $len = -1) : string

Returns the content of the file.

The read content.

read_lines() : array<mixed,string>

Returns the content of the file grouped by lines.

The list of the lines of the file.

write(string $data) 

Writes some text in the file. Erases the file previous content

\IOException

If it's not possible to write the file

append(string $data) 

Appends some text at the end of the file.

\IOException

If it's not possible to write the file

erase() 

empty the file

close() 

Closes a file and frees the allocated memory relative to the file.

\IOException

if the file cannot been locked

unlock() 

Unlocks a file. The file must have been locked before you call this method.

\IOException

if the file cannot been unlocked

flush() 

Forces the system to write all the buffered output.

get_last_modification_date() : integer

Returns the date of the last modification of the file.

The UNIX timestamp corresponding to the last modification date.

get_last_access_date() : integer

Returns the last access date of the file.

The UNIX timestamp corresponding to the last access date of the file.

get_file_size() : integer

Returns the size of the file.

The size of the file in bytes.

get_formated_size(string $file_size) : string

Get file readable size.

The size of the file in Kb or Mb or Gb.

open( $mode) 

Opens the file. You cannot read or write a closed file, use this method to open it.

\IOException

If the file can neither been read nor created.

get_file_checksum(string $filename) : string

Get file checksum in sha256.

The hash of the file in sha256.

is_open() : boolean

Allows you to know if the file is already open.

true if the file is open, false if it's closed.