Documentation

Eif
in package

Table of Contents

Properties

$items  : array<string|int, EifRecord>
$rid  : array<string|int, int>
$byteSize  : int
$totalItemsCount  : int
$version  : int

Methods

__toString()  : string
Returns a string representation of the object.
deserialize()  : Eif
Deserializes an instance of `Eif` from the provided `EoReader`.
getByteSize()  : int
Returns the size of the data that this was deserialized from.
getItems()  : array<string|int, EifRecord>
getRid()  : array<string|int, int>
getTotalItemsCount()  : int
getVersion()  : int
serialize()  : void
Serializes an instance of `Eif` to the provided `EoWriter`.
setByteSize()  : void
Sets the size of the data that this was deserialized from.
setItems()  : void
setRid()  : void
setTotalItemsCount()  : void
setVersion()  : void

Properties

$rid

public array<string|int, int> $rid = []

$byteSize

private int $byteSize = 0

$totalItemsCount

private int $totalItemsCount

$version

private int $version

Methods

__toString()

Returns a string representation of the object.

public __toString() : string
Return values
string

deserialize()

Deserializes an instance of `Eif` from the provided `EoReader`.

public static deserialize(EoReader $reader) : Eif
Parameters
$reader : EoReader

The reader that the data will be deserialized from.

Return values
Eif —

The deserialized data.

getByteSize()

Returns the size of the data that this was deserialized from.

public getByteSize() : int
Return values
int —

The size of the data that this was deserialized from.

getRid()

public getRid() : array<string|int, int>
Return values
array<string|int, int>

getTotalItemsCount()

public getTotalItemsCount() : int
Return values
int

getVersion()

public getVersion() : int
Return values
int

serialize()

Serializes an instance of `Eif` to the provided `EoWriter`.

public static serialize(EoWriter $writer, Eif $data) : void
Parameters
$writer : EoWriter

The writer that the data will be serialized to.

$data : Eif

The data to serialize.

setByteSize()

Sets the size of the data that this was deserialized from.

public setByteSize(int $byteSize) : void
Parameters
$byteSize : int

The size of the data that this was deserialized from.

setItems()

public setItems(array<string|int, EifRecord> $items) : void
Parameters
$items : array<string|int, EifRecord>

setRid()

public setRid(array<string|int, int> $rid) : void
Parameters
$rid : array<string|int, int>

setTotalItemsCount()

public setTotalItemsCount(int $totalItemsCount) : void
Parameters
$totalItemsCount : int

setVersion()

public setVersion(int $version) : void
Parameters
$version : int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results