1. class
  2. Plugins
  3. \
  4. EmpireGiftCardPlugin
  5. \
  6. Business
  7. \
  8. Manager
  9. \
  10. GiftCardManager

GiftCardManager

class GiftCardManager implements BasicEntityManagerInterface, JQGridInterface

Class GiftCardManager is injected as empire_gift_card_plugin.manager service. GiftCardManager handles the logic for entity.

Traits

JQGridManagerTrait
Trait JQGridManagerTrait

Constants

ADJUSTMENT_LABEL

Label for adjustment

Methods

mixed
searchForJQGRID(array $searchParams, array $sortParams = array(), array $additionalParams = array(), JQGridWrapper $jqGridWrapper = null)

No description

from JQGridManagerTrait
mixed
findAllForJQGRID(int $page, int $offset, array $sortParams, array $additionalParams = array(), JQGridWrapper $jqGridWrapper = null)

No description

from JQGridManagerTrait
mixed
getCountForJQGRID(array|null $searchParams = null, array|null $sortParams = null, array|null $additionalParams = array(), JQGridWrapper|null $jqGridWrapper = null)

No description

from JQGridManagerTrait
__construct(GiftCardRepository $repository, GiftCardEventContainer $container)

No description

GiftCard
getGiftCard(int $id)

Get GiftCart and its user form database by id

GiftCard
editGiftCard(GiftCard $card)

Merge GiftCard entity

bool
deleteGiftCards(array $ids)

Delete multiple GiftCards

array
getGiftCardsPagination(int $page = 1, int $offset = 10)

Get multiple gift cards for specified user

int|string
getCountForPagination()

Get total number of gift cards for user

User
getCurrentUser()

Get current user

GiftCardSettings
getGiftCardSettings()

Get current GiftCardSettings

float|int
getCurrencyRatioForFrontend(GiftCardSettings $settings)

Get currency ratio for settings currency and EUR

string|bool
payPalStart(float|int $amount)

Start PayPal payment process Process starts by converting amount fro settings currency to EUR After conversion it checks if min and max values are valid if amount is valid new payment token is generated

GiftCard|bool
payPalSuccess(mixed $request)

If payment is successful save new gift cart

bool
sendCodeByMail(string $to, string $subject, string $content, int $id)

Send gift card code by mail

array
applyGiftCard(string $code)

Apply gift card to order Discount is applied using Order Adjustment

array
removeGiftCard()

Remove Gift card from order

Details

in JQGridManagerTrait at line 26
mixed searchForJQGRID(array $searchParams, array $sortParams = array(), array $additionalParams = array(), JQGridWrapper $jqGridWrapper = null)

Parameters

array $searchParams
array $sortParams
array $additionalParams
JQGridWrapper $jqGridWrapper

Return Value

mixed

in JQGridManagerTrait at line 40
mixed findAllForJQGRID(int $page, int $offset, array $sortParams, array $additionalParams = array(), JQGridWrapper $jqGridWrapper = null)

Parameters

int $page
int $offset
array $sortParams
array $additionalParams
JQGridWrapper $jqGridWrapper

Return Value

mixed

in JQGridManagerTrait at line 53
mixed getCountForJQGRID(array|null $searchParams = null, array|null $sortParams = null, array|null $additionalParams = array(), JQGridWrapper|null $jqGridWrapper = null)

Parameters

array|null $searchParams
array|null $sortParams
array|null $additionalParams
JQGridWrapper|null $jqGridWrapper

Return Value

mixed

at line 55
__construct(GiftCardRepository $repository, GiftCardEventContainer $container)

Parameters

GiftCardRepository $repository
GiftCardEventContainer $container

at line 71
GiftCard getGiftCard(int $id)

Get GiftCart and its user form database by id

Parameters

int $id

Return Value

GiftCard

Exceptions

NoResultException
NonUniqueResultException

at line 85
GiftCard editGiftCard(GiftCard $card)

Merge GiftCard entity

Parameters

GiftCard $card

Return Value

GiftCard

Exceptions

ORMException

at line 103
bool deleteGiftCards(array $ids)

Delete multiple GiftCards

Parameters

array $ids
  • Delete every gift card whose id is in this array

Return Value

bool FALSE on error, TRUE otherwise

at line 116
array getGiftCardsPagination(int $page = 1, int $offset = 10)

Get multiple gift cards for specified user

Parameters

int $page
  • page of data
int $offset
  • number of items

Return Value

array

at line 128
int|string getCountForPagination()

Get total number of gift cards for user

Return Value

int|string

Exceptions

NonUniqueResultException

at line 137
User getCurrentUser()

Get current user

Return Value

User

at line 146
GiftCardSettings getGiftCardSettings()

Get current GiftCardSettings

Return Value

GiftCardSettings

at line 157
float|int getCurrencyRatioForFrontend(GiftCardSettings $settings)

Get currency ratio for settings currency and EUR

Parameters

GiftCardSettings $settings

Return Value

float|int

at line 178
string|bool payPalStart(float|int $amount)

Start PayPal payment process Process starts by converting amount fro settings currency to EUR After conversion it checks if min and max values are valid if amount is valid new payment token is generated

Parameters

float|int $amount

Return Value

string|bool

at line 252
GiftCard|bool payPalSuccess(mixed $request)

If payment is successful save new gift cart

Parameters

mixed $request

Return Value

GiftCard|bool if payment is successful GiftCart, otherwise false

Exceptions

Exception

at line 291
bool sendCodeByMail(string $to, string $subject, string $content, int $id)

Send gift card code by mail

Parameters

string $to
string $subject
string $content
int $id

Return Value

bool FALSE on error, TRUE otherwise

Exceptions

NoResultException
NonUniqueResultException

at line 315
array applyGiftCard(string $code)

Apply gift card to order Discount is applied using Order Adjustment

Parameters

string $code

Return Value

array

Exceptions

NonUniqueResultException

See also

Adjustment

at line 373
array removeGiftCard()

Remove Gift card from order

Return Value

array

Exceptions

NonUniqueResultException