Index | augustus-file-object-library

A

AbstractResolver — Class in namespace SR\File\Object\Guesser\Resolver: Abstract resolver class.
AbstractAccessors — Class in namespace SR\File\Object\Operation: Base storage object metadata class.
AbstractStorageObjectProvider — Class in namespace SR\File\Object\Provider: Abstract, base implementation of object provider interface.

C

CompilerException — Class in namespace SR\File\Object\Exception: Exception for error during compilation.
MimeType::construct() — Method in class MimeType: Onject construction requires only the mime type, but can optionally include the encoding and extension(s).
ContextAccessors — Class in namespace SR\File\Object\Operation: Provides size object for {see StorageObjectInterface}.

D

DateTimeAccessors — Class in namespace SR\File\Object\Operation: Provides time object for {see StorageObjectInterface}.

E

Exception — Class in namespace SR\File\Object\Exception: Base exception for storage objects.
ExtensionResolverInterface — Class in namespace SR\File\Object\Guesser\Resolver: Interface for extension resolver implementations.
FileSystemStorageObjectProvider::exists() — Method in class FileSystemStorageObjectProvider: Returns whether object exists on storage medium.
StorageObjectProviderInterface::exists() — Method in class StorageObjectProviderInterface: Returns whether object exists on storage medium.
StorageObject::exists() — Method in class StorageObject: Returns whether object exists on storage medium.
StorageObjectInterface::exists() — Method in class StorageObjectInterface: Returns whether object exists on storage medium.

F

FileExecutableMimeTypeResolver — Class in namespace SR\File\Object\Guesser\Resolver: Mime type resolver using file system executable.
FileInfoMimeTypeResolver — Class in namespace SR\File\Object\Guesser\Resolver: Mime type resolver using file info extension.
FileSystemStorageObjectProvider — Class in namespace SR\File\Object\Provider: Class representing a file system object provider.

G

