Code Queries

// Fetch codes created this month
$firstDayOfMonth = new \DateTime('first day of this month');

$codes = \verbb\giftvoucher\elements\Code::find()
    ->after($firstDayOfMonth)
    ->all();

// Fetch codes as arrays
$codes = \verbb\giftvoucher\elements\Code::find()
    ->asArray()
    ->all();

// Fetch codes created before this month
$firstDayOfMonth = new \DateTime('first day of this month');

$codes = \verbb\giftvoucher\elements\Code::find()
    ->before($firstDayOfMonth)
    ->all();

// Fetch the code a customer entered
$enteredCode = \Craft::$app->getRequest()->getParam('voucherCode');

$code = \verbb\giftvoucher\elements\Code::find()
    ->codeKey($enteredCode)
    ->one();

// Fetch codes created last month
$start = (new \DateTime('first day of last month'))->format(\DateTime::ATOM);
$end = (new \DateTime('first day of this month'))->format(\DateTime::ATOM);

$codes = \verbb\giftvoucher\elements\Code::find()
    ->dateCreated(['and', ">= {$start}", "< {$end}"])
    ->all();

// Fetch codes updated in the last week
$lastWeek = (new \DateTime('1 week ago'))->format(\DateTime::ATOM);

$codes = \verbb\giftvoucher\elements\Code::find()
    ->dateUpdated(">= {$lastWeek}")
    ->all();

// Fetch codes expiring this month
$nextMonth = (new \DateTime('first day of next month'))->format(\DateTime::ATOM);

$codes = \verbb\giftvoucher\elements\Code::find()
    ->expiryDate("< {$nextMonth}")
    ->all();

// Fetch codes in a specific order
$codes = \verbb\giftvoucher\elements\Code::find()
    ->id([1, 2, 3, 4, 5])
    ->fixedOrder()
    ->all();

// Fetch the code by its ID
$code = \verbb\giftvoucher\elements\Code::find()
    ->id(1)
    ->one();

// Fetch codes in reverse
$codes = \verbb\giftvoucher\elements\Code::find()
    ->inReverse()
    ->all();

// Fetch up to 10 codes
$codes = \verbb\giftvoucher\elements\Code::find()
    ->limit(10)
    ->all();

// Fetch codes for a line item
$codes = \verbb\giftvoucher\elements\Code::find()
    ->lineItemId($lineItem->id)
    ->all();

// Fetch all codes except for the first 3
$codes = \verbb\giftvoucher\elements\Code::find()
    ->offset(3)
    ->all();

// Fetch all codes in order of date created
$codes = \verbb\giftvoucher\elements\Code::find()
    ->orderBy('elements.dateCreated asc')
    ->all();

// Fetch codes for an order
$codes = \verbb\giftvoucher\elements\Code::find()
    ->orderId($order->id)
    ->all();

// Fetch all codes that are related to myCategory
$codes = \verbb\giftvoucher\elements\Code::find()
    ->relatedTo($myCategory)
    ->all();

// Fetch all codes that match the search query
$searchQuery = \Craft::$app->getRequest()->getQueryParam('q');

$codes = \verbb\giftvoucher\elements\Code::find()
    ->search($searchQuery)
    ->all();

// Fetch disabled codes
$codes = \verbb\giftvoucher\elements\Code::find()
    ->status('disabled')
    ->all();

// Fetch codes for vouchers with a Gift Cards voucher type
$codes = \verbb\giftvoucher\elements\Code::find()
    ->type('giftCards')
    ->all();

// Fetch codes for the voucher type with an ID of 1
$codes = \verbb\giftvoucher\elements\Code::find()
    ->typeId(1)
    ->all();

// Fetch the code by its UID
$code = \verbb\giftvoucher\elements\Code::find()
    ->uid('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')
    ->one();

// Fetch codes for the voucher with a SKU of GIFT-50
$codes = \verbb\giftvoucher\elements\Code::find()
    ->voucher('GIFT-50')
    ->all();

// Fetch codes for the voucher with an ID of 1
$codes = \verbb\giftvoucher\elements\Code::find()
    ->voucherId(1)
    ->all();

// Fetch codes eager-loaded with the “Related” field’s relations
$codes = \verbb\giftvoucher\elements\Code::find()
    ->with(['related'])
    ->all();