BCard - Documentation technique

Order
in package

Commande passée par un utilisateur (carte physique ou abonnement professionnel).

Une commande appartient à un User obligatoire (user, many-to-one, colonne non nullable) et porte ses lignes (orderItems, one-to-many vers OrderItem, persistance en cascade) ainsi que ses paiements (payments, one-to-many vers Payment). status est une chaîne libre initialisée à self::EN_ATTENTE à la construction ; les valeurs possibles sont définies par les constantes de la classe (EN_ATTENTE, EN_ATTENTE_PAIEMENT, EN_TRAITEMENT, TERMINER, REMBOURSE, ANNULER, ainsi que PRO_SUBSCRIPTION et DRAFT qui qualifient plutôt la nature de la commande que son avancement) — rien dans cette classe ne contraint la transition d'un statut à un autre.

Les champs de suivi d'expédition (tracking_number, shipping_carrier, shipped_at, delivered_at) et d'annulation (cancellationReason, cancelledAt) sont tous nullables et ne sont renseignés que pour les commandes concernées. stripeSessionId relie la commande à une session Stripe Checkout lorsque le paiement passe par ce canal.

Attributes
#[Entity]
$repositoryClass: \App\Repository\OrderRepository::class
#[Table]
$name: '`order`'

Table of Contents

Constants

ANNULER  : mixed = "Annulée"
DRAFT  : mixed = "DRAFT"
EN_ATTENTE  : mixed = "En Attente"
EN_ATTENTE_PAIEMENT  : mixed = "En attente de paiement"
EN_TRAITEMENT  : mixed = "En traitement"
PRO_SUBSCRIPTION  : mixed = "PRO_SUBSCRIPTION"
REMBOURSE  : mixed = "Remboursée"
TERMINER  : mixed = "Terminée"

Properties

$address_to_delivery  : string|null
$cancellationReason  : string|null
$cancelledAt  : DateTimeImmutable|null
$compagny_name  : string|null
$created_at  : DateTimeImmutable|null
$delivered_at  : DateTimeImmutable|null
$email  : string|null
$firstname  : string|null
$id  : int|null
$lastname  : string|null
$order_notes  : string|null
$orderItems  : Collection<int, OrderItem>
$paymentMethod  : string|null
$payments  : Collection<int, Payment>
$phone  : string|null
$shipped_at  : DateTimeImmutable|null
$shipping_carrier  : string|null
$status  : string|null
$stripeSessionId  : string|null
$total  : string|null
$tracking_number  : string|null
$user  : User|null

Methods

__construct()  : mixed
addOrderItem()  : static
addPayment()  : static
getAddressToDelivery()  : string|null
getCancellationReason()  : string|null
getCancelledAt()  : DateTimeImmutable|null
getCompagnyName()  : string|null
getCreatedAt()  : DateTimeImmutable|null
getDeliveredAt()  : DateTimeImmutable|null
getEmail()  : string|null
getFirstname()  : string|null
getId()  : int|null
getLastname()  : string|null
getOrderItems()  : Collection<int, OrderItem>
getOrderNotes()  : string|null
getPaymentMethod()  : string|null
getPayments()  : Collection<int, Payment>
getPhone()  : string|null
getShippedAt()  : DateTimeImmutable|null
getShippingCarrier()  : string|null
getStatus()  : string|null
getStripeSessionId()  : string|null
getTotal()  : string|null
getTrackingNumber()  : string|null
getUser()  : User|null
removeOrderItem()  : static
removePayment()  : static
setAddressToDelivery()  : static
setCancellationReason()  : static
setCancelledAt()  : static
setCompagnyName()  : static
setCreatedAt()  : static
setDeliveredAt()  : static
setEmail()  : static
setFirstname()  : static
setLastname()  : static
setOrderNotes()  : static
setPaymentMethod()  : static
setPhone()  : static
setShippedAt()  : static
setShippingCarrier()  : static
setStatus()  : static
setStripeSessionId()  : static
setTotal()  : static
setTrackingNumber()  : static
setUser()  : static

Constants

ANNULER

public mixed ANNULER = "Annulée"

DRAFT

public mixed DRAFT = "DRAFT"

EN_ATTENTE

public mixed EN_ATTENTE = "En Attente"

EN_ATTENTE_PAIEMENT

public mixed EN_ATTENTE_PAIEMENT = "En attente de paiement"

EN_TRAITEMENT

public mixed EN_TRAITEMENT = "En traitement"

PRO_SUBSCRIPTION

public mixed PRO_SUBSCRIPTION = "PRO_SUBSCRIPTION"

REMBOURSE

public mixed REMBOURSE = "Remboursée"

TERMINER

public mixed TERMINER = "Terminée"

Properties

$address_to_delivery

private string|null $address_to_delivery = null
Attributes
#[Column]
$length: 255
$nullable: true

$cancellationReason

private string|null $cancellationReason = null
Attributes
#[Column]
$length: 255
$nullable: true

$cancelledAt

private DateTimeImmutable|null $cancelledAt = null
Attributes
#[Column]
$nullable: true

$compagny_name

private string|null $compagny_name = null
Attributes
#[Column]
$length: 255
$nullable: true

$created_at

private DateTimeImmutable|null $created_at = null
Attributes
#[Column]

$delivered_at

private DateTimeImmutable|null $delivered_at = null
Attributes
#[Column]
$nullable: true

$email

private string|null $email = null
Attributes
#[Column]
$length: 255

$firstname

private string|null $firstname = null
Attributes
#[Column]
$length: 255

$id

