PHP Class PhpOrient\Protocols\Binary\Data\Record

Inheritance: implements ArrayAccess, implements JsonSerializable, implements PhpOrient\Protocols\Binary\Abstracts\SerializableInterface, use trait PhpOrient\Protocols\Common\ConfigurableTrait
Show file Open project: ostico/phporient Class Usage Examples

Protected Properties

Property Type Description
$oClass The class this record belongs to.
$oData The raw bytes that make up the record.
$rid The record id.
$version The record version.

Public Methods

Method Description
__get ( $name ) : mixed Magic Method, access directly to the Orient Record content as property
__set ( $name, $value ) Magic Method, set directly to the Orient Record content as property
__toString ( ) : string To String ( as alias of json_encode )
fromConfig ( array $options = [] ) : mixed Override the ConfigurableTrait fromConfig method to handle custom classes for records
getOClass ( ) : string | null Gets the Orient Class
getOData ( ) : string Gets the Orient Record Content
getRid ( ) : PhpOrient\Protocols\Binary\Data\ID Gets the Record ID
getVersion ( ) : integer Gets the Version
jsonSerialize ( ) : mixed (PHP 5 >= 5.4.0)
Specify data which should be serialized to JSON
offsetExists ( mixed $offset ) : boolean (PHP 5 >= 5.0.0)
Whether a offset exists
offsetGet ( mixed $offset ) : mixed (PHP 5 >= 5.0.0)
Offset to retrieve
offsetSet ( mixed $offset, mixed $value ) : void (PHP 5 >= 5.0.0)
Offset to set
offsetUnset ( mixed $offset ) : void (PHP 5 >= 5.0.0)
Offset to unset
recordSerialize ( ) : mixed Return a representation of the class that can be serialized as an PhpOrient record.
setOClass ( string $oClass ) Sets the Orient Class
setOData ( array $oData = null ) Sets the Orient Record Content
setRid ( PhpOrient\Protocols\Binary\Data\ID $rid ) Sets the Record Id
setVersion ( integer $version ) Sets the Version

Method Details

__get() public method

Magic Method, access directly to the Orient Record content as property
public __get ( $name ) : mixed
$name
return mixed

__set() public method

Magic Method, set directly to the Orient Record content as property
public __set ( $name, $value )
$name
$value

__toString() public method

To String ( as alias of json_encode )
public __toString ( ) : string
return string

fromConfig() public static method

Override the ConfigurableTrait fromConfig method to handle custom classes for records
public static fromConfig ( array $options = [] ) : mixed
$options array
return mixed

getOClass() public method

Gets the Orient Class
public getOClass ( ) : string | null
return string | null

getOData() public method

Gets the Orient Record Content
public getOData ( ) : string
return string

getRid() public method

Gets the Record ID
public getRid ( ) : PhpOrient\Protocols\Binary\Data\ID
return PhpOrient\Protocols\Binary\Data\ID

getVersion() public method

Gets the Version
public getVersion ( ) : integer
return integer

jsonSerialize() public method

(PHP 5 >= 5.4.0)
Specify data which should be serialized to JSON
See link: http://php.net/manual/en/jsonserializable.jsonserialize.php
public jsonSerialize ( ) : mixed
return mixed data which can be serialized by json_encode, which is a value of any type other than a resource.

offsetExists() public method

(PHP 5 >= 5.0.0)
Whether a offset exists
See link: http://php.net/manual/en/arrayaccess.offsetexists.php
public offsetExists ( mixed $offset ) : boolean
$offset mixed

An offset to check for.

return boolean true on success or false on failure.

The return value will be casted to boolean if non-boolean was returned.

offsetGet() public method

(PHP 5 >= 5.0.0)
Offset to retrieve
See link: http://php.net/manual/en/arrayaccess.offsetget.php
public offsetGet ( mixed $offset ) : mixed
$offset mixed

The offset to retrieve.

return mixed Can return all value types.

offsetSet() public method

(PHP 5 >= 5.0.0)
Offset to set
See link: http://php.net/manual/en/arrayaccess.offsetset.php
public offsetSet ( mixed $offset, mixed $value ) : void
$offset mixed

The offset to assign the value to.

$value mixed

The value to set.

return void

offsetUnset() public method

(PHP 5 >= 5.0.0)
Offset to unset
See link: http://php.net/manual/en/arrayaccess.offsetunset.php
public offsetUnset ( mixed $offset ) : void
$offset mixed

The offset to unset.

return void

recordSerialize() public method

Return a representation of the class that can be serialized as an PhpOrient record.
public recordSerialize ( ) : mixed
return mixed

setOClass() public method

Sets the Orient Class
public setOClass ( string $oClass )
$oClass string

setOData() public method

Sets the Orient Record Content
public setOData ( array $oData = null )
$oData array

setRid() public method

Sets the Record Id
public setRid ( PhpOrient\Protocols\Binary\Data\ID $rid )
$rid PhpOrient\Protocols\Binary\Data\ID

setVersion() public method

Sets the Version
public setVersion ( integer $version )
$version integer

Property Details

$oClass protected property

The class this record belongs to.
protected $oClass

$oData protected property

The raw bytes that make up the record.
protected $oData

$rid protected property

The record id.
protected $rid

$version protected property

The record version.
protected $version