PageSettings
in package

Table of Contents

getBookingConfirmCancellationPage()  : int
getBookingConfirmedPageId()  : int
getBookingConfirmedPageUrl()  : string|false
getCheckoutPageId()  : int
Retrieve checkout page id.
getCheckoutPageUrl()  : string|bool
Retrieve checkout page url.
getMyAccountPageId()  : mixed
getOpenTermsAndConditionsInNewWindow()  : bool
getPaymentFailedPageId()  : int
getPaymentFailedPageUrl()  : string
getPaymentSuccessPageId()  : int
getPaymentSuccessPageUrl()  : string|false
getReservationReceivedPageId()  : int
getReservationReceivedPageUrl()  : string|false
getSearchResultsPageId()  : int
getSearchResultsPageUrl()  : string|bool
getTermsAndConditionsPageId()  : int
getUrl()  : string|false
getUserCancelRedirectPageId()  : int|false
getUserCancelRedirectPageUrl()  : string|false
setBookingConfirmCancellationPage()  : bool
setBookingConfirmPage()  : bool
setCheckoutPage()  : bool
setMyAccountPageId()  : mixed
setPaymentFailedPage()  : bool
setPaymentSuccessPage()  : bool
setSearchResultsPage()  : bool
setUserCancelRedirectPage()  : bool
getPageId()  : int

Methods

getBookingConfirmCancellationPage()

public getBookingConfirmCancellationPage() : int
Tags
since
3.9.9
Return values
int —

getBookingConfirmedPageId()

public getBookingConfirmedPageId() : int
Tags
since
3.7.0

the name was changed from "getBookingConfirmPageId".

Return values
int —

getBookingConfirmedPageUrl()

public getBookingConfirmedPageUrl() : string|false
Tags
since
3.7.0

the name was changed from "getBookingConfirmPageUrl".

Return values
string|false —

getCheckoutPageId()

Retrieve checkout page id.

public getCheckoutPageId() : int

The Checkout Page ID or 0 if checkout page not setted.

Return values
int —

getCheckoutPageUrl()

Retrieve checkout page url.

public getCheckoutPageUrl() : string|bool

Description: The permalink URL or false if post does not exist or checkout page not setted.

Return values
string|bool —

getMyAccountPageId()

public getMyAccountPageId() : mixed
Tags
since
4.2.0
Return values
mixed —

getOpenTermsAndConditionsInNewWindow()

public getOpenTermsAndConditionsInNewWindow() : bool
Tags
since
4.2.5
Return values
bool —

getPaymentFailedPageId()

public getPaymentFailedPageId() : int
Return values
int —

getPaymentFailedPageUrl()

public getPaymentFailedPageUrl([Payment $payment = null ][, mixed $additionalArgs = array() ]) : string
Parameters
$payment : Payment = null

Optional.

$additionalArgs : mixed = array()
Return values
string —

getPaymentSuccessPageUrl()

public getPaymentSuccessPageUrl([Payment $payment = null ][, array<string|int, mixed> $additionalArgs = array() ]) : string|false
Parameters
$payment : Payment = null

Optional.

$additionalArgs : array<string|int, mixed> = array()

Optional.

Tags
deprecated

since 3.7

see
PageSettings::getReservationReceivedPageUrl()
Return values
string|false —

getReservationReceivedPageId()

public getReservationReceivedPageId() : int
Tags
since
3.7.0
Return values
int —

getReservationReceivedPageUrl()

public getReservationReceivedPageUrl([Payment $payment = null ][, array<string|int, mixed> $additionalArgs = array() ]) : string|false
Parameters
$payment : Payment = null

Optional.

$additionalArgs : array<string|int, mixed> = array()

Optional.

Tags
since
3.7.0
Return values
string|false —

getSearchResultsPageId()

public getSearchResultsPageId() : int
Return values
int —

getSearchResultsPageUrl()

public getSearchResultsPageUrl() : string|bool
Return values
string|bool —

False if search results page was not setted.

getTermsAndConditionsPageId()

public getTermsAndConditionsPageId() : int
Return values
int —

getUrl()

public getUrl(string|int $id) : string|false
Parameters
$id : string|int
Return values
string|false —

getUserCancelRedirectPageId()

public getUserCancelRedirectPageId() : int|false
Return values
int|false —

getUserCancelRedirectPageUrl()

public getUserCancelRedirectPageUrl() : string|false
Return values
string|false —

setBookingConfirmCancellationPage()

public setBookingConfirmCancellationPage(string $id) : bool
Parameters
$id : string

ID of page

Tags
since
3.9.9
Return values
bool —

False if value was not updated and true if value was updated.

setBookingConfirmPage()

public setBookingConfirmPage(string $id) : bool
Parameters
$id : string

ID of page

Return values
bool —

False if value was not updated and true if value was updated.

setCheckoutPage()

public setCheckoutPage(string $id) : bool
Parameters
$id : string

ID of page

Return values
bool —

False if value was not updated and true if value was updated.

setMyAccountPageId()

public setMyAccountPageId(int $id) : mixed
Parameters
$id : int
Tags
since
4.2.0
Return values
mixed —

setPaymentFailedPage()

public setPaymentFailedPage(string $id) : bool
Parameters
$id : string

ID of page

Return values
bool —

False if value was not updated and true if value was updated.

setPaymentSuccessPage()

public setPaymentSuccessPage(string $id) : bool
Parameters
$id : string

ID of page

Return values
bool —

False if value was not updated and true if value was updated.

setSearchResultsPage()

public setSearchResultsPage(string $id) : bool
Parameters
$id : string

ID of page

Return values
bool —

False if value was not updated and true if value was updated.

setUserCancelRedirectPage()

public setUserCancelRedirectPage(string $id) : bool
Parameters
$id : string

ID of page

Return values
bool —

False if value was not updated and true if value was updated.

getPageId()

private getPageId(string $name) : int
Parameters
$name : string
Return values
int —

Search results