Agreement
in package
implements
AgreementInterface
Class Agreement
Tags
Interfaces, Classes and Traits
- AgreementInterface
- Interface AgreementInterface
Table of Contents
- $contentGroup : IdType
- $customer : mixed
- $dateAdded : DateTime
- $id : IdType
- $ipAddress : StringType
- $languageId : IdType
- $lastModifiedDate : DateTime
- $legalTextVersion : StringType
- $repository : AgreementRepositoryInterface
- $text : NonEmptyStringType
- __construct() : mixed
- Agreement constructor.
- delete() : $this|Agreement
- Deletes the agreement.
- getContentGroup() : IdType
- Returns the content group ID of the legal text.
- getCustomer() : AgreementCustomerInterface
- Returns the customers of the agreement.
- getDateAdded() : DateTime
- Returns the date and time of the agreement.
- getId() : IdType
- Returns the agreement id.
- getIpAddress() : StringType
- Returns the IP address of the customer which confirmed the agreement.
- getLanguageId() : IdType
- Returns the language ID of the agreement.
- getLastModifiedDateTime() : DateTime
- Returns the last modified date of the agreement.
- getLegalTextVersion() : StringType
- Returns the version of the legal text.
- getText() : NonEmptyStringType
- Returns the text of the agreement.
- setContentGroup() : $this|AgreementInterface
- Sets the content group of the legal text.
- setCustomer() : $this|AgreementInterface
- Sets the customers to the agreement.
- setDateAdded() : $this|AgreementInterface
- Sets the date of the agreement.
- setId() : $this|AgreementInterface
- Sets the agreement id.
- setIpAddress() : $this|AgreementInterface
- Sets the IP address of the customer which confirmed the agreement.
- setLanguageId() : $this|AgreementInterface
- Sets the language ID of the agreement.
- setLastModifiedDate() : $this|AgreementInterface
- Sets the last modified date of the agreement.
- setLegalTextVersion() : $this|AgreementInterface
- Sets the version of the legal text.
- setText() : $this|AgreementInterface
- Sets the text of the agreement.
- store() : $this|Agreement
- Stores the agreement.
Properties
$contentGroup
protected
IdType
$contentGroup
= 0
$customer
protected
mixed
$customer
$dateAdded
protected
DateTime
$dateAdded
$id
protected
IdType
$id
= 0
$ipAddress
protected
StringType
$ipAddress
= ''
$languageId
protected
IdType
$languageId
= 0
$lastModifiedDate
protected
DateTime
$lastModifiedDate
$legalTextVersion
protected
StringType
$legalTextVersion
= ''
$repository
protected
AgreementRepositoryInterface
$repository
$text
protected
NonEmptyStringType
$text
= ''
Methods
__construct()
Agreement constructor.
public
__construct(AgreementRepositoryInterface $repository) : mixed
Parameters
- $repository : AgreementRepositoryInterface
-
.
Return values
mixed —delete()
Deletes the agreement.
public
delete() : $this|Agreement
Return values
$this|Agreement —Same instance for chained method calls.
getContentGroup()
Returns the content group ID of the legal text.
public
getContentGroup() : IdType
Return values
IdType —getCustomer()
Returns the customers of the agreement.
public
getCustomer() : AgreementCustomerInterface
Return values
AgreementCustomerInterface —Customer.
getDateAdded()
Returns the date and time of the agreement.
public
getDateAdded() : DateTime
Return values
DateTime —Date and time of the agreement.
getId()
Returns the agreement id.
public
getId() : IdType
Return values
IdType —Agreement id.
getIpAddress()
Returns the IP address of the customer which confirmed the agreement.
public
getIpAddress() : StringType
Return values
StringType —getLanguageId()
Returns the language ID of the agreement.
public
getLanguageId() : IdType
Return values
IdType —Language ID.
getLastModifiedDateTime()
Returns the last modified date of the agreement.
public
getLastModifiedDateTime() : DateTime
Return values
DateTime —Date and time of the agreement.
getLegalTextVersion()
Returns the version of the legal text.
public
getLegalTextVersion() : StringType
Return values
StringType —getText()
Returns the text of the agreement.
public
getText() : NonEmptyStringType
Return values
NonEmptyStringType —setContentGroup()
Sets the content group of the legal text.
public
setContentGroup(IdType $contentGroup) : $this|AgreementInterface
Parameters
- $contentGroup : IdType
Return values
$this|AgreementInterface —Same instance for chained method calls.
setCustomer()
Sets the customers to the agreement.
public
setCustomer(AgreementCustomerInterface $customer) : $this|AgreementInterface
Parameters
- $customer : AgreementCustomerInterface
-
Customer.
Return values
$this|AgreementInterface —Same instance for chained method calls.
setDateAdded()
Sets the date of the agreement.
public
setDateAdded(DateTime $dateTime) : $this|AgreementInterface
Parameters
- $dateTime : DateTime
-
Date and time.
Return values
$this|AgreementInterface —Same instance for chained method calls.
setId()
Sets the agreement id.
public
setId(IdType $id) : $this|AgreementInterface
Parameters
- $id : IdType
-
The agreement id to be set.
Return values
$this|AgreementInterface —Same instance for chained method calls.
setIpAddress()
Sets the IP address of the customer which confirmed the agreement.
public
setIpAddress(StringType $ipAddress) : $this|AgreementInterface
Parameters
- $ipAddress : StringType
Return values
$this|AgreementInterface —Same instance for chained method calls.
setLanguageId()
Sets the language ID of the agreement.
public
setLanguageId(IdType $languageId) : $this|AgreementInterface
Parameters
- $languageId : IdType
-
Language ID.
Return values
$this|AgreementInterface —Same instance for chained method calls.
setLastModifiedDate()
Sets the last modified date of the agreement.
public
setLastModifiedDate(DateTime $dateTime) : $this|AgreementInterface
Parameters
- $dateTime : DateTime
-
Date and time.
Return values
$this|AgreementInterface —Same instance for chained method calls.
setLegalTextVersion()
Sets the version of the legal text.
public
setLegalTextVersion(StringType $legalTextVersion) : $this|AgreementInterface
Parameters
- $legalTextVersion : StringType
-
Version of the legal text.
Return values
$this|AgreementInterface —Same instance for chained method calls.
setText()
Sets the text of the agreement.
public
setText(NonEmptyStringType $text) : $this|AgreementInterface
Parameters
- $text : NonEmptyStringType
-
Agreement text.
Return values
$this|AgreementInterface —Same instance for chained method calls.
store()
Stores the agreement.
public
store() : $this|Agreement
Return values
$this|Agreement —Same instance for chained method calls.