\src\Utils\File\FileSystemObject.inc

Show: inherited
Table of Contents

\Utils\File\FileSystemObject

Package: Default

This class represents an abstract object in the file system.

Implements
\Utils\File\IFileSystemObject
Children
\Utils\File\Directory
\Utils\File\File

Properties

Propertyprotected\SplFileInfo  $fileInfo= 'null'

the file information object associated with this file system object

Default valuenullDetails
Type
\SplFileInfo
Propertyprotected\Utils\File\Directory  $parent= 'null'

the parent directory of the file system object

Default valuenullDetails
Type
\Utils\File\Directory

Methods

methodpublic__construct( \SplFileInfo $fileInfo ) : void

This method acts as the constructor of the class.

Parameters
Name Type Description
$fileInfo \SplFileInfo

the file information object associated with this file system object

methodpublic__toString( ) : string

This method returns the string representation of the file system object, i.e. its base name.

Returns
Type Description
string the base name of the file system object as string
methodpublicgetBasename( ) : string

This method returns the base name of the file system object.

Returns
Type Description
string the base name of the file system object
methodpublicgetParent( ) : \Utils\File\Directory

This method returns the parent directory of this file system object.

Returns
Type Description
\Utils\File\Directory the parent directory of this file system object
methodpublicgetPathname( ) : string

This method returns the path name of this file system object.

Returns
Type Description
string the path name of this file system object
Documentation was generated by DocBlox 0.15.1.