1. class
  2. MongoDB
  3. \
  4. BSON
  5. \
  6. Binary

Binary

final class Binary implements Type, BinaryInterface, JsonSerializable, Stringable (View source)

Class Binary

Constants

TYPE_GENERIC

TYPE_FUNCTION

TYPE_OLD_BINARY

TYPE_OLD_UUID

TYPE_UUID

TYPE_MD5

TYPE_ENCRYPTED Since: 1.7.0

TYPE_COLUMN Since: 1.12.0

TYPE_SENSITIVE Since: 1.17.0

TYPE_VECTOR Since: 2.2.0

TYPE_USER_DEFINED

Methods

__construct(string $data, int $type = Binary::TYPE_GENERIC)

Binary constructor.

static Binary
fromVector(array $vector, VectorType $vectorType)

Create a binary from a given vector and vector type.

string
getData()

Returns the Binary's data

int
getType()

Returns the Binary's type

VectorType
getVectorType()

Returns the Binary's vector type

array
toArray()

Converts a binary vector to an array

static Binary
__set_state(array $properties)

No description

string
__toString()

Returns the Binary's data

mixed
jsonSerialize()

Returns a representation that can be converted to JSON

Details

at line 46
final __construct(string $data, int $type = Binary::TYPE_GENERIC)

Binary constructor.

Parameters

string $data
int $type

at line 52
final static Binary fromVector(array $vector, VectorType $vectorType)

Create a binary from a given vector and vector type.

Parameters

array $vector
VectorType $vectorType

Return Value

Binary

at line 58
final string getData()

Returns the Binary's data

Return Value

string

Returns the BinaryInterface's data

at line 64
final int getType()

Returns the Binary's type

Return Value

int

Returns the BinaryInterface's type.

at line 70
final VectorType getVectorType()

Returns the Binary's vector type

Return Value

VectorType

at line 76
final array toArray()

Converts a binary vector to an array

Return Value

array

at line 78
static Binary __set_state(array $properties)

No description

Parameters

array $properties

Return Value

Binary

at line 84
final string __toString()

Returns the Binary's data

Return Value

string

Returns the BinaryInterface's data.

at line 93
final mixed jsonSerialize()

Since: 1.2.0

Returns a representation that can be converted to JSON

Return Value

mixed

data which can be serialized by json_encode, which is a value of any type other than a resource.

Exceptions

InvalidArgumentException