Documentation

CompanyPackage
in package
uses IdentifiableTrait

AbstractYes

CompanyPackage model.

Attributes
#[DiscriminatorColumn]
$name: 'packageType'
$type: 'string'
$enumType: \Company\Model\Enums\CompanyPackageTypes::class
#[DiscriminatorMap]
$value: ['job' => \Company\Model\CompanyJobPackage::class, 'banner' => \Company\Model\CompanyBannerPackage::class, 'featured' => \Company\Model\CompanyFeaturedPackage::class]
#[Entity]
#[InheritanceType]
$value: 'SINGLE_TABLE'

Table of Contents

Properties

$company  : Company
The package's company.
$contractNumber  : string|null
An alphanumeric strings which identifies to which contract this package belongs.
$expires  : DateTime
The package's expiration date.
$id  : int|null
The default value must be `null` to prevent issues with auto generating the value. The column is strictly not nullable.
$published  : bool
The package's published state.
$starts  : DateTime
The package's starting date.

Methods

__construct()  : mixed
exchangeArray()  : void
getCompany()  : Company
Get the package's company.
getContractNumber()  : string|null
getExpirationDate()  : DateTime
Get the package's expiration date.
getId()  : int|null
Get the identifier of the object.
getStartingDate()  : DateTime
Get the package's starting date.
getType()  : CompanyPackageTypes
Gets the type of the package.
isActive()  : bool
isExpired()  : bool
Check whether this package is expired.
isPublished()  : bool
Get the package's publish state.
setCompany()  : void
Set the package's company.
setContractNumber()  : void
setExpirationDate()  : void
Set the package's expiration date.
setId()  : void
Setting the identifier manually will, in most instances, result in undefined behaviour. Use with caution!
setPublished()  : void
Set the package's publish state.
setStartingDate()  : void
Set the package's starting date.
toArray()  : array{contractNumber: ?string, startDate: string, expirationDate: string, published: bool}

Properties

$company

The package's company.

protected Company $company
Attributes
#[ManyToOne]
$targetEntity: \Company\Model\Company::class
$inversedBy: 'packages'

$contractNumber

An alphanumeric strings which identifies to which contract this package belongs.

protected string|null $contractNumber = null
Attributes
#[Column]
$type: 'string'
$nullable: true

$expires

The package's expiration date.

protected DateTime $expires
Attributes
#[Column]
$type: 'date'

$id

The default value must be `null` to prevent issues with auto generating the value. The column is strictly not nullable.

protected int|null $id = null
Attributes
#[Column]
$type: 'integer'
#[GeneratedValue]
$strategy: 'IDENTITY'
#[Id]

$published

The package's published state.

protected bool $published
Attributes
#[Column]
$type: 'boolean'

$starts

The package's starting date.

protected DateTime $starts
Attributes
#[Column]
$type: 'date'

Methods

exchangeArray()

public exchangeArray(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>
Tags
psalm-param

array{ contractNumber: ?string, startDate?: string, expirationDate?: string, published?: bool|string, } $data

throws
Exception

getContractNumber()

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

getExpirationDate()

Get the package's expiration date.

public getExpirationDate() : DateTime
Return values
DateTime

getId()

Get the identifier of the object.

public getId() : int|null
Tags
psalm-ignore-nullable-return
Return values
int|null

getStartingDate()

Get the package's starting date.

public getStartingDate() : DateTime
Return values
DateTime

isExpired()

Check whether this package is expired.

public isExpired() : bool
Return values
bool

isPublished()

Get the package's publish state.

public isPublished() : bool
Return values
bool

setContractNumber()

public setContractNumber(string|null $contractNumber) : void
Parameters
$contractNumber : string|null

setExpirationDate()

Set the package's expiration date.

public setExpirationDate(DateTime $expires) : void
Parameters
$expires : DateTime

setId()

Setting the identifier manually will, in most instances, result in undefined behaviour. Use with caution!

public setId(int|null $id) : void
Parameters
$id : int|null

setPublished()

Set the package's publish state.

public setPublished(bool $published) : void
Parameters
$published : bool

setStartingDate()

Set the package's starting date.

public setStartingDate(DateTime $starts) : void
Parameters
$starts : DateTime

toArray()

public toArray() : array{contractNumber: ?string, startDate: string, expirationDate: string, published: bool}
Return values
array{contractNumber: ?string, startDate: string, expirationDate: string, published: bool} 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results