Index Documentation

JsonProperty
in package

FinalYes

Defines a class method or property as a JSON object property.

Attributes
#[Attribute]
\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY

Table of Contents

Methods

__construct()  : mixed
getName()  : string|null
Gets name for the property value in the JSON object.
getOmittedValues()  : array<string|int, mixed>
Gets which values should be omitted.
getOrder()  : int
Gets the order value for this property.
shouldBeOmitted()  : bool
Checks whether a given value should be omitted from the JSON object.
shouldConvertNumbersToString()  : bool
Gets whether numbers should be converted to string.
shouldOmitIfNull()  : bool
Gets whether this should be omitted if the value is null.

Methods

__construct()

public __construct([string $name = null ][, int $order = 0 ][, bool $omitIfNull = true ][, mixed|array<string|int, mixed> $omitIfValue = [] ][, bool $numbersAsString = false ]) : mixed
Parameters
$name : string = null

Name of the property in the JSON object.

$order : int = 0

Ordering of the property in the JSON object.

$omitIfNull : bool = true

Whether the value should be omitted if its null.

$omitIfValue : mixed|array<string|int, mixed> = []

Which values should be omitted.

$numbersAsString : bool = false

Whether numbers should be cast to strings.

getName()

Gets name for the property value in the JSON object.

public getName() : string|null
Return values
string|null

getOmittedValues()

Gets which values should be omitted.

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

getOrder()

Gets the order value for this property.

public getOrder() : int
Return values
int

shouldBeOmitted()

Checks whether a given value should be omitted from the JSON object.

public shouldBeOmitted(mixed $value) : bool
Parameters
$value : mixed

Value to check.

Return values
bool

shouldConvertNumbersToString()

Gets whether numbers should be converted to string.

public shouldConvertNumbersToString() : bool
Return values
bool

shouldOmitIfNull()

Gets whether this should be omitted if the value is null.

public shouldOmitIfNull() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results