Skip to content

Latest commit

 

History

History
77 lines (69 loc) · 12.6 KB

rules-reference.md

File metadata and controls

77 lines (69 loc) · 12.6 KB

Rules Reference

List of all rule classes across Shopware 6.

Checkout

Class Description
Shopware\Core\Checkout\Cart\Rule\AlwaysValidRule Matches always
Shopware\Core\Checkout\Cart\Rule\CartAmountRule Matches a specific number to the carts total price.
Shopware\Core\Checkout\Cart\Rule\CartHasDeliveryFreeItemRule Matches if the cart has a free delivery item.
Shopware\Core\Checkout\Cart\Rule\CartWeightRule Matches a specific number to the current cart's total weight.
Shopware\Core\Checkout\Cart\Rule\GoodsCountRule Matches a number to the current cart's line item goods count.
Shopware\Core\Checkout\Cart\Rule\GoodsPriceRule Matches a specific number to the carts goods price.
Shopware\Core\Checkout\Cart\Rule\LineItemClearanceSaleRule Matches a specific line item which is on clearance sale
Shopware\Core\Checkout\Cart\Rule\LineItemCreationDateRule Matches if a line item has a specific creation date.
Shopware\Core\Checkout\Cart\Rule\LineItemCustomFieldRule Matches if a line item has a specific custom field.
Shopware\Core\Checkout\Cart\Rule\LineItemDimensionHeightRule Matches a specific line item's height.
Shopware\Core\Checkout\Cart\Rule\LineItemDimensionLengthRule Matches a specific line item's length.
Shopware\Core\Checkout\Cart\Rule\LineItemDimensionWeightRule Matches a specific line item's weight.
Shopware\Core\Checkout\Cart\Rule\LineItemDimensionWidthRule Matches a specific line item's width.
Shopware\Core\Checkout\Cart\Rule\LineItemGroupRule Matches if a line item has a specific group.
Shopware\Core\Checkout\Cart\Rule\LineItemInCategoryRule Matches if a line item is in a specific category.
Shopware\Core\Checkout\Cart\Rule\LineItemIsNewRule Matches if a line item is marked as new.
Shopware\Core\Checkout\Cart\Rule\LineItemListPriceRule Matches a specific line item has a specific list price.
Shopware\Core\Checkout\Cart\Rule\LineItemOfManufacturerRule Matches a specific line item has a specific manufacturer.
Shopware\Core\Checkout\Cart\Rule\LineItemOfTypeRule Matches a specific type name to the line item's type.
Shopware\Core\Checkout\Cart\Rule\LineItemPromotedRule Matches if a line item is promoted.
Shopware\Core\Checkout\Cart\Rule\LineItemPropertyRule Matches if a line item has a specific property.
Shopware\Core\Checkout\Cart\Rule\LineItemPurchasePriceRule Matches if a line item has a specific purchase price.
Shopware\Core\Checkout\Cart\Rule\LineItemReleaseDateRule Matches a specific line item's release date.
Shopware\Core\Checkout\Cart\Rule\LineItemRule Matches multiple identifiers to a line item's keys. True if one identifier matches.
Shopware\Core\Checkout\Cart\Rule\LineItemTagRule Matches multiple tags to a line item's tag. True if one tag matches.
Shopware\Core\Checkout\Cart\Rule\LineItemTaxationRule Matches if a line item has a specific tax.
Shopware\Core\Checkout\Cart\Rule\LineItemTotalPriceRule Matches a number to the current cart's line item total price.
Shopware\Core\Checkout\Cart\Rule\LineItemUnitPriceRule Matches a specific number to a line item's price.
Shopware\Core\Checkout\Cart\Rule\LineItemWithQuantityRule Matches a specific line item's quantity to the current line item's quantity.
Shopware\Core\Checkout\Cart\Rule\LineItemWrapperRule Internally handled scope changes.
Shopware\Core\Checkout\Cart\Rule\LineItemsInCartCountRule Matches a number to the current cart's line item count.
Shopware\Core\Checkout\Cart\Rule\LineItemsInCartRule Matches multiple identifiers to a carts line item's identifier. True if one identifier matches.
Shopware\Core\Checkout\Cart\Rule\PaymentMethodRule Matches if a specific payment method is used
Shopware\Core\Checkout\Cart\Rule\ShippingMethodRule Matches if a specific shipping method is used
Shopware\Core\Checkout\Customer\Rule\BillingCountryRule Matches multiple countries to the customer's active billing address country.
Shopware\Core\Checkout\Customer\Rule\BillingStreetRule Matches multiple street names to the customer's active billing address street name.
Shopware\Core\Checkout\Customer\Rule\BillingZipCodeRule Matches multiple zip codes to the customer's active billing address zip code.
Shopware\Core\Checkout\Customer\Rule\CustomerGroupRule Matches multiple customer groups to the current customers group. True if one customer group matches.
Shopware\Core\Checkout\Customer\Rule\CustomerNumberRule Matches multiple numbers to the active customers number.
Shopware\Core\Checkout\Customer\Rule\CustomerTagRule Matches a tag set to customers
Shopware\Core\Checkout\Customer\Rule\DaysSinceLastOrderRule Matches a specific number of days to the last order creation date.
Shopware\Core\Checkout\Customer\Rule\DifferentAddressesRule Matches if active billing address is not the default.
Shopware\Core\Checkout\Customer\Rule\IsCompanyRule Matches if the customer is a company
Shopware\Core\Checkout\Customer\Rule\IsNewCustomerRule Matches if a customer is new, by matching the firstLogin property with today.
Shopware\Core\Checkout\Customer\Rule\LastNameRule Exactly matches a string to the customer's last name.
Shopware\Core\Checkout\Customer\Rule\OrderCountRule Matches a specific number to the number of orders of the current customer.
Shopware\Core\Checkout\Customer\Rule\ShippingCountryRule Matches multiple countries to the customer's active shipping address country. True if one country matches.
Shopware\Core\Checkout\Customer\Rule\ShippingStreetRule Matches multiple street names to the customer's active shipping address street name. True if one street name matches.
Shopware\Core\Checkout\Customer\Rule\ShippingZipCodeRule Matches multiple zip codes to the customer's active shipping address zip code. True if one zip code matches.

Framework

Class Description
Shopware\Core\Framework\Rule\Container\AndRule Composition of rules. Matches if all match.
Shopware\Core\Framework\Rule\Container\NotRule Negates one rule.
Shopware\Core\Framework\Rule\Container\OrRule Composition of rules. Matches if at least one rule matches.
Shopware\Core\Framework\Rule\Container\XorRule Composition of rules. Matches if exactly one matches.
Shopware\Core\Framework\Rule\DateRangeRule Match a fixed date range to now.
Shopware\Core\Framework\Rule\SalesChannelRule Match a specific sales channel to the current context.
Shopware\Core\Framework\Rule\TimeRangeRule Matches a fixed time range to now.
Shopware\Core\Framework\Rule\WeekdayRule Matches a fixed day of the week to now.

System

Class Description
Shopware\Core\System\Currency\Rule\CurrencyRule Match a specific currency to the current context.