private int|null $id = null
Attributes
#[Column]
#[GeneratedValue]
#[Id]

$lastname

private string|null $lastname = null
Attributes
#[Column]
$length: 255

$order_notes

private string|null $order_notes = null
Attributes
#[Column]
$length: 255
$nullable: true

$orderItems

private Collection<int, OrderItem> $orderItems
Attributes
#[OneToMany]
$targetEntity: \App\Entity\OrderItem::class
$mappedBy: 'orders'
$cascade: ['persist']

$paymentMethod

private string|null $paymentMethod = null
Attributes
#[Column]
$length: 255
$nullable: true

$payments

private Collection<int, Payment> $payments
Attributes
#[OneToMany]
$targetEntity: \App\Entity\Payment::class
$mappedBy: 'order'

$phone

private string|null $phone = null
Attributes
#[Column]
$length: 255

$shipped_at

private DateTimeImmutable|null $shipped_at = null
Attributes
#[Column]
$nullable: true

$shipping_carrier

private string|null $shipping_carrier = null
Attributes
#[Column]
$length: 255
$nullable: true

$status

private string|null $status = null
Attributes
#[Column]
$length: 255

$stripeSessionId

private string|null $stripeSessionId = null
Attributes
#[Column]
$length: 255
$nullable: true

$total

private string|null $total = null
Attributes
#[Column]
$length: 255

$tracking_number

private string|null $tracking_number = null
Attributes
#[Column]
$length: 255
$nullable: true

$user

private User|null $user = null
Attributes
#[JoinColumn]
$nullable: false
#[ManyToOne]
$cascade: ['persist']
$inversedBy: 'orders'

Methods

__construct()

public __construct() : mixed

addOrderItem()

public addOrderItem(OrderItem $orderItem) : static
Parameters
$orderItem : OrderItem
Return values
static

addPayment()

public addPayment(Payment $payment) : static
Parameters
$payment : Payment
Return values
static

getAddressToDelivery()

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

getCancellationReason()

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

getCancelledAt()

public getCancelledAt() : DateTimeImmutable|null
Return values
DateTimeImmutable|null

getCompagnyName()

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

getCreatedAt()

public getCreatedAt() : DateTimeImmutable|null
Return values
DateTimeImmutable|null

getDeliveredAt()

public getDeliveredAt() : DateTimeImmutable|null
Return values
DateTimeImmutable|null

getEmail()

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

getFirstname()

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

getId()

public getId() : int|null
Return values
int|null

getLastname()

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

getOrderNotes()

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

getPaymentMethod()

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

getPayments()

public getPayments() : Collection<int, Payment>
Return values
Collection<int, Payment>

getPhone()

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

getShippedAt()

public getShippedAt() : DateTimeImmutable|null
Return values
DateTimeImmutable|null

getShippingCarrier()

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

getStatus()

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

getStripeSessionId()

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

getTotal()

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

getTrackingNumber()

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

removeOrderItem()

public removeOrderItem(OrderItem $orderItem) : static
Parameters
$orderItem : OrderItem
Return values
static

removePayment()

public removePayment(Payment $payment) : static
Parameters
$payment : Payment
Return values
static

setAddressToDelivery()

public setAddressToDelivery(string|null $address_to_delivery) : static
Parameters
$address_to_delivery : string|null
Return values
static

setCancellationReason()

public setCancellationReason(string|null $cancellationReason) : static
Parameters
$cancellationReason : string|null
Return values
static

setCancelledAt()

public setCancelledAt(DateTimeImmutable|null $cancelledAt) : static
Parameters
$cancelledAt : DateTimeImmutable|null
Return values
static

setCompagnyName()

public setCompagnyName(string|null $compagny_name) : static
Parameters
$compagny_name : string|null
Return values
static

setCreatedAt()

public setCreatedAt(DateTimeImmutable $created_at) : static
Parameters
$created_at : DateTimeImmutable
Return values
static

setDeliveredAt()

public setDeliveredAt(DateTimeImmutable|null $delivered_at) : static
Parameters
$delivered_at : DateTimeImmutable|null
Return values
static

setEmail()

public setEmail(string $email) : static
Parameters
$email : string
Return values
static

setFirstname()

public setFirstname(string $firstname) : static
Parameters
$firstname : string
Return values
static

setLastname()

public setLastname(string $lastname) : static
Parameters
$lastname : string
Return values
static

setOrderNotes()

public setOrderNotes(string $order_notes) : static
Parameters
$order_notes : string
Return values
static

setPaymentMethod()

public setPaymentMethod(string|null $paymentMethod) : static
Parameters
$paymentMethod : string|null
Return values
static

setPhone()

public setPhone(string $phone) : static
Parameters
$phone : string
Return values
static

setShippedAt()

public setShippedAt(DateTimeImmutable|null $shipped_at) : static
Parameters
$shipped_at : DateTimeImmutable|null
Return values
static

setShippingCarrier()

public setShippingCarrier(string|null $shipping_carrier) : static
Parameters
$shipping_carrier : string|null
Return values
static

setStatus()

public setStatus(string $status) : static
Parameters
$status : string
Return values
static

setStripeSessionId()

public setStripeSessionId(string|null $stripeSessionId) : static
Parameters
$stripeSessionId : string|null
Return values
static

setTotal()

public setTotal(string $total) : static
Parameters
$total : string
Return values
static

setTrackingNumber()

public setTrackingNumber(string|null $tracking_number) : static
Parameters
$tracking_number : string|null
Return values
static

setUser()

public setUser(User|null $user) : static
Parameters
$user : User|null
Return values
static 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results