MimeType::getType() — Method in class MimeType: Returns the mime type string.
MimeType::getEncoding() — Method in class MimeType: Returns the encoding string.
MimeType::getExtensions() — Method in class MimeType: Returns all resolved extensions.
MimeType::getExtensionLikely() — Method in class MimeType: Returns first (highest-priority) extension string.
DateTimeAccessors::getCreated() — Method in class DateTimeAccessors
DateTimeAccessors::getAccessed() — Method in class DateTimeAccessors
DateTimeAccessors::getModified() — Method in class DateTimeAccessors
MimeTypeAccessors::getTypeString() — Method in class MimeTypeAccessors
OwnerAccessors::getUserIdentifier() — Method in class OwnerAccessors: Returns the storage object uid.
OwnerAccessors::getUserName() — Method in class OwnerAccessors: Returns the storage object owner's user name.
OwnerAccessors::getGroupIdentifier() — Method in class OwnerAccessors: Returns the storage object gid.
OwnerAccessors::getGroupName() — Method in class OwnerAccessors: Returns the storage object owner's group name.
PathInfoAccessors::getFile() — Method in class PathInfoAccessors: Returns an object full path name.
PathInfoAccessors::getFileName() — Method in class PathInfoAccessors: Returns an object file name.
PathInfoAccessors::getBaseName() — Method in class PathInfoAccessors: Returns an object base name.
PathInfoAccessors::getPath() — Method in class PathInfoAccessors: Returns an object path.
PathInfoAccessors::getExtension() — Method in class PathInfoAccessors: Returns the object's full path name.
PathInfoAccessors::getPathName() — Method in class PathInfoAccessors: Returns an object full path name.
UuidAccessors::getVersion3() — Method in class UuidAccessors
UuidAccessors::getVersion5() — Method in class UuidAccessors
AbstractStorageObjectProvider::getIdentifier() — Method in class AbstractStorageObjectProvider: Returns the object identifier.
AbstractStorageObjectProvider::getUrl() — Method in class AbstractStorageObjectProvider: Returns the object URL.
AbstractStorageObjectProvider::getType() — Method in class AbstractStorageObjectProvider: Returns the object type as string.
AbstractStorageObjectProvider::getMimeTypeGuessers() — Method in class AbstractStorageObjectProvider: Returns the mime type guessers supported by object type.
FileSystemStorageObjectProvider::getPathName() — Method in class FileSystemStorageObjectProvider: Returns the object's full path name.
FileSystemStorageObjectProvider::getRealPathName() — Method in class FileSystemStorageObjectProvider: Returns the object's real full path name.
FileSystemStorageObjectProvider::getSizeAsBytes() — Method in class FileSystemStorageObjectProvider: Returns the object's size in bytes.
FileSystemStorageObjectProvider::getOwningUser() — Method in class FileSystemStorageObjectProvider: Returns the object owning user.
FileSystemStorageObjectProvider::getOwningGroup() — Method in class FileSystemStorageObjectProvider: Returns the object owning group.
FileSystemStorageObjectProvider::getPermissionsAsOctal() — Method in class FileSystemStorageObjectProvider: Returns the object permissions.
FileSystemStorageObjectProvider::getCreatedAsUnixTime() — Method in class FileSystemStorageObjectProvider: Returns the unix time the object was created.
FileSystemStorageObjectProvider::getAccessedAsUnixTime() — Method in class FileSystemStorageObjectProvider: Returns the unix time the object was accessed.
FileSystemStorageObjectProvider::getModifiedAsUnixTime() — Method in class FileSystemStorageObjectProvider: Returns the unix time the object was modified.
FileSystemStorageObjectProvider::getContent() — Method in class FileSystemStorageObjectProvider: Read contents from the object.
StorageObjectProviderInterface::getMimeTypeGuessers() — Method in class StorageObjectProviderInterface: Returns the mime type guessers supported by object type.
StorageObjectProviderInterface::getIdentifier() — Method in class StorageObjectProviderInterface: Returns the object identifier.
StorageObjectProviderInterface::getUrl() — Method in class StorageObjectProviderInterface: Returns the object URL.
StorageObjectProviderInterface::getPathName() — Method in class StorageObjectProviderInterface: Returns the object's full path name.
StorageObjectProviderInterface::getRealPathName() — Method in class StorageObjectProviderInterface: Returns the object's real full path name.
StorageObjectProviderInterface::getType() — Method in class StorageObjectProviderInterface: Returns the file type.
StorageObjectProviderInterface::getSizeAsBytes() — Method in class StorageObjectProviderInterface: Returns the object's size in bytes.
StorageObjectProviderInterface::getOwningUser() — Method in class StorageObjectProviderInterface: Returns the object owning user.
StorageObjectProviderInterface::getOwningGroup() — Method in class StorageObjectProviderInterface: Returns the object owning group.
StorageObjectProviderInterface::getPermissionsAsOctal() — Method in class StorageObjectProviderInterface: Returns the object permissions.
StorageObjectProviderInterface::getCreatedAsUnixTime() — Method in class StorageObjectProviderInterface: Returns the unix time the object was created.
StorageObjectProviderInterface::getAccessedAsUnixTime() — Method in class StorageObjectProviderInterface: Returns the unix time the object was accessed.
StorageObjectProviderInterface::getModifiedAsUnixTime() — Method in class StorageObjectProviderInterface: Returns the unix time the object was modified.
StorageObjectProviderInterface::getContent() — Method in class StorageObjectProviderInterface: Read contents from the object.
StorageObject::getIdentifier() — Method in class StorageObject: Returns an object file identifier.
StorageObject::getUrl() — Method in class StorageObject: Returns the object file url.
StorageObject::getPathInfo() — Method in class StorageObject: Returns the object path info metadata instance.
StorageObject::getContext() — Method in class StorageObject: Returns the object type metadata instance.
StorageObject::getMimeType() — Method in class StorageObject: Returns a mime type metadata instance.
StorageObject::getUuid() — Method in class StorageObject: Returns a uuid metadata instance.
StorageObject::getSize() — Method in class StorageObject: Returns a size metadata instance.
StorageObject::getOwner() — Method in class StorageObject: Returns an owner metadata instance.
StorageObject::getPermissions() — Method in class StorageObject: Returns a permissions metadata instance.
StorageObject::getTime() — Method in class StorageObject: Returns a time metadata instance.
StorageObject::getContents() — Method in class StorageObject: Returns the object file contents.
StorageObjectInterface::getIdentifier() — Method in class StorageObjectInterface: Returns an object file identifier.
StorageObjectInterface::getUrl() — Method in class StorageObjectInterface: Returns the object file url.
StorageObjectInterface::getPathInfo() — Method in class StorageObjectInterface: Returns the object path info metadata instance.
StorageObjectInterface::getContext() — Method in class StorageObjectInterface: Returns the object type metadata instance.
StorageObjectInterface::getMimeType() — Method in class StorageObjectInterface: Returns an object mime type metadata instance.
StorageObjectInterface::getUuid() — Method in class StorageObjectInterface: Returns an object uuid metadata instance.
StorageObjectInterface::getSize() — Method in class StorageObjectInterface: Returns an object size metadata instance.
StorageObjectInterface::getOwner() — Method in class StorageObjectInterface: Returns an object owner metadata instance.
StorageObjectInterface::getPermissions() — Method in class StorageObjectInterface: Returns an object permissions metadata instance.
StorageObjectInterface::getTime() — Method in class StorageObjectInterface: Returns an object time metadata instance.
StorageObjectInterface::getContents() — Method in class StorageObjectInterface: Returns the object file contents.

