ISO2709RecordSetArray Class Reference

Inheritance diagram for ISO2709RecordSetArray:

Public Member Functions
	__construct ( $input, $numCache=10)
	offsetExists ( $offset)
	offsetGet ( $offset)
	offsetSet ( $offset, $value)
	offsetUnset ( $offset)

Public Attributes
	$records
	$numRecords
	$cache
	$recordOffsets
	$numCache
	$recordClass

Protected Attributes
	$input

Detailed Description

Definition at line 51 of file ISO2709.php.

Constructor & Destructor Documentation

__construct()

ISO2709RecordSetArray::__construct	(		$input,
			$numCache = 10
	)

Definition at line 54 of file ISO2709.php.

References ISO2709RecordSetIterator\$input.

                                                    {

         if( is_string( $input ) ) $input = fopen( $input, "rb" );

         if( !is_resource( $input ) ) throw new Exception("ISO2709RecordSetArray requires a file resource, filename, or URL to be created");

         $this->input = $input;

         $this->records = array();

         $this->cache = array();

         $this->recordOffsets = array();

         $this->recordOffsets[0] = 0;

         $this->numCache = $numCache;

         $this->recordClass = "ISO2709Record";

     }

Member Function Documentation

offsetExists()

ISO2709RecordSetArray::offsetExists

(

$offset

)

Definition at line 66 of file ISO2709.php.

                                             {

         if(!is_int($offset) or $offset < 0 or ($this->numRecords !== null and $this->numRecords <= $offset))

             return false;

         return $this->offsetGet( $offset ) === false;

     }

offsetGet()

ISO2709RecordSetArray::offsetGet

(

$offset

)

Definition at line 72 of file ISO2709.php.

References ISO2709\RecordTerminator.

                                           {

         # Update cache


         foreach( array_keys( $this->cache, $offset ) as $k ) { unset($this->cache[$k]); }

         $this->cache = array_values( $this->cache );

         array_push( $this->cache, $offset );

         while( count( $this->cache ) > $this->numCache ) {

             $k = array_shift( $this->cache );

             unset( $this->records[$k] );

         }

         # Now get the record


         if( !isset( $this->records[ $offset ] ) ) {

             if( !isset( $this->recordOffsets[$offset] ) ) {

                 for( $i = $offset - 1 ; $i > 0 ; $i-- ) {

                     if( isset( $this->recordOffsets[$i] ) ) break;

                 }

                 fseek( $this->input, $this->recordOffsets[$i], SEEK_SET );

                 while( $i < $offset ) {

                     stream_get_line( $this->input, 99999, ISO2709::RecordTerminator );

                     $i++;

                     $this->recordOffsets[ $i ] = ftell( $this->input );

                 }

             } else {

                 fseek( $this->input, $this->recordOffsets[$offset], SEEK_SET );

             }

             $this->records[ $offset ] = new $this->recordClass();

             $this->records[ $offset ]->loadFromBinaryStream( $this->input );

             if(feof($this->input)) {

                 $this->numRecords = $offset+1;

             } else {

                 $this->recordOffsets[$offset+1] = ftell( $this->input );

             }

         }

         return $this->records[ $offset ];

     }

offsetSet()

ISO2709RecordSetArray::offsetSet	(		$offset,
			$value
	)

Definition at line 107 of file ISO2709.php.

                                                   {

         throw new Exception( "This type of record set is read-only, sorry" );

     }

offsetUnset()

ISO2709RecordSetArray::offsetUnset

(

$offset

)

Definition at line 111 of file ISO2709.php.

                                             {

         throw new Exception( "This type of record set is read-only, sorry" );

     }

Member Data Documentation

$cache

ISO2709RecordSetArray::$cache

Definition at line 52 of file ISO2709.php.

$input

ISO2709RecordSetArray::$input

protected

Definition at line 52 of file ISO2709.php.

$numCache

ISO2709RecordSetArray::$numCache

Definition at line 52 of file ISO2709.php.

$numRecords

ISO2709RecordSetArray::$numRecords

Definition at line 52 of file ISO2709.php.

$recordClass

ISO2709RecordSetArray::$recordClass

Definition at line 52 of file ISO2709.php.

$recordOffsets

ISO2709RecordSetArray::$recordOffsets

Definition at line 52 of file ISO2709.php.

$records

ISO2709RecordSetArray::$records

Definition at line 52 of file ISO2709.php.

---

The documentation for this class was generated from the following file:

• grimas/ISO2709.php