Reservation Class Reference

Inheritance diagram for Reservation:

Public Member Functions
	__construct ( $reservationId, int $stockId, string $sku, float $quantity, $metadata=null)
	getReservationId ()
	getStockId ()
	getSku ()
	getQuantity ()
	getMetadata ()

Additional Inherited Members
Data Fields inherited from ReservationInterface
const	RESERVATION_ID = 'reservation_id'
const	STOCK_ID = 'stock_id'
const	SKU = 'sku'
const	QUANTITY = 'quantity'
const	METADATA = 'metadata'

Detailed Description

{}

@codeCoverageIgnore

Definition at line 17 of file Reservation.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$reservationId,
		int	$stockId,
		string	$sku,
		float	$quantity,
			$metadata = null
	)

Parameters

int | null	$reservationId
int	$stockId
string	$sku
float	$quantity
null	$metadata

Definition at line 51 of file Reservation.php.

      {
        $this->reservationId = $reservationId;
        $this->stockId = $stockId;
        $this->sku = $sku;
        $this->quantity = $quantity;
        $this->metadata = $metadata;
    }

Member Function Documentation

getMetadata()

getMetadata

(

)

Get Reservation MetadataMetadata is used to store serialized data that encapsulates the semantic of a Reservation.

Returns

string|null

Implements ReservationInterface.

Definition at line 102 of file Reservation.php.

                                 : ?string
    {
        return $this->metadata;
    }

getQuantity()

getQuantity

(

)

Get Product QtyThis value can be positive (>0) or negative (<0) depending on the Reservation semantic.For example, when an Order is placed, a Reservation with negative quantity is appended. When that Order is processed and the SourceItems related to ordered products are updated, a Reservation with positive quantity is appended to neglect the first one.

Returns

float

Implements ReservationInterface.

Definition at line 94 of file Reservation.php.

                                 : float
    {
        return $this->quantity;
    }

getReservationId()

getReservationId

(

)

Get Reservation Id

Returns

int|null

Implements ReservationInterface.

Definition at line 68 of file Reservation.php.

                                      : ?int
    {
        return $this->reservationId === null ?
            null:
            (int)$this->reservationId;
    }

getSku()

getSku

(

)

Get Product SKU

Returns

string

Implements ReservationInterface.

Definition at line 86 of file Reservation.php.

                            : string
    {
        return $this->sku;
    }

getStockId()

getStockId

(

)

Get Stock Id

Returns

int

Implements ReservationInterface.

Definition at line 78 of file Reservation.php.

                                : int
    {
        return $this->stockId;
    }

---

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

• vendor/magento/module-inventory-reservations/Model/Reservation.php