H

MimeType::hasEncoding() — Method in class MimeType: Determine if an encoding has been assigned.
MimeType::hasExtensions() — Method in class MimeType: Determined if any extensions have been assigned.
OwnerAccessors::hasPosixExtension() — Method in class OwnerAccessors: Returns if posix extension is available.

I

ContextAccessors::isFile() — Method in class ContextAccessors: Returns whether object type is a file.
ContextAccessors::isDirectory() — Method in class ContextAccessors: Returns whether object type is a directory.
ContextAccessors::isLink() — Method in class ContextAccessors: Returns whether object type is a link.
ContextAccessors::isExecutable() — Method in class ContextAccessors: Returns whether object type is a executable.
ContextAccessors::isLocal() — Method in class ContextAccessors: Returns whether object is locally stored.
PermissionAccessors::isReadable() — Method in class PermissionAccessors: Returns whether object is readable.
PermissionAccessors::isWritable() — Method in class PermissionAccessors: Returns whether object is writable.
FileSystemStorageObjectProvider::isFile() — Method in class FileSystemStorageObjectProvider: Returns whether object type is a file.
FileSystemStorageObjectProvider::isDirectory() — Method in class FileSystemStorageObjectProvider: Returns whether object type is a directory.
FileSystemStorageObjectProvider::isLink() — Method in class FileSystemStorageObjectProvider: Returns whether object type is a link.
FileSystemStorageObjectProvider::isExecutable() — Method in class FileSystemStorageObjectProvider: Returns whether object type is a executable.
FileSystemStorageObjectProvider::isLocal() — Method in class FileSystemStorageObjectProvider: Returns whether object is locally stored.
FileSystemStorageObjectProvider::isReadable() — Method in class FileSystemStorageObjectProvider: Returns whether object is readable.
FileSystemStorageObjectProvider::isWritable() — Method in class FileSystemStorageObjectProvider: Returns whether object is writable.
StorageObjectProviderInterface::isFile() — Method in class StorageObjectProviderInterface: Returns whether object type is a file.
StorageObjectProviderInterface::isDirectory() — Method in class StorageObjectProviderInterface: Returns whether object type is a directory.
StorageObjectProviderInterface::isLink() — Method in class StorageObjectProviderInterface: Returns whether object type is a link.
StorageObjectProviderInterface::isExecutable() — Method in class StorageObjectProviderInterface: Returns whether object type is a executable.
StorageObjectProviderInterface::isLocal() — Method in class StorageObjectProviderInterface: Returns whether object is locally stored.
StorageObjectProviderInterface::isReadable() — Method in class StorageObjectProviderInterface: Returns whether object is readable.
StorageObjectProviderInterface::isWritable() — Method in class StorageObjectProviderInterface: Returns whether object is writable.

M

MetadataException — Class in namespace SR\File\Object\Exception: Exception for error retrieving storage object metadata.
MimeTypeDecider — Class in namespace SR\File\Object\Guesser\Decider: Proxy mime type guesser that attempts to determine mime type using multiple implementations.
MimeType — Class in namespace SR\File\Object\Guesser\Model: Mime type value object containing mime type, mime charset, and mime determined extension.
MimeTypeResolverInterface — Class in namespace SR\File\Object\Guesser\Resolver: Interface for mime type resolver implementations.
MimeTypeAccessors — Class in namespace SR\File\Object\Operation: Provides mime type object for {see StorageObjectInterface}.

N

NotAccessibleException — Class in namespace SR\File\Object\Exception: Exception for non-accessible storage objects.
NotFoundException — Class in namespace SR\File\Object\Exception: Exception for not found storage objects.
NotReadableException — Class in namespace SR\File\Object\Exception: Exception for unreadable storage objects.
NotWritableException — Class in namespace SR\File\Object\Exception: Exception for unwritable storage objects.

O

OwnerAccessors — Class in namespace SR\File\Object\Operation: Provides owner info for object for {see StorageObjectProviderInterface}.

P

