API Documentation
\
duncan3dc
MetaAudio
Exceptions
Modules

\duncan3dc\MetaAudio\ModulesAbstractModule

Base class for modules to extend.

Summary

Methods
Properties
Constants
open()
save()
revert()
No public properties found
No constants found
getTags()
getTag()
setTag()
putTags()
$file
N/A
No private methods found
$tags
N/A

Properties

$file

$file : \duncan3dc\MetaAudio\Interfaces\FileInterface

Type

\duncan3dc\MetaAudio\Interfaces\FileInterface — The file to read.

$tags

$tags : array|null

Type

array|null — The parsed tags from the file.

Methods

open()

open(\duncan3dc\MetaAudio\Interfaces\FileInterface  $file) : $this

Load the passed file.

Parameters

\duncan3dc\MetaAudio\Interfaces\FileInterface $file

The file to read

Returns

$this

save()

save() : $this

Save the changes currently pending.

Returns

$this

revert()

revert() : $this

Throw away any pending changes.

Returns

$this

getTags()

getTags() : array

Get all the tags from the currently loaded file.

Returns

array

getTag()

getTag(string  $key) : mixed

Get a tag from the file.

Parameters

string $key

The name of the tag to get

Returns

mixed

setTag()

setTag(string  $key, mixed  $value) : $this

Set a tag in the file.

Parameters

string $key

The name of the tag to set
mixed $value

The value to set the tag to

Returns

$this

putTags()

putTags(array  $tags) : void

Write the specified tags to the currently loaded file.

Parameters

array $tags