1. class
  2. SR
  3. File
  4. Object
  5. Operation
  6. PathInfoAccessors

PathInfoAccessors

class PathInfoAccessors extends AbstractAccessors

Provides path info methods for {see StorageObjectProviderInstance}.

Methods

__construct( StorageObjectProviderInterface $provider)

Construct using object provider instance.

from AbstractAccessors
string
getFile( bool $resolve = false)

Returns an object full path name.

string
getFileName( bool $resolve = false)

Returns an object file name.

mixed
getBaseName( null|string $suffix = null, bool $resolve = false)

Returns an object base name.

string
getPath( bool $resolve = false)

Returns an object path.

string
getExtension( bool $resolve = false)

Returns the object's full path name.

string
getPathName( bool $resolve = false)

Returns an object full path name.

Details

in AbstractAccessors at line line 31
final __construct( StorageObjectProviderInterface $provider)

Construct using object provider instance.

Parameters

StorageObjectProviderInterface $provider

at line line 30
string getFile( bool $resolve = false)

Returns an object full path name.

Parameters

bool $resolve Tries to resolve the real path if true

Return Value

string

Exceptions

NotFoundException If real path resolution fails

at line line 44
string getFileName( bool $resolve = false)

Returns an object file name.

Parameters

bool $resolve Tries to resolve the real path if true

Return Value

string

Exceptions

NotFoundException If real path resolution fails

at line line 59
mixed getBaseName( null|string $suffix = null, bool $resolve = false)

Returns an object base name.

Parameters

null|string $suffix A suffix to remove from the base name
bool $resolve Tries to resolve the real path if true

Return Value

mixed

Exceptions

NotFoundException If real path resolution fails

at line line 77
string getPath( bool $resolve = false)

Returns an object path.

Parameters

bool $resolve Tries to resolve the real path if true

Return Value

string

Exceptions

NotFoundException If real path resolution fails

at line line 91
string getExtension( bool $resolve = false)

Returns the object's full path name.

Parameters

bool $resolve Tries to resolve the real path if true

Return Value

string

Exceptions

NotFoundException If real path resolution fails

at line line 105
string getPathName( bool $resolve = false)

Returns an object full path name.

Parameters

bool $resolve Tries to resolve the real path if true

Return Value

string

Exceptions

NotFoundException If real path resolution fails