PathInfoAccessors — Class in namespace SR\File\Object\Operation: Provides path info methods for {see StorageObjectProviderInstance}.
PermissionAccessors — Class in namespace SR\File\Object\Operation: Provides permissions object for {see StorageObjectInterface}.

R

MimeTypeDecider::register() — Method in class MimeTypeDecider: Register mime type guesser implementation.
MimeTypeDecider::resolve() — Method in class MimeTypeDecider: Attempt to determine the mime type of the file object.
FileExecutableMimeTypeResolver::resolve() — Method in class FileExecutableMimeTypeResolver: Attempt to determine the mime type of the object.
FileInfoMimeTypeResolver::resolve() — Method in class FileInfoMimeTypeResolver: Attempt to determine the mime type of the object.
ResolverInterface — Class in namespace SR\File\Object\Guesser\Resolver: Interface for generic resolver implementation.
ResolverInterface::resolve() — Method in class ResolverInterface: Attempt to determine the mime type of the file object.
TableLookupExtensionResolver::resolve() — Method in class TableLookupExtensionResolver: Attempt to determine the extension of the object.

S

MimeTypeDecider::supports() — Method in class MimeTypeDecider: Determine if resolver is supported and supports object.
FileExecutableMimeTypeResolver::supports() — Method in class FileExecutableMimeTypeResolver: Determine if resolver is supported and supports object.
FileInfoMimeTypeResolver::supports() — Method in class FileInfoMimeTypeResolver: Determine if resolver is supported and supports object.
ResolverInterface::supports() — Method in class ResolverInterface: Determine if resolver is supported and supports object.
TableLookupExtensionResolver::supports() — Method in class TableLookupExtensionResolver: Determine if resolver is supported and supports object.
SizeAccessors — Class in namespace SR\File\Object\Operation: Provides size object for {see StorageObjectInterface}.
FileSystemStorageObjectProvider::setContent() — Method in class FileSystemStorageObjectProvider: Write contents to the object.
StorageObjectProviderInterface — Class in namespace SR\File\Object\Provider: Interface that describes classes representing a file object provider.
StorageObjectProviderInterface::setContent() — Method in class StorageObjectProviderInterface: Write contents to the object.
StorageObject — Class in namespace SR\File\Object: File object representation.
StorageObject::setContents() — Method in class StorageObject: Sets and returns the object file contents.
StorageObjectInterface — Class in namespace SR\File\Object: Interface that describes a class representing a file object, regardless of location or storage backend.
StorageObjectInterface::setContents() — Method in class StorageObjectInterface: Sets and returns the object file contents.

T

TableLookupExtensionResolver — Class in namespace SR\File\Object\Guesser\Resolver: Extension resolver using static YML data table.
SizeAccessors::toInteger() — Method in class SizeAccessors: Returns the size as bytes.
SizeAccessors::toString() — Method in class SizeAccessors: Returns the size as a human readable string.

U

UuidAccessors — Class in namespace SR\File\Object\Operation: Provides UUID-generating object for {see StorageObjectInterface}.

_

MimeType::__toString() — Method in class MimeType: Returns the encoding type.
FileInfoMimeTypeResolver::__construct() — Method in class FileInfoMimeTypeResolver: FileInfoMimeTypeResolver constructor.
TableLookupExtensionResolver::__construct() — Method in class TableLookupExtensionResolver: Constructor can be optionally configured to use alternate yml lookup file.
AbstractAccessors::__construct() — Method in class AbstractAccessors: Construct using object provider instance.
ContextAccessors::__toString() — Method in class ContextAccessors: Returns object type string.
DateTimeAccessors::__toString() — Method in class DateTimeAccessors: Returns size as a human readable string {see StorageObjectSize::getString()}.
MimeTypeAccessors::__toString() — Method in class MimeTypeAccessors: Returns mime type string representation {see StorageObjectMimeType::getTypeString()}.
SizeAccessors::__toString() — Method in class SizeAccessors: Returns size as a human readable string {see StorageObjectSize::getString()}.
FileSystemStorageObjectProvider::__construct() — Method in class FileSystemStorageObjectProvider: Construction of the provider requires an {see \SplFileInfo} instance.
StorageObject::__construct() — Method in class StorageObject: Construct using object provider instance.
StorageObject::__toString() — Method in class StorageObject: Returns the object path name {see StorageObjectInterface::getPathName()}.
StorageObjectInterface::__toString() — Method in class StorageObjectInterface: Returns the object path name {see StorageObjectInterface::getPathName()}.