1. class
  2. Biigle
  3. \
  4. Services
  5. \
  6. MetadataParsing
  7. \
  8. MetadataParser

MetadataParser

abstract class MetadataParser

Properties

SplFileObject $fileObject

Methods

static array
getKnownMimeTypes()

Get the MIME types that files known by this parser can have.

static string
getName()

Get the name of the parser to show it to users selecting files.

__construct(SplFileInfo $file)

No description

bool
recognizesFile()

Returns true if the file is in the format understood by the parser.

VolumeMetadata
getMetadata()

Get a filled VolumeMetadata object based on the file.

SplFileObject
getFileObject()

No description

Details

at line 17
abstract static array getKnownMimeTypes()

Get the MIME types that files known by this parser can have.

Example: ['text/csv']

Return Value

array

at line 24
abstract static string getName()

Get the name of the parser to show it to users selecting files.

Example: 'BIIGLE CSV'

Return Value

string

at line 26
__construct(SplFileInfo $file)

No description

Parameters

SplFileInfo $file

at line 34
abstract bool recognizesFile()

Returns true if the file is in the format understood by the parser.

Return Value

bool

at line 39
abstract VolumeMetadata getMetadata()

Get a filled VolumeMetadata object based on the file.

Return Value

VolumeMetadata

at line 41
protected SplFileObject getFileObject()

No description

Return Value

SplFileObject