Abstract Class PelEntry

Description

Located in /PelEntry.php (line 104)


	
			
Direct descendents
Class Description
Abstract class PelEntryNumber Class for holding numbers.
 class PelEntryUndefined Class for holding data of any kind.
 class PelEntryAscii Class for holding a plain ASCII string.
Variable Summary
Method Summary
 string getBytes (PelByteOrder $o)
 int getComponents ()
 string getText ([boolean $brief = false])
 PelEntry newFromData (PelTag $tag, PelFormat $format, int $components, PelDataWindow $data)
 string __toString ()
Variables
string $bytes = '' (line 115)

The bytes representing this entry.

Subclasses must either override getBytes() or, if possible, maintain this property so that it always contains a true representation of the entry.

  • access: protected
int $components (line 136)

The number of components of this entry.

  • access: protected
PelFormat $format (line 129)

The PelFormat of this entry.

  • access: protected
PelTag $tag (line 122)

The PelTag of this entry.

  • access: protected
Methods
getBytes (line 320)

Turn this entry into bytes.

  • return: bytes representing this entry.
string getBytes (PelByteOrder $o)
  • PelByteOrder $o: the desired byte order, which must be either Convert::LITTLE_ENDIAN or Convert::BIG_ENDIAN.

Redefined in descendants as:
getComponents (line 307)

Return the number of components of this entry.

  • return: the number of components of this entry.
int getComponents ()
getFormat (line 297)

Return the format of this entry.

  • return: the format of this entry.
PelFormat getFormat ()
getTag (line 287)

Return the tag of this entry.

  • return: the tag of this entry.
PelTag getTag ()
getText (line 337)

Get the value of an entry as text.

The value will be returned in a format suitable for presentation, e.g., rationals will be returned as 'x/y', ASCII strings will be returned as themselves etc.

  • return: the value as text.
  • abstract:
string getText ([boolean $brief = false])
  • boolean $brief: some values can be returned in a long or more brief form, and this parameter controls that.

Redefined in descendants as:
newFromData (line 156)

Make a new entry from a bunch of bytes.

This method will create the proper subclass of PelEntry corresponding to the PelTag and PelFormat given.

  • return: a newly created entry, holding the data given.
  • static:
PelEntry newFromData (PelTag $tag, PelFormat $format, int $components, PelDataWindow $data)
  • PelTag $tag: the tag of the entry.
  • PelFormat $format: the format of the entry.
  • int $components: the components in the entry.
  • PelDataWindow $data: the data which will be used to construct the entry.
__toString (line 346)

Turn this entry into a string.

  • return: a string representation of this entry. This is mostly for debugging.
string __toString ()

SourceForge.net Logo Documentation generated on Wed, 21 Jul 2004 19:12:58 +0200 by phpDocumentor 1.3.0RC3