Docs For Class PelEntryUndefined

Description

Class for holding data of any kind.

This class can hold bytes of undefined format.

author: Martin Geisler <mgeisler@users.sourceforge.net>

Located in /src/PelEntryUndefined.php (line 57)

PelEntry
   |
   --PelEntryUndefined

Direct descendents

Class	Description
PelEntryUserComment	Class for a user comment.
PelEntryVersion	Class to hold version information.

Method Summary

PelEntryUndefined __construct (PelTag $tag, [string $data = ''])

string getText ([boolean $brief = false])

string getValue ()

void setValue (string $data)

Variables

Inherited Variables

Inherited from PelEntry

PelEntry::$bytes
PelEntry::$components
PelEntry::$format
PelEntry::$ifd_type
PelEntry::$tag

Methods

Constructor __construct (line 71)

Make a new PelEntry that can hold undefined data.

PelEntryUndefined __construct (PelTag $tag, [string $data = ''])

PelTag $tag: the tag which this entry represents. This should be one of the constants defined in PelTag, e.g., PelTag::SCENE_TYPE, PelTag::MAKER_NOTE or any other tag with format PelFormat::UNDEFINED.
string $data: the data that this entry will be holding. Since the format is undefined, no checking will be done on the data.

Redefined in descendants as:

PelEntryUserComment::__construct() : Make a new entry for holding a user comment.
PelEntryVersion::__construct() : Make a new entry for holding a version.

getText (line 110)

Get the value of this entry as text.

The value will be returned in a format suitable for presentation.

return: the value as text.

string getText ([boolean $brief = false])

boolean $brief: some values can be returned in a long or more brief form, and this parameter controls that.

Redefinition of:

PelEntry::getText(): Get the value of this entry as text.

Redefined in descendants as:

PelEntryUserComment::getText() : Returns the user comment.
PelEntryVersion::getText() : Return a text string with the version.

getValue (line 95)

Get the data of this undefined entry.

return: the data that this entry is holding.

string getValue ()

Redefinition of:

PelEntry::getValue(): Get the value of this entry.

Redefined in descendants as:

PelEntryUserComment::getValue() : Returns the user comment.
PelEntryVersion::getValue() : Return the version held by this entry.

setValue (line 84)

Set the data of this undefined entry.

void setValue (string $data)

string $data: the data that this entry will be holding. Since the format is undefined, no checking will be done on the data.

Redefinition of:

PelEntry::setValue(): Set the value of this entry.

Redefined in descendants as:

PelEntryUserComment::setValue() : Set the user comment.
PelEntryVersion::setValue() : Set the version held by this entry.

Inherited Methods

Inherited From PelEntry

PelEntry::getBytes()
PelEntry::getComponents()
PelEntry::getFormat()
PelEntry::getIfdType()
PelEntry::getTag()
PelEntry::getText()
PelEntry::getValue()
PelEntry::setIfdType()
PelEntry::setValue()
PelEntry::__toString()