diff --git a/docs/.artifacts/cms/5.x/console-commands.md b/docs/.artifacts/cms/5.x/console-commands.md index 937623806..046ededb3 100644 --- a/docs/.artifacts/cms/5.x/console-commands.md +++ b/docs/.artifacts/cms/5.x/console-commands.md @@ -1396,6 +1396,206 @@ $ php craft on The system is now online. ``` +## `pc` + +Alias of project-config. + +
pc/apply
+pc/diff
+pc/export
+pc/get
+pc/rebuild
+pc/remove
+pc/set
+pc/touch
+pc/write
+resave/all
+users/remove-2fa
+users/set-password
diff --git a/docs/.artifacts/cms/5.x/events.json b/docs/.artifacts/cms/5.x/events.json
index a5e9dd967..9e38aae8f 100644
--- a/docs/.artifacts/cms/5.x/events.json
+++ b/docs/.artifacts/cms/5.x/events.json
@@ -1064,6 +1064,92 @@
}
}
},
+ {
+ "class": "craft\\base\\Element",
+ "name": "EVENT_REGISTER_CARD_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementCardAttributesEvent",
+ "desc": "The event that is triggered when registering the card attributes for the element type.",
+ "filters": {
+ "duplicating": {
+ "label": "Element is being duplicated to a new element",
+ "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
+ "excludes": [
+ "isNew",
+ "resaving",
+ "revision"
+ ]
+ },
+ "enabled": {
+ "label": "Element is enabled",
+ "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
+ },
+ "firstSave": {
+ "label": "Element is being saved for the first time",
+ "conditionsPhp": "$event->sender->firstSave",
+ "excludes": [
+ "isNew",
+ "draft",
+ "provisional",
+ "revision",
+ "resaving"
+ ]
+ },
+ "propagating": {
+ "label": "Element is being propagated",
+ "conditionsPhp": "$event->sender->propagating"
+ },
+ "resaving": {
+ "label": "Element is being bulk-resaved",
+ "conditionsPhp": "$event->sender->resaving",
+ "excludes": [
+ "firstSave"
+ ]
+ }
+ }
+ },
+ {
+ "class": "craft\\base\\Element",
+ "name": "EVENT_REGISTER_DEFAULT_CARD_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementCardAttributesEvent",
+ "desc": "The event that is triggered when registering the card attributes for the element type.",
+ "filters": {
+ "duplicating": {
+ "label": "Element is being duplicated to a new element",
+ "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
+ "excludes": [
+ "isNew",
+ "resaving",
+ "revision"
+ ]
+ },
+ "enabled": {
+ "label": "Element is enabled",
+ "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
+ },
+ "firstSave": {
+ "label": "Element is being saved for the first time",
+ "conditionsPhp": "$event->sender->firstSave",
+ "excludes": [
+ "isNew",
+ "draft",
+ "provisional",
+ "revision",
+ "resaving"
+ ]
+ },
+ "propagating": {
+ "label": "Element is being propagated",
+ "conditionsPhp": "$event->sender->propagating"
+ },
+ "resaving": {
+ "label": "Element is being bulk-resaved",
+ "conditionsPhp": "$event->sender->resaving",
+ "excludes": [
+ "firstSave"
+ ]
+ }
+ }
+ },
{
"class": "craft\\base\\Element",
"name": "EVENT_DEFINE_EAGER_LOADING_MAP",
@@ -4326,6 +4412,24 @@
"type": "yii\\base\\ActionEvent",
"desc": "an event raised right after executing a controller action."
},
+ {
+ "class": "craft\\console\\controllers\\PcController",
+ "name": "EVENT_DEFINE_ACTIONS",
+ "type": "craft\\events\\DefineConsoleActionsEvent",
+ "desc": "The event that is triggered when defining custom actions for this controller."
+ },
+ {
+ "class": "craft\\console\\controllers\\PcController",
+ "name": "EVENT_BEFORE_ACTION",
+ "type": "yii\\base\\ActionEvent",
+ "desc": "an event raised right before executing a controller action. You may set `ActionEvent::isValid` to be false to cancel the action execution."
+ },
+ {
+ "class": "craft\\console\\controllers\\PcController",
+ "name": "EVENT_AFTER_ACTION",
+ "type": "yii\\base\\ActionEvent",
+ "desc": "an event raised right after executing a controller action."
+ },
{
"class": "craft\\console\\controllers\\PluginController",
"name": "EVENT_DEFINE_ACTIONS",
@@ -6231,6 +6335,92 @@
}
}
},
+ {
+ "class": "craft\\elements\\Address",
+ "name": "EVENT_REGISTER_CARD_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementCardAttributesEvent",
+ "desc": "The event that is triggered when registering the card attributes for the element type.",
+ "filters": {
+ "duplicating": {
+ "label": "Element is being duplicated to a new element",
+ "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
+ "excludes": [
+ "isNew",
+ "resaving",
+ "revision"
+ ]
+ },
+ "enabled": {
+ "label": "Element is enabled",
+ "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
+ },
+ "firstSave": {
+ "label": "Element is being saved for the first time",
+ "conditionsPhp": "$event->sender->firstSave",
+ "excludes": [
+ "isNew",
+ "draft",
+ "provisional",
+ "revision",
+ "resaving"
+ ]
+ },
+ "propagating": {
+ "label": "Element is being propagated",
+ "conditionsPhp": "$event->sender->propagating"
+ },
+ "resaving": {
+ "label": "Element is being bulk-resaved",
+ "conditionsPhp": "$event->sender->resaving",
+ "excludes": [
+ "firstSave"
+ ]
+ }
+ }
+ },
+ {
+ "class": "craft\\elements\\Address",
+ "name": "EVENT_REGISTER_DEFAULT_CARD_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementCardAttributesEvent",
+ "desc": "The event that is triggered when registering the card attributes for the element type.",
+ "filters": {
+ "duplicating": {
+ "label": "Element is being duplicated to a new element",
+ "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
+ "excludes": [
+ "isNew",
+ "resaving",
+ "revision"
+ ]
+ },
+ "enabled": {
+ "label": "Element is enabled",
+ "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
+ },
+ "firstSave": {
+ "label": "Element is being saved for the first time",
+ "conditionsPhp": "$event->sender->firstSave",
+ "excludes": [
+ "isNew",
+ "draft",
+ "provisional",
+ "revision",
+ "resaving"
+ ]
+ },
+ "propagating": {
+ "label": "Element is being propagated",
+ "conditionsPhp": "$event->sender->propagating"
+ },
+ "resaving": {
+ "label": "Element is being bulk-resaved",
+ "conditionsPhp": "$event->sender->resaving",
+ "excludes": [
+ "firstSave"
+ ]
+ }
+ }
+ },
{
"class": "craft\\elements\\Address",
"name": "EVENT_DEFINE_EAGER_LOADING_MAP",
@@ -8477,9 +8667,9 @@
},
{
"class": "craft\\elements\\Asset",
- "name": "EVENT_DEFINE_EAGER_LOADING_MAP",
- "type": "craft\\events\\DefineEagerLoadingMapEvent",
- "desc": "The event that is triggered when defining an eager-loading map.",
+ "name": "EVENT_REGISTER_CARD_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementCardAttributesEvent",
+ "desc": "The event that is triggered when registering the card attributes for the element type.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -8520,9 +8710,9 @@
},
{
"class": "craft\\elements\\Asset",
- "name": "EVENT_SET_EAGER_LOADED_ELEMENTS",
- "type": "craft\\events\\SetEagerLoadedElementsEvent",
- "desc": "The event that is triggered when setting eager-loaded elements.",
+ "name": "EVENT_REGISTER_DEFAULT_CARD_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementCardAttributesEvent",
+ "desc": "The event that is triggered when registering the card attributes for the element type.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -8563,9 +8753,9 @@
},
{
"class": "craft\\elements\\Asset",
- "name": "EVENT_REGISTER_PREVIEW_TARGETS",
- "type": "craft\\events\\RegisterPreviewTargetsEvent",
- "desc": "The event that is triggered when registering the element’s preview targets.",
+ "name": "EVENT_DEFINE_EAGER_LOADING_MAP",
+ "type": "craft\\events\\DefineEagerLoadingMapEvent",
+ "desc": "The event that is triggered when defining an eager-loading map.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -8606,9 +8796,9 @@
},
{
"class": "craft\\elements\\Asset",
- "name": "EVENT_DEFINE_ATTRIBUTE_HTML",
- "type": "craft\\events\\DefineAttributeHtmlEvent",
- "desc": "The event that is triggered when defining an attribute’s HTML for table and card views.",
+ "name": "EVENT_SET_EAGER_LOADED_ELEMENTS",
+ "type": "craft\\events\\SetEagerLoadedElementsEvent",
+ "desc": "The event that is triggered when setting eager-loaded elements.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -8649,9 +8839,9 @@
},
{
"class": "craft\\elements\\Asset",
- "name": "EVENT_DEFINE_INLINE_ATTRIBUTE_INPUT_HTML",
- "type": "craft\\events\\DefineAttributeHtmlEvent",
- "desc": "The event that is triggered when defining an attribute’s inline input HTML.",
+ "name": "EVENT_REGISTER_PREVIEW_TARGETS",
+ "type": "craft\\events\\RegisterPreviewTargetsEvent",
+ "desc": "The event that is triggered when registering the element’s preview targets.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -8692,9 +8882,9 @@
},
{
"class": "craft\\elements\\Asset",
- "name": "EVENT_REGISTER_HTML_ATTRIBUTES",
- "type": "craft\\events\\RegisterElementHtmlAttributesEvent",
- "desc": "The event that is triggered when registering the HTML attributes that should be included in the element’s DOM representation in the control panel.",
+ "name": "EVENT_DEFINE_ATTRIBUTE_HTML",
+ "type": "craft\\events\\DefineAttributeHtmlEvent",
+ "desc": "The event that is triggered when defining an attribute’s HTML for table and card views.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -8735,9 +8925,9 @@
},
{
"class": "craft\\elements\\Asset",
- "name": "EVENT_DEFINE_ADDITIONAL_BUTTONS",
- "type": "craft\\events\\DefineHtmlEvent",
- "desc": "The event that is triggered when defining additional buttons that should be shown at the top of the element’s edit page.",
+ "name": "EVENT_DEFINE_INLINE_ATTRIBUTE_INPUT_HTML",
+ "type": "craft\\events\\DefineAttributeHtmlEvent",
+ "desc": "The event that is triggered when defining an attribute’s inline input HTML.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -8778,9 +8968,9 @@
},
{
"class": "craft\\elements\\Asset",
- "name": "EVENT_DEFINE_ACTION_MENU_ITEMS",
- "type": "craft\\events\\DefineMenuItemsEvent",
- "desc": "The event that is triggered when defining action menu items..",
+ "name": "EVENT_REGISTER_HTML_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementHtmlAttributesEvent",
+ "desc": "The event that is triggered when registering the HTML attributes that should be included in the element’s DOM representation in the control panel.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -8821,9 +9011,9 @@
},
{
"class": "craft\\elements\\Asset",
- "name": "EVENT_DEFINE_SIDEBAR_HTML",
+ "name": "EVENT_DEFINE_ADDITIONAL_BUTTONS",
"type": "craft\\events\\DefineHtmlEvent",
- "desc": "The event that is triggered when defining the HTML for the editor sidebar.",
+ "desc": "The event that is triggered when defining additional buttons that should be shown at the top of the element’s edit page.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -8864,9 +9054,9 @@
},
{
"class": "craft\\elements\\Asset",
- "name": "EVENT_DEFINE_META_FIELDS_HTML",
- "type": "craft\\events\\DefineHtmlEvent",
- "desc": "The event that is triggered when defining the HTML for meta fields within the editor sidebar.",
+ "name": "EVENT_DEFINE_ACTION_MENU_ITEMS",
+ "type": "craft\\events\\DefineMenuItemsEvent",
+ "desc": "The event that is triggered when defining action menu items..",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -8907,9 +9097,9 @@
},
{
"class": "craft\\elements\\Asset",
- "name": "EVENT_DEFINE_METADATA",
- "type": "craft\\events\\DefineMetadataEvent",
- "desc": "The event that is triggered when defining the element’s metadata info.",
+ "name": "EVENT_DEFINE_SIDEBAR_HTML",
+ "type": "craft\\events\\DefineHtmlEvent",
+ "desc": "The event that is triggered when defining the HTML for the editor sidebar.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -8950,9 +9140,9 @@
},
{
"class": "craft\\elements\\Asset",
- "name": "EVENT_AUTHORIZE_VIEW",
- "type": "craft\\events\\AuthorizationCheckEvent",
- "desc": "The event that is triggered when determining whether a user is authorized to view the element’s edit page.",
+ "name": "EVENT_DEFINE_META_FIELDS_HTML",
+ "type": "craft\\events\\DefineHtmlEvent",
+ "desc": "The event that is triggered when defining the HTML for meta fields within the editor sidebar.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -8993,9 +9183,9 @@
},
{
"class": "craft\\elements\\Asset",
- "name": "EVENT_AUTHORIZE_SAVE",
- "type": "craft\\events\\AuthorizationCheckEvent",
- "desc": "The event that is triggered when determining whether a user is authorized to save the element in its current state.",
+ "name": "EVENT_DEFINE_METADATA",
+ "type": "craft\\events\\DefineMetadataEvent",
+ "desc": "The event that is triggered when defining the element’s metadata info.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -9036,9 +9226,9 @@
},
{
"class": "craft\\elements\\Asset",
- "name": "EVENT_AUTHORIZE_CREATE_DRAFTS",
+ "name": "EVENT_AUTHORIZE_VIEW",
"type": "craft\\events\\AuthorizationCheckEvent",
- "desc": "The event that is triggered when determining whether a user is authorized to create drafts for the element.",
+ "desc": "The event that is triggered when determining whether a user is authorized to view the element’s edit page.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -9079,9 +9269,9 @@
},
{
"class": "craft\\elements\\Asset",
- "name": "EVENT_AUTHORIZE_DUPLICATE",
+ "name": "EVENT_AUTHORIZE_SAVE",
"type": "craft\\events\\AuthorizationCheckEvent",
- "desc": "The event that is triggered when determining whether a user is authorized to duplicate the element.",
+ "desc": "The event that is triggered when determining whether a user is authorized to save the element in its current state.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -9122,9 +9312,95 @@
},
{
"class": "craft\\elements\\Asset",
- "name": "EVENT_AUTHORIZE_DELETE",
+ "name": "EVENT_AUTHORIZE_CREATE_DRAFTS",
"type": "craft\\events\\AuthorizationCheckEvent",
- "desc": "The event that is triggered when determining whether a user is authorized to delete the element.",
+ "desc": "The event that is triggered when determining whether a user is authorized to create drafts for the element.",
+ "filters": {
+ "duplicating": {
+ "label": "Element is being duplicated to a new element",
+ "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
+ "excludes": [
+ "isNew",
+ "resaving",
+ "revision"
+ ]
+ },
+ "enabled": {
+ "label": "Element is enabled",
+ "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
+ },
+ "firstSave": {
+ "label": "Element is being saved for the first time",
+ "conditionsPhp": "$event->sender->firstSave",
+ "excludes": [
+ "isNew",
+ "draft",
+ "provisional",
+ "revision",
+ "resaving"
+ ]
+ },
+ "propagating": {
+ "label": "Element is being propagated",
+ "conditionsPhp": "$event->sender->propagating"
+ },
+ "resaving": {
+ "label": "Element is being bulk-resaved",
+ "conditionsPhp": "$event->sender->resaving",
+ "excludes": [
+ "firstSave"
+ ]
+ }
+ }
+ },
+ {
+ "class": "craft\\elements\\Asset",
+ "name": "EVENT_AUTHORIZE_DUPLICATE",
+ "type": "craft\\events\\AuthorizationCheckEvent",
+ "desc": "The event that is triggered when determining whether a user is authorized to duplicate the element.",
+ "filters": {
+ "duplicating": {
+ "label": "Element is being duplicated to a new element",
+ "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
+ "excludes": [
+ "isNew",
+ "resaving",
+ "revision"
+ ]
+ },
+ "enabled": {
+ "label": "Element is enabled",
+ "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
+ },
+ "firstSave": {
+ "label": "Element is being saved for the first time",
+ "conditionsPhp": "$event->sender->firstSave",
+ "excludes": [
+ "isNew",
+ "draft",
+ "provisional",
+ "revision",
+ "resaving"
+ ]
+ },
+ "propagating": {
+ "label": "Element is being propagated",
+ "conditionsPhp": "$event->sender->propagating"
+ },
+ "resaving": {
+ "label": "Element is being bulk-resaved",
+ "conditionsPhp": "$event->sender->resaving",
+ "excludes": [
+ "firstSave"
+ ]
+ }
+ }
+ },
+ {
+ "class": "craft\\elements\\Asset",
+ "name": "EVENT_AUTHORIZE_DELETE",
+ "type": "craft\\events\\AuthorizationCheckEvent",
+ "desc": "The event that is triggered when determining whether a user is authorized to delete the element.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -10418,6 +10694,92 @@
}
}
},
+ {
+ "class": "craft\\elements\\Category",
+ "name": "EVENT_REGISTER_CARD_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementCardAttributesEvent",
+ "desc": "The event that is triggered when registering the card attributes for the element type.",
+ "filters": {
+ "duplicating": {
+ "label": "Element is being duplicated to a new element",
+ "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
+ "excludes": [
+ "isNew",
+ "resaving",
+ "revision"
+ ]
+ },
+ "enabled": {
+ "label": "Element is enabled",
+ "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
+ },
+ "firstSave": {
+ "label": "Element is being saved for the first time",
+ "conditionsPhp": "$event->sender->firstSave",
+ "excludes": [
+ "isNew",
+ "draft",
+ "provisional",
+ "revision",
+ "resaving"
+ ]
+ },
+ "propagating": {
+ "label": "Element is being propagated",
+ "conditionsPhp": "$event->sender->propagating"
+ },
+ "resaving": {
+ "label": "Element is being bulk-resaved",
+ "conditionsPhp": "$event->sender->resaving",
+ "excludes": [
+ "firstSave"
+ ]
+ }
+ }
+ },
+ {
+ "class": "craft\\elements\\Category",
+ "name": "EVENT_REGISTER_DEFAULT_CARD_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementCardAttributesEvent",
+ "desc": "The event that is triggered when registering the card attributes for the element type.",
+ "filters": {
+ "duplicating": {
+ "label": "Element is being duplicated to a new element",
+ "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
+ "excludes": [
+ "isNew",
+ "resaving",
+ "revision"
+ ]
+ },
+ "enabled": {
+ "label": "Element is enabled",
+ "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
+ },
+ "firstSave": {
+ "label": "Element is being saved for the first time",
+ "conditionsPhp": "$event->sender->firstSave",
+ "excludes": [
+ "isNew",
+ "draft",
+ "provisional",
+ "revision",
+ "resaving"
+ ]
+ },
+ "propagating": {
+ "label": "Element is being propagated",
+ "conditionsPhp": "$event->sender->propagating"
+ },
+ "resaving": {
+ "label": "Element is being bulk-resaved",
+ "conditionsPhp": "$event->sender->resaving",
+ "excludes": [
+ "firstSave"
+ ]
+ }
+ }
+ },
{
"class": "craft\\elements\\Category",
"name": "EVENT_DEFINE_EAGER_LOADING_MAP",
@@ -12920,9 +13282,9 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_DEFINE_EAGER_LOADING_MAP",
- "type": "craft\\events\\DefineEagerLoadingMapEvent",
- "desc": "The event that is triggered when defining an eager-loading map.",
+ "name": "EVENT_REGISTER_CARD_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementCardAttributesEvent",
+ "desc": "The event that is triggered when registering the card attributes for the element type.",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -12998,9 +13360,9 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_SET_EAGER_LOADED_ELEMENTS",
- "type": "craft\\events\\SetEagerLoadedElementsEvent",
- "desc": "The event that is triggered when setting eager-loaded elements.",
+ "name": "EVENT_REGISTER_DEFAULT_CARD_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementCardAttributesEvent",
+ "desc": "The event that is triggered when registering the card attributes for the element type.",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -13076,9 +13438,9 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_REGISTER_PREVIEW_TARGETS",
- "type": "craft\\events\\RegisterPreviewTargetsEvent",
- "desc": "The event that is triggered when registering the element’s preview targets.",
+ "name": "EVENT_DEFINE_EAGER_LOADING_MAP",
+ "type": "craft\\events\\DefineEagerLoadingMapEvent",
+ "desc": "The event that is triggered when defining an eager-loading map.",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -13154,9 +13516,9 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_DEFINE_ATTRIBUTE_HTML",
- "type": "craft\\events\\DefineAttributeHtmlEvent",
- "desc": "The event that is triggered when defining an attribute’s HTML for table and card views.",
+ "name": "EVENT_SET_EAGER_LOADED_ELEMENTS",
+ "type": "craft\\events\\SetEagerLoadedElementsEvent",
+ "desc": "The event that is triggered when setting eager-loaded elements.",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -13232,9 +13594,9 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_DEFINE_INLINE_ATTRIBUTE_INPUT_HTML",
- "type": "craft\\events\\DefineAttributeHtmlEvent",
- "desc": "The event that is triggered when defining an attribute’s inline input HTML.",
+ "name": "EVENT_REGISTER_PREVIEW_TARGETS",
+ "type": "craft\\events\\RegisterPreviewTargetsEvent",
+ "desc": "The event that is triggered when registering the element’s preview targets.",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -13310,9 +13672,9 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_REGISTER_HTML_ATTRIBUTES",
- "type": "craft\\events\\RegisterElementHtmlAttributesEvent",
- "desc": "The event that is triggered when registering the HTML attributes that should be included in the element’s DOM representation in the control panel.",
+ "name": "EVENT_DEFINE_ATTRIBUTE_HTML",
+ "type": "craft\\events\\DefineAttributeHtmlEvent",
+ "desc": "The event that is triggered when defining an attribute’s HTML for table and card views.",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -13388,9 +13750,9 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_DEFINE_ADDITIONAL_BUTTONS",
- "type": "craft\\events\\DefineHtmlEvent",
- "desc": "The event that is triggered when defining additional buttons that should be shown at the top of the element’s edit page.",
+ "name": "EVENT_DEFINE_INLINE_ATTRIBUTE_INPUT_HTML",
+ "type": "craft\\events\\DefineAttributeHtmlEvent",
+ "desc": "The event that is triggered when defining an attribute’s inline input HTML.",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -13466,9 +13828,9 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_DEFINE_ACTION_MENU_ITEMS",
- "type": "craft\\events\\DefineMenuItemsEvent",
- "desc": "The event that is triggered when defining action menu items..",
+ "name": "EVENT_REGISTER_HTML_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementHtmlAttributesEvent",
+ "desc": "The event that is triggered when registering the HTML attributes that should be included in the element’s DOM representation in the control panel.",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -13544,9 +13906,9 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_DEFINE_SIDEBAR_HTML",
+ "name": "EVENT_DEFINE_ADDITIONAL_BUTTONS",
"type": "craft\\events\\DefineHtmlEvent",
- "desc": "The event that is triggered when defining the HTML for the editor sidebar.",
+ "desc": "The event that is triggered when defining additional buttons that should be shown at the top of the element’s edit page.",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -13622,9 +13984,9 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_DEFINE_META_FIELDS_HTML",
- "type": "craft\\events\\DefineHtmlEvent",
- "desc": "The event that is triggered when defining the HTML for meta fields within the editor sidebar.",
+ "name": "EVENT_DEFINE_ACTION_MENU_ITEMS",
+ "type": "craft\\events\\DefineMenuItemsEvent",
+ "desc": "The event that is triggered when defining action menu items..",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -13700,9 +14062,9 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_DEFINE_METADATA",
- "type": "craft\\events\\DefineMetadataEvent",
- "desc": "The event that is triggered when defining the element’s metadata info.",
+ "name": "EVENT_DEFINE_SIDEBAR_HTML",
+ "type": "craft\\events\\DefineHtmlEvent",
+ "desc": "The event that is triggered when defining the HTML for the editor sidebar.",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -13778,9 +14140,9 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_AUTHORIZE_VIEW",
- "type": "craft\\events\\AuthorizationCheckEvent",
- "desc": "The event that is triggered when determining whether a user is authorized to view the element’s edit page.",
+ "name": "EVENT_DEFINE_META_FIELDS_HTML",
+ "type": "craft\\events\\DefineHtmlEvent",
+ "desc": "The event that is triggered when defining the HTML for meta fields within the editor sidebar.",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -13856,9 +14218,9 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_AUTHORIZE_SAVE",
- "type": "craft\\events\\AuthorizationCheckEvent",
- "desc": "The event that is triggered when determining whether a user is authorized to save the element in its current state.",
+ "name": "EVENT_DEFINE_METADATA",
+ "type": "craft\\events\\DefineMetadataEvent",
+ "desc": "The event that is triggered when defining the element’s metadata info.",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -13934,9 +14296,9 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_AUTHORIZE_CREATE_DRAFTS",
+ "name": "EVENT_AUTHORIZE_VIEW",
"type": "craft\\events\\AuthorizationCheckEvent",
- "desc": "The event that is triggered when determining whether a user is authorized to create drafts for the element.",
+ "desc": "The event that is triggered when determining whether a user is authorized to view the element’s edit page.",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -14012,9 +14374,9 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_AUTHORIZE_DUPLICATE",
+ "name": "EVENT_AUTHORIZE_SAVE",
"type": "craft\\events\\AuthorizationCheckEvent",
- "desc": "The event that is triggered when determining whether a user is authorized to duplicate the element.",
+ "desc": "The event that is triggered when determining whether a user is authorized to save the element in its current state.",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -14090,9 +14452,9 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_AUTHORIZE_DELETE",
+ "name": "EVENT_AUTHORIZE_CREATE_DRAFTS",
"type": "craft\\events\\AuthorizationCheckEvent",
- "desc": "The event that is triggered when determining whether a user is authorized to delete the element.",
+ "desc": "The event that is triggered when determining whether a user is authorized to create drafts for the element.",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -14168,9 +14530,9 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_AUTHORIZE_DELETE_FOR_SITE",
+ "name": "EVENT_AUTHORIZE_DUPLICATE",
"type": "craft\\events\\AuthorizationCheckEvent",
- "desc": "The event that is triggered when determining whether a user is authorized to delete the element for its current site.",
+ "desc": "The event that is triggered when determining whether a user is authorized to duplicate the element.",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -14246,9 +14608,165 @@
},
{
"class": "craft\\elements\\Entry",
- "name": "EVENT_SET_ROUTE",
- "type": "craft\\events\\SetElementRouteEvent",
- "desc": "The event that is triggered when defining the route that should be used when this element’s URL is requested.",
+ "name": "EVENT_AUTHORIZE_DELETE",
+ "type": "craft\\events\\AuthorizationCheckEvent",
+ "desc": "The event that is triggered when determining whether a user is authorized to delete the element.",
+ "filters": {
+ "draft": {
+ "label": "Element is a draft",
+ "conditionsPhp": "ElementHelper::isDraft($event->sender)",
+ "imports": [
+ "craft\\helpers\\ElementHelper"
+ ],
+ "excludes": [
+ "revision",
+ "firstSave"
+ ]
+ },
+ "duplicating": {
+ "label": "Element is being duplicated to a new element",
+ "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
+ "excludes": [
+ "isNew",
+ "resaving",
+ "revision"
+ ]
+ },
+ "enabled": {
+ "label": "Element is enabled",
+ "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
+ },
+ "firstSave": {
+ "label": "Element is being saved for the first time",
+ "conditionsPhp": "$event->sender->firstSave",
+ "excludes": [
+ "isNew",
+ "draft",
+ "provisional",
+ "revision",
+ "resaving"
+ ]
+ },
+ "propagating": {
+ "label": "Element is being propagated",
+ "conditionsPhp": "$event->sender->propagating"
+ },
+ "provisional": {
+ "label": "Element is a provisional draft",
+ "conditionsPhp": "ElementHelper::rootElement($event->sender)->isProvisionalDraft",
+ "imports": [
+ "craft\\helpers\\ElementHelper"
+ ],
+ "excludes": [
+ "draft",
+ "revision",
+ "firstSave"
+ ]
+ },
+ "resaving": {
+ "label": "Element is being bulk-resaved",
+ "conditionsPhp": "$event->sender->resaving",
+ "excludes": [
+ "firstSave"
+ ]
+ },
+ "revision": {
+ "label": "Element is a revision",
+ "conditionsPhp": "ElementHelper::isRevision($event->sender)",
+ "imports": [
+ "craft\\helpers\\ElementHelper"
+ ],
+ "excludes": [
+ "draft",
+ "provisional",
+ "firstSave"
+ ]
+ }
+ }
+ },
+ {
+ "class": "craft\\elements\\Entry",
+ "name": "EVENT_AUTHORIZE_DELETE_FOR_SITE",
+ "type": "craft\\events\\AuthorizationCheckEvent",
+ "desc": "The event that is triggered when determining whether a user is authorized to delete the element for its current site.",
+ "filters": {
+ "draft": {
+ "label": "Element is a draft",
+ "conditionsPhp": "ElementHelper::isDraft($event->sender)",
+ "imports": [
+ "craft\\helpers\\ElementHelper"
+ ],
+ "excludes": [
+ "revision",
+ "firstSave"
+ ]
+ },
+ "duplicating": {
+ "label": "Element is being duplicated to a new element",
+ "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
+ "excludes": [
+ "isNew",
+ "resaving",
+ "revision"
+ ]
+ },
+ "enabled": {
+ "label": "Element is enabled",
+ "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
+ },
+ "firstSave": {
+ "label": "Element is being saved for the first time",
+ "conditionsPhp": "$event->sender->firstSave",
+ "excludes": [
+ "isNew",
+ "draft",
+ "provisional",
+ "revision",
+ "resaving"
+ ]
+ },
+ "propagating": {
+ "label": "Element is being propagated",
+ "conditionsPhp": "$event->sender->propagating"
+ },
+ "provisional": {
+ "label": "Element is a provisional draft",
+ "conditionsPhp": "ElementHelper::rootElement($event->sender)->isProvisionalDraft",
+ "imports": [
+ "craft\\helpers\\ElementHelper"
+ ],
+ "excludes": [
+ "draft",
+ "revision",
+ "firstSave"
+ ]
+ },
+ "resaving": {
+ "label": "Element is being bulk-resaved",
+ "conditionsPhp": "$event->sender->resaving",
+ "excludes": [
+ "firstSave"
+ ]
+ },
+ "revision": {
+ "label": "Element is a revision",
+ "conditionsPhp": "ElementHelper::isRevision($event->sender)",
+ "imports": [
+ "craft\\helpers\\ElementHelper"
+ ],
+ "excludes": [
+ "draft",
+ "provisional",
+ "firstSave"
+ ]
+ }
+ }
+ },
+ {
+ "class": "craft\\elements\\Entry",
+ "name": "EVENT_SET_ROUTE",
+ "type": "craft\\events\\SetElementRouteEvent",
+ "desc": "The event that is triggered when defining the route that should be used when this element’s URL is requested.",
"filters": {
"draft": {
"label": "Element is a draft",
@@ -16279,52 +16797,9 @@
},
{
"class": "craft\\elements\\GlobalSet",
- "name": "EVENT_DEFINE_EAGER_LOADING_MAP",
- "type": "craft\\events\\DefineEagerLoadingMapEvent",
- "desc": "The event that is triggered when defining an eager-loading map.",
- "filters": {
- "duplicating": {
- "label": "Element is being duplicated to a new element",
- "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
- "excludes": [
- "isNew",
- "resaving",
- "revision"
- ]
- },
- "enabled": {
- "label": "Element is enabled",
- "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
- },
- "firstSave": {
- "label": "Element is being saved for the first time",
- "conditionsPhp": "$event->sender->firstSave",
- "excludes": [
- "isNew",
- "draft",
- "provisional",
- "revision",
- "resaving"
- ]
- },
- "propagating": {
- "label": "Element is being propagated",
- "conditionsPhp": "$event->sender->propagating"
- },
- "resaving": {
- "label": "Element is being bulk-resaved",
- "conditionsPhp": "$event->sender->resaving",
- "excludes": [
- "firstSave"
- ]
- }
- }
- },
- {
- "class": "craft\\elements\\GlobalSet",
- "name": "EVENT_SET_EAGER_LOADED_ELEMENTS",
- "type": "craft\\events\\SetEagerLoadedElementsEvent",
- "desc": "The event that is triggered when setting eager-loaded elements.",
+ "name": "EVENT_REGISTER_CARD_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementCardAttributesEvent",
+ "desc": "The event that is triggered when registering the card attributes for the element type.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -16365,9 +16840,9 @@
},
{
"class": "craft\\elements\\GlobalSet",
- "name": "EVENT_REGISTER_PREVIEW_TARGETS",
- "type": "craft\\events\\RegisterPreviewTargetsEvent",
- "desc": "The event that is triggered when registering the element’s preview targets.",
+ "name": "EVENT_REGISTER_DEFAULT_CARD_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementCardAttributesEvent",
+ "desc": "The event that is triggered when registering the card attributes for the element type.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -16408,9 +16883,9 @@
},
{
"class": "craft\\elements\\GlobalSet",
- "name": "EVENT_DEFINE_ATTRIBUTE_HTML",
- "type": "craft\\events\\DefineAttributeHtmlEvent",
- "desc": "The event that is triggered when defining an attribute’s HTML for table and card views.",
+ "name": "EVENT_DEFINE_EAGER_LOADING_MAP",
+ "type": "craft\\events\\DefineEagerLoadingMapEvent",
+ "desc": "The event that is triggered when defining an eager-loading map.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -16451,9 +16926,9 @@
},
{
"class": "craft\\elements\\GlobalSet",
- "name": "EVENT_DEFINE_INLINE_ATTRIBUTE_INPUT_HTML",
- "type": "craft\\events\\DefineAttributeHtmlEvent",
- "desc": "The event that is triggered when defining an attribute’s inline input HTML.",
+ "name": "EVENT_SET_EAGER_LOADED_ELEMENTS",
+ "type": "craft\\events\\SetEagerLoadedElementsEvent",
+ "desc": "The event that is triggered when setting eager-loaded elements.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -16494,9 +16969,9 @@
},
{
"class": "craft\\elements\\GlobalSet",
- "name": "EVENT_REGISTER_HTML_ATTRIBUTES",
- "type": "craft\\events\\RegisterElementHtmlAttributesEvent",
- "desc": "The event that is triggered when registering the HTML attributes that should be included in the element’s DOM representation in the control panel.",
+ "name": "EVENT_REGISTER_PREVIEW_TARGETS",
+ "type": "craft\\events\\RegisterPreviewTargetsEvent",
+ "desc": "The event that is triggered when registering the element’s preview targets.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -16537,9 +17012,9 @@
},
{
"class": "craft\\elements\\GlobalSet",
- "name": "EVENT_DEFINE_ADDITIONAL_BUTTONS",
- "type": "craft\\events\\DefineHtmlEvent",
- "desc": "The event that is triggered when defining additional buttons that should be shown at the top of the element’s edit page.",
+ "name": "EVENT_DEFINE_ATTRIBUTE_HTML",
+ "type": "craft\\events\\DefineAttributeHtmlEvent",
+ "desc": "The event that is triggered when defining an attribute’s HTML for table and card views.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -16580,9 +17055,9 @@
},
{
"class": "craft\\elements\\GlobalSet",
- "name": "EVENT_DEFINE_ACTION_MENU_ITEMS",
- "type": "craft\\events\\DefineMenuItemsEvent",
- "desc": "The event that is triggered when defining action menu items..",
+ "name": "EVENT_DEFINE_INLINE_ATTRIBUTE_INPUT_HTML",
+ "type": "craft\\events\\DefineAttributeHtmlEvent",
+ "desc": "The event that is triggered when defining an attribute’s inline input HTML.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -16623,9 +17098,9 @@
},
{
"class": "craft\\elements\\GlobalSet",
- "name": "EVENT_DEFINE_SIDEBAR_HTML",
- "type": "craft\\events\\DefineHtmlEvent",
- "desc": "The event that is triggered when defining the HTML for the editor sidebar.",
+ "name": "EVENT_REGISTER_HTML_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementHtmlAttributesEvent",
+ "desc": "The event that is triggered when registering the HTML attributes that should be included in the element’s DOM representation in the control panel.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -16666,9 +17141,9 @@
},
{
"class": "craft\\elements\\GlobalSet",
- "name": "EVENT_DEFINE_META_FIELDS_HTML",
+ "name": "EVENT_DEFINE_ADDITIONAL_BUTTONS",
"type": "craft\\events\\DefineHtmlEvent",
- "desc": "The event that is triggered when defining the HTML for meta fields within the editor sidebar.",
+ "desc": "The event that is triggered when defining additional buttons that should be shown at the top of the element’s edit page.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -16709,9 +17184,9 @@
},
{
"class": "craft\\elements\\GlobalSet",
- "name": "EVENT_DEFINE_METADATA",
- "type": "craft\\events\\DefineMetadataEvent",
- "desc": "The event that is triggered when defining the element’s metadata info.",
+ "name": "EVENT_DEFINE_ACTION_MENU_ITEMS",
+ "type": "craft\\events\\DefineMenuItemsEvent",
+ "desc": "The event that is triggered when defining action menu items..",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -16752,9 +17227,138 @@
},
{
"class": "craft\\elements\\GlobalSet",
- "name": "EVENT_AUTHORIZE_VIEW",
- "type": "craft\\events\\AuthorizationCheckEvent",
- "desc": "The event that is triggered when determining whether a user is authorized to view the element’s edit page.",
+ "name": "EVENT_DEFINE_SIDEBAR_HTML",
+ "type": "craft\\events\\DefineHtmlEvent",
+ "desc": "The event that is triggered when defining the HTML for the editor sidebar.",
+ "filters": {
+ "duplicating": {
+ "label": "Element is being duplicated to a new element",
+ "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
+ "excludes": [
+ "isNew",
+ "resaving",
+ "revision"
+ ]
+ },
+ "enabled": {
+ "label": "Element is enabled",
+ "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
+ },
+ "firstSave": {
+ "label": "Element is being saved for the first time",
+ "conditionsPhp": "$event->sender->firstSave",
+ "excludes": [
+ "isNew",
+ "draft",
+ "provisional",
+ "revision",
+ "resaving"
+ ]
+ },
+ "propagating": {
+ "label": "Element is being propagated",
+ "conditionsPhp": "$event->sender->propagating"
+ },
+ "resaving": {
+ "label": "Element is being bulk-resaved",
+ "conditionsPhp": "$event->sender->resaving",
+ "excludes": [
+ "firstSave"
+ ]
+ }
+ }
+ },
+ {
+ "class": "craft\\elements\\GlobalSet",
+ "name": "EVENT_DEFINE_META_FIELDS_HTML",
+ "type": "craft\\events\\DefineHtmlEvent",
+ "desc": "The event that is triggered when defining the HTML for meta fields within the editor sidebar.",
+ "filters": {
+ "duplicating": {
+ "label": "Element is being duplicated to a new element",
+ "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
+ "excludes": [
+ "isNew",
+ "resaving",
+ "revision"
+ ]
+ },
+ "enabled": {
+ "label": "Element is enabled",
+ "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
+ },
+ "firstSave": {
+ "label": "Element is being saved for the first time",
+ "conditionsPhp": "$event->sender->firstSave",
+ "excludes": [
+ "isNew",
+ "draft",
+ "provisional",
+ "revision",
+ "resaving"
+ ]
+ },
+ "propagating": {
+ "label": "Element is being propagated",
+ "conditionsPhp": "$event->sender->propagating"
+ },
+ "resaving": {
+ "label": "Element is being bulk-resaved",
+ "conditionsPhp": "$event->sender->resaving",
+ "excludes": [
+ "firstSave"
+ ]
+ }
+ }
+ },
+ {
+ "class": "craft\\elements\\GlobalSet",
+ "name": "EVENT_DEFINE_METADATA",
+ "type": "craft\\events\\DefineMetadataEvent",
+ "desc": "The event that is triggered when defining the element’s metadata info.",
+ "filters": {
+ "duplicating": {
+ "label": "Element is being duplicated to a new element",
+ "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
+ "excludes": [
+ "isNew",
+ "resaving",
+ "revision"
+ ]
+ },
+ "enabled": {
+ "label": "Element is enabled",
+ "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
+ },
+ "firstSave": {
+ "label": "Element is being saved for the first time",
+ "conditionsPhp": "$event->sender->firstSave",
+ "excludes": [
+ "isNew",
+ "draft",
+ "provisional",
+ "revision",
+ "resaving"
+ ]
+ },
+ "propagating": {
+ "label": "Element is being propagated",
+ "conditionsPhp": "$event->sender->propagating"
+ },
+ "resaving": {
+ "label": "Element is being bulk-resaved",
+ "conditionsPhp": "$event->sender->resaving",
+ "excludes": [
+ "firstSave"
+ ]
+ }
+ }
+ },
+ {
+ "class": "craft\\elements\\GlobalSet",
+ "name": "EVENT_AUTHORIZE_VIEW",
+ "type": "craft\\events\\AuthorizationCheckEvent",
+ "desc": "The event that is triggered when determining whether a user is authorized to view the element’s edit page.",
"filters": {
"duplicating": {
"label": "Element is being duplicated to a new element",
@@ -18324,6 +18928,92 @@
}
}
},
+ {
+ "class": "craft\\elements\\Tag",
+ "name": "EVENT_REGISTER_CARD_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementCardAttributesEvent",
+ "desc": "The event that is triggered when registering the card attributes for the element type.",
+ "filters": {
+ "duplicating": {
+ "label": "Element is being duplicated to a new element",
+ "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
+ "excludes": [
+ "isNew",
+ "resaving",
+ "revision"
+ ]
+ },
+ "enabled": {
+ "label": "Element is enabled",
+ "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
+ },
+ "firstSave": {
+ "label": "Element is being saved for the first time",
+ "conditionsPhp": "$event->sender->firstSave",
+ "excludes": [
+ "isNew",
+ "draft",
+ "provisional",
+ "revision",
+ "resaving"
+ ]
+ },
+ "propagating": {
+ "label": "Element is being propagated",
+ "conditionsPhp": "$event->sender->propagating"
+ },
+ "resaving": {
+ "label": "Element is being bulk-resaved",
+ "conditionsPhp": "$event->sender->resaving",
+ "excludes": [
+ "firstSave"
+ ]
+ }
+ }
+ },
+ {
+ "class": "craft\\elements\\Tag",
+ "name": "EVENT_REGISTER_DEFAULT_CARD_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementCardAttributesEvent",
+ "desc": "The event that is triggered when registering the card attributes for the element type.",
+ "filters": {
+ "duplicating": {
+ "label": "Element is being duplicated to a new element",
+ "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
+ "excludes": [
+ "isNew",
+ "resaving",
+ "revision"
+ ]
+ },
+ "enabled": {
+ "label": "Element is enabled",
+ "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
+ },
+ "firstSave": {
+ "label": "Element is being saved for the first time",
+ "conditionsPhp": "$event->sender->firstSave",
+ "excludes": [
+ "isNew",
+ "draft",
+ "provisional",
+ "revision",
+ "resaving"
+ ]
+ },
+ "propagating": {
+ "label": "Element is being propagated",
+ "conditionsPhp": "$event->sender->propagating"
+ },
+ "resaving": {
+ "label": "Element is being bulk-resaved",
+ "conditionsPhp": "$event->sender->resaving",
+ "excludes": [
+ "firstSave"
+ ]
+ }
+ }
+ },
{
"class": "craft\\elements\\Tag",
"name": "EVENT_DEFINE_EAGER_LOADING_MAP",
@@ -20525,6 +21215,92 @@
}
}
},
+ {
+ "class": "craft\\elements\\User",
+ "name": "EVENT_REGISTER_CARD_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementCardAttributesEvent",
+ "desc": "The event that is triggered when registering the card attributes for the element type.",
+ "filters": {
+ "duplicating": {
+ "label": "Element is being duplicated to a new element",
+ "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
+ "excludes": [
+ "isNew",
+ "resaving",
+ "revision"
+ ]
+ },
+ "enabled": {
+ "label": "Element is enabled",
+ "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
+ },
+ "firstSave": {
+ "label": "Element is being saved for the first time",
+ "conditionsPhp": "$event->sender->firstSave",
+ "excludes": [
+ "isNew",
+ "draft",
+ "provisional",
+ "revision",
+ "resaving"
+ ]
+ },
+ "propagating": {
+ "label": "Element is being propagated",
+ "conditionsPhp": "$event->sender->propagating"
+ },
+ "resaving": {
+ "label": "Element is being bulk-resaved",
+ "conditionsPhp": "$event->sender->resaving",
+ "excludes": [
+ "firstSave"
+ ]
+ }
+ }
+ },
+ {
+ "class": "craft\\elements\\User",
+ "name": "EVENT_REGISTER_DEFAULT_CARD_ATTRIBUTES",
+ "type": "craft\\events\\RegisterElementCardAttributesEvent",
+ "desc": "The event that is triggered when registering the card attributes for the element type.",
+ "filters": {
+ "duplicating": {
+ "label": "Element is being duplicated to a new element",
+ "conditionsPhp": "($event->sender->duplicateOf && $event->sender->getIsCanonical() && !$event->sender->updatingFromDerivative)",
+ "excludes": [
+ "isNew",
+ "resaving",
+ "revision"
+ ]
+ },
+ "enabled": {
+ "label": "Element is enabled",
+ "conditionsPhp": "($event->sender->enabled && $event->sender->getEnabledForSite())"
+ },
+ "firstSave": {
+ "label": "Element is being saved for the first time",
+ "conditionsPhp": "$event->sender->firstSave",
+ "excludes": [
+ "isNew",
+ "draft",
+ "provisional",
+ "revision",
+ "resaving"
+ ]
+ },
+ "propagating": {
+ "label": "Element is being propagated",
+ "conditionsPhp": "$event->sender->propagating"
+ },
+ "resaving": {
+ "label": "Element is being bulk-resaved",
+ "conditionsPhp": "$event->sender->resaving",
+ "excludes": [
+ "firstSave"
+ ]
+ }
+ }
+ },
{
"class": "craft\\elements\\User",
"name": "EVENT_DEFINE_EAGER_LOADING_MAP",
@@ -23625,6 +24401,48 @@
"type": "yii\\base\\Event",
"desc": "an event raised at the end of `validate()`"
},
+ {
+ "class": "craft\\elements\\conditions\\LanguageConditionRule",
+ "name": "EVENT_INIT",
+ "type": "yii\\base\\Event",
+ "desc": "The event that is triggered after the model's init cycle"
+ },
+ {
+ "class": "craft\\elements\\conditions\\LanguageConditionRule",
+ "name": "EVENT_DEFINE_BEHAVIORS",
+ "type": "craft\\events\\DefineBehaviorsEvent",
+ "desc": "The event that is triggered when defining the class behaviors"
+ },
+ {
+ "class": "craft\\elements\\conditions\\LanguageConditionRule",
+ "name": "EVENT_DEFINE_RULES",
+ "type": "craft\\events\\DefineRulesEvent",
+ "desc": "The event that is triggered when defining the model rules"
+ },
+ {
+ "class": "craft\\elements\\conditions\\LanguageConditionRule",
+ "name": "EVENT_DEFINE_FIELDS",
+ "type": "craft\\events\\DefineFieldsEvent",
+ "desc": "The event that is triggered when defining the arrayable fields"
+ },
+ {
+ "class": "craft\\elements\\conditions\\LanguageConditionRule",
+ "name": "EVENT_DEFINE_EXTRA_FIELDS",
+ "type": "craft\\events\\DefineFieldsEvent",
+ "desc": "The event that is triggered when defining the extra arrayable fields"
+ },
+ {
+ "class": "craft\\elements\\conditions\\LanguageConditionRule",
+ "name": "EVENT_BEFORE_VALIDATE",
+ "type": "yii\\base\\ModelEvent",
+ "desc": "an event raised at the beginning of `validate()`. You may set `ModelEvent::isValid` to be false to stop the validation."
+ },
+ {
+ "class": "craft\\elements\\conditions\\LanguageConditionRule",
+ "name": "EVENT_AFTER_VALIDATE",
+ "type": "yii\\base\\Event",
+ "desc": "an event raised at the end of `validate()`"
+ },
{
"class": "craft\\elements\\conditions\\LevelConditionRule",
"name": "EVENT_INIT",
@@ -27039,6 +27857,54 @@
"type": "yii\\base\\Event",
"desc": "an event raised at the end of `validate()`"
},
+ {
+ "class": "craft\\fieldlayoutelements\\Markdown",
+ "name": "EVENT_DEFINE_SHOW_IN_FORM",
+ "type": "craft\\events\\DefineShowFieldLayoutComponentInFormEvent",
+ "desc": "The event that is triggered when determining whether the component should be shown in a field layout."
+ },
+ {
+ "class": "craft\\fieldlayoutelements\\Markdown",
+ "name": "EVENT_INIT",
+ "type": "yii\\base\\Event",
+ "desc": "The event that is triggered after the model's init cycle"
+ },
+ {
+ "class": "craft\\fieldlayoutelements\\Markdown",
+ "name": "EVENT_DEFINE_BEHAVIORS",
+ "type": "craft\\events\\DefineBehaviorsEvent",
+ "desc": "The event that is triggered when defining the class behaviors"
+ },
+ {
+ "class": "craft\\fieldlayoutelements\\Markdown",
+ "name": "EVENT_DEFINE_RULES",
+ "type": "craft\\events\\DefineRulesEvent",
+ "desc": "The event that is triggered when defining the model rules"
+ },
+ {
+ "class": "craft\\fieldlayoutelements\\Markdown",
+ "name": "EVENT_DEFINE_FIELDS",
+ "type": "craft\\events\\DefineFieldsEvent",
+ "desc": "The event that is triggered when defining the arrayable fields"
+ },
+ {
+ "class": "craft\\fieldlayoutelements\\Markdown",
+ "name": "EVENT_DEFINE_EXTRA_FIELDS",
+ "type": "craft\\events\\DefineFieldsEvent",
+ "desc": "The event that is triggered when defining the extra arrayable fields"
+ },
+ {
+ "class": "craft\\fieldlayoutelements\\Markdown",
+ "name": "EVENT_BEFORE_VALIDATE",
+ "type": "yii\\base\\ModelEvent",
+ "desc": "an event raised at the beginning of `validate()`. You may set `ModelEvent::isValid` to be false to stop the validation."
+ },
+ {
+ "class": "craft\\fieldlayoutelements\\Markdown",
+ "name": "EVENT_AFTER_VALIDATE",
+ "type": "yii\\base\\Event",
+ "desc": "an event raised at the end of `validate()`"
+ },
{
"class": "craft\\fieldlayoutelements\\Template",
"name": "EVENT_DEFINE_SHOW_IN_FORM",
@@ -31143,6 +32009,150 @@
"type": "yii\\base\\Event",
"desc": "an event raised at the end of `validate()`"
},
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_BEFORE_ELEMENT_SAVE",
+ "type": "craft\\events\\FieldElementEvent",
+ "desc": "The event that is triggered before the element is saved."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_AFTER_ELEMENT_SAVE",
+ "type": "craft\\events\\FieldElementEvent",
+ "desc": "The event that is triggered after the element is saved."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_AFTER_ELEMENT_PROPAGATE",
+ "type": "craft\\events\\FieldElementEvent",
+ "desc": "The event that is triggered after the element is fully saved and propagated to other sites."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_BEFORE_ELEMENT_DELETE",
+ "type": "craft\\events\\FieldElementEvent",
+ "desc": "The event that is triggered before the element is deleted."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_AFTER_ELEMENT_DELETE",
+ "type": "craft\\events\\FieldElementEvent",
+ "desc": "The event that is triggered after the element is deleted."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_BEFORE_ELEMENT_RESTORE",
+ "type": "craft\\events\\FieldElementEvent",
+ "desc": "The event that is triggered before the element is restored."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_AFTER_ELEMENT_RESTORE",
+ "type": "craft\\events\\FieldElementEvent",
+ "desc": "The event that is triggered after the element is restored."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_DEFINE_KEYWORDS",
+ "type": "craft\\events\\DefineFieldKeywordsEvent",
+ "desc": "The event that is triggered when defining the field’s search keywords for an element."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_DEFINE_INPUT_HTML",
+ "type": "craft\\events\\DefineFieldHtmlEvent",
+ "desc": "The event that is triggered when defining the field’s input HTML."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_AFTER_MERGE_INTO",
+ "type": "craft\\events\\FieldEvent",
+ "desc": "The event that is triggered after the field has been merged into another."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_AFTER_MERGE_FROM",
+ "type": "craft\\events\\FieldEvent",
+ "desc": "The event that is triggered after another field has been merged into this one."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_BEFORE_SAVE",
+ "type": "craft\\events\\ModelEvent",
+ "desc": "The event that is triggered before the component is saved."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_AFTER_SAVE",
+ "type": "craft\\events\\ModelEvent",
+ "desc": "The event that is triggered after the component is saved."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_BEFORE_DELETE",
+ "type": "craft\\events\\ModelEvent",
+ "desc": "The event that is triggered before the component is deleted."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_BEFORE_APPLY_DELETE",
+ "type": "craft\\events\\ModelEvent",
+ "desc": "The event that is triggered before the delete is applied to the database."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_AFTER_DELETE",
+ "type": "yii\\base\\Event",
+ "desc": "The event that is triggered after the component is deleted."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_DEFINE_SETTINGS_ATTRIBUTES",
+ "type": "craft\\events\\DefineValueEvent",
+ "desc": "The event that is triggered when defining the component’s settings attributes, as returned by `settingsAttributes()`."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_INIT",
+ "type": "yii\\base\\Event",
+ "desc": "The event that is triggered after the model's init cycle"
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_DEFINE_BEHAVIORS",
+ "type": "craft\\events\\DefineBehaviorsEvent",
+ "desc": "The event that is triggered when defining the class behaviors"
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_DEFINE_RULES",
+ "type": "craft\\events\\DefineRulesEvent",
+ "desc": "The event that is triggered when defining the model rules"
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_DEFINE_FIELDS",
+ "type": "craft\\events\\DefineFieldsEvent",
+ "desc": "The event that is triggered when defining the arrayable fields"
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_DEFINE_EXTRA_FIELDS",
+ "type": "craft\\events\\DefineFieldsEvent",
+ "desc": "The event that is triggered when defining the extra arrayable fields"
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_BEFORE_VALIDATE",
+ "type": "yii\\base\\ModelEvent",
+ "desc": "an event raised at the beginning of `validate()`. You may set `ModelEvent::isValid` to be false to stop the validation."
+ },
+ {
+ "class": "craft\\fields\\Range",
+ "name": "EVENT_AFTER_VALIDATE",
+ "type": "yii\\base\\Event",
+ "desc": "an event raised at the end of `validate()`"
+ },
{
"class": "craft\\fields\\Table",
"name": "EVENT_BEFORE_ELEMENT_SAVE",
@@ -38542,6 +39552,12 @@
"type": "craft\\events\\DefineAddressSubdivisionsEvent",
"desc": "The event that is triggered when defining subdivisions options for an address field for a given country code, and optionally administrativeArea and locality."
},
+ {
+ "class": "craft\\services\\Addresses",
+ "name": "EVENT_DEFINE_ADDRESS_COUNTRIES",
+ "type": "craft\\events\\DefineAddressCountriesEvent",
+ "desc": "The event that is triggered when defining country options for an address."
+ },
{
"class": "craft\\services\\Assets",
"name": "EVENT_BEFORE_REPLACE_ASSET",
@@ -39286,6 +40302,12 @@
"type": "craft\\events\\FieldEvent",
"desc": "The event that is triggered before a field is saved."
},
+ {
+ "class": "craft\\services\\Fields",
+ "name": "EVENT_BEFORE_APPLY_FIELD_SAVE",
+ "type": "craft\\events\\ApplyFieldSaveEvent",
+ "desc": "The event that is triggered before a field save is applied to the database."
+ },
{
"class": "craft\\services\\Fields",
"name": "EVENT_AFTER_SAVE_FIELD",
diff --git a/docs/.artifacts/commerce/5.x/orders-carts.md b/docs/.artifacts/commerce/5.x/orders-carts.md
index 6204ed258..95ac6953e 100644
--- a/docs/.artifacts/commerce/5.x/orders-carts.md
+++ b/docs/.artifacts/commerce/5.x/orders-carts.md
@@ -9,10 +9,11 @@
| Param | Description
| --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| [afterPopulate](#afterpopulate) | Performs any post-population processing on elements.
+| [andNotRelatedTo](#andnotrelatedto) | Narrows the query results to only orders that are not related to certain other elements.
| [andRelatedTo](#andrelatedto) | Narrows the query results to only orders that are related to certain other elements.
| [asArray](#asarray) | Causes the query to return matching orders as arrays of data, rather than [Order](commerce5:craft\commerce\elements\Order) objects.
| [cache](#cache) | Enables query cache for this Query.
-| [clearCachedResult](#clearcachedresult) | Clears the [cached result](https://craftcms.com/docs/4.x/element-queries.html#cache).
+| [clearCachedResult](#clearcachedresult) | Clears the [cached result](https://craftcms.com/docs/5.x/development/element-queries.html#cache).
| [customer](#customer) | Narrows the query results based on the customer’s user account.
| [customerId](#customerid) | Narrows the query results based on the customer, per their user ID.
| [dateAuthorized](#dateauthorized) | Narrows the query results based on the orders’ authorized dates.
@@ -40,6 +41,7 @@
| [itemTotal](#itemtotal) | Narrows the query results based on the order’s item total.
| [language](#language) | Determines which site(s) the orders should be queried in, based on their language.
| [limit](#limit) | Determines the number of orders that should be returned.
+| [notRelatedTo](#notrelatedto) | Narrows the query results to only orders that are not related to certain other elements.
| [number](#number) | Narrows the query results based on the order number.
| [offset](#offset) | Determines how many orders should be skipped in the results.
| [orderBy](#orderby) | Determines the order that the orders should be returned in. (If empty, defaults to `id ASC`.)
@@ -96,13 +98,42 @@ Performs any post-population processing on elements.
+#### `andNotRelatedTo`
+
+Narrows the query results to only orders that are not related to certain other elements.
+
+
+
+See [Relations](https://craftcms.com/docs/5.x/system/relations.html) for a full explanation of how to work with this parameter.
+
+
+
+::: code
+```twig
+{# Fetch all orders that are related to myCategoryA and not myCategoryB #}
+{% set orders = craft.orders()
+ .relatedTo(myCategoryA)
+ .andNotRelatedTo(myCategoryB)
+ .all() %}
+```
+
+```php
+// Fetch all orders that are related to $myCategoryA and not $myCategoryB
+$orders = \craft\commerce\elements\Order::find()
+ ->relatedTo($myCategoryA)
+ ->andNotRelatedTo($myCategoryB)
+ ->all();
+```
+:::
+
+
#### `andRelatedTo`
Narrows the query results to only orders that are related to certain other elements.
-See [Relations](https://craftcms.com/docs/4.x/relations.html) for a full explanation of how to work with this parameter.
+See [Relations](https://craftcms.com/docs/5.x/system/relations.html) for a full explanation of how to work with this parameter.
@@ -165,7 +196,7 @@ Enables query cache for this Query.
#### `clearCachedResult`
-Clears the [cached result](https://craftcms.com/docs/4.x/element-queries.html#cache).
+Clears the [cached result](https://craftcms.com/docs/5.x/development/element-queries.html#cache).
@@ -843,6 +874,33 @@ $orders = \craft\commerce\elements\Order::find()
:::
+#### `notRelatedTo`
+
+Narrows the query results to only orders that are not related to certain other elements.
+
+
+
+See [Relations](https://craftcms.com/docs/5.x/system/relations.html) for a full explanation of how to work with this parameter.
+
+
+
+::: code
+```twig
+{# Fetch all orders that are related to myEntry #}
+{% set orders = craft.orders()
+ .notRelatedTo(myEntry)
+ .all() %}
+```
+
+```php
+// Fetch all orders that are related to $myEntry
+$orders = \craft\commerce\elements\Order::find()
+ ->notRelatedTo($myEntry)
+ ->all();
+```
+:::
+
+
#### `number`
Narrows the query results based on the order number.
@@ -1181,7 +1239,7 @@ Narrows the query results to only orders that are related to certain other eleme
-See [Relations](https://craftcms.com/docs/4.x/relations.html) for a full explanation of how to work with this parameter.
+See [Relations](https://craftcms.com/docs/5.x/system/relations.html) for a full explanation of how to work with this parameter.
@@ -1217,7 +1275,7 @@ Narrows the query results to only orders that match a search query.
-See [Searching](https://craftcms.com/docs/4.x/searching.html) for a full explanation of how to work with this parameter.
+See [Searching](https://craftcms.com/docs/5.x/system/searching.html) for a full explanation of how to work with this parameter.
@@ -1535,7 +1593,7 @@ Causes the query to return matching orders eager-loaded with related elements.
-See [Eager-Loading Elements](https://craftcms.com/docs/4.x/dev/eager-loading-elements.html) for a full explanation of how to work with this parameter.
+See [Eager-Loading Elements](https://craftcms.com/docs/5.x/development/eager-loading.html) for a full explanation of how to work with this parameter.
diff --git a/docs/.artifacts/commerce/5.x/subscriptions.md b/docs/.artifacts/commerce/5.x/subscriptions.md
index 5397fa5e5..a75d29f4b 100644
--- a/docs/.artifacts/commerce/5.x/subscriptions.md
+++ b/docs/.artifacts/commerce/5.x/subscriptions.md
@@ -9,10 +9,11 @@
| Param | Description
| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| [afterPopulate](#afterpopulate) | Performs any post-population processing on elements.
+| [andNotRelatedTo](#andnotrelatedto) | Narrows the query results to only subscriptions that are not related to certain other elements.
| [andRelatedTo](#andrelatedto) | Narrows the query results to only subscriptions that are related to certain other elements.
| [asArray](#asarray) | Causes the query to return matching subscriptions as arrays of data, rather than [Subscription](commerce5:craft\commerce\elements\Subscription) objects.
| [cache](#cache) | Enables query cache for this Query.
-| [clearCachedResult](#clearcachedresult) | Clears the [cached result](https://craftcms.com/docs/4.x/element-queries.html#cache).
+| [clearCachedResult](#clearcachedresult) | Clears the [cached result](https://craftcms.com/docs/5.x/development/element-queries.html#cache).
| [dateCanceled](#datecanceled) | Narrows the query results based on the subscriptions’ cancellation date.
| [dateCreated](#datecreated) | Narrows the query results based on the subscriptions’ creation dates.
| [dateExpired](#dateexpired) | Narrows the query results based on the subscriptions’ expiration date.
@@ -32,6 +33,7 @@
| [language](#language) | Determines which site(s) the subscriptions should be queried in, based on their language.
| [limit](#limit) | Determines the number of subscriptions that should be returned.
| [nextPaymentDate](#nextpaymentdate) | Narrows the query results based on the subscriptions’ next payment dates.
+| [notRelatedTo](#notrelatedto) | Narrows the query results to only subscriptions that are not related to certain other elements.
| [offset](#offset) | Determines how many subscriptions should be skipped in the results.
| [onTrial](#ontrial) | Narrows the query results to only subscriptions that are on trial.
| [orderBy](#orderby) | Determines the order that the subscriptions should be returned in. (If empty, defaults to `dateCreated DESC`.)
@@ -74,13 +76,42 @@ Performs any post-population processing on elements.
+#### `andNotRelatedTo`
+
+Narrows the query results to only subscriptions that are not related to certain other elements.
+
+
+
+See [Relations](https://craftcms.com/docs/5.x/system/relations.html) for a full explanation of how to work with this parameter.
+
+
+
+::: code
+```twig
+{# Fetch all subscriptions that are related to myCategoryA and not myCategoryB #}
+{% set subscriptions = craft.subscriptions()
+ .relatedTo(myCategoryA)
+ .andNotRelatedTo(myCategoryB)
+ .all() %}
+```
+
+```php
+// Fetch all subscriptions that are related to $myCategoryA and not $myCategoryB
+$subscriptions = \craft\commerce\elements\Subscription::find()
+ ->relatedTo($myCategoryA)
+ ->andNotRelatedTo($myCategoryB)
+ ->all();
+```
+:::
+
+
#### `andRelatedTo`
Narrows the query results to only subscriptions that are related to certain other elements.
-See [Relations](https://craftcms.com/docs/4.x/relations.html) for a full explanation of how to work with this parameter.
+See [Relations](https://craftcms.com/docs/5.x/system/relations.html) for a full explanation of how to work with this parameter.
@@ -143,7 +174,7 @@ Enables query cache for this Query.
#### `clearCachedResult`
-Clears the [cached result](https://craftcms.com/docs/4.x/element-queries.html#cache).
+Clears the [cached result](https://craftcms.com/docs/5.x/development/element-queries.html#cache).
@@ -673,6 +704,33 @@ $subscriptions = \craft\commerce\elements\Subscription::find()
:::
+#### `notRelatedTo`
+
+Narrows the query results to only subscriptions that are not related to certain other elements.
+
+
+
+See [Relations](https://craftcms.com/docs/5.x/system/relations.html) for a full explanation of how to work with this parameter.
+
+
+
+::: code
+```twig
+{# Fetch all subscriptions that are related to myEntry #}
+{% set subscriptions = craft.subscriptions()
+ .notRelatedTo(myEntry)
+ .all() %}
+```
+
+```php
+// Fetch all subscriptions that are related to $myEntry
+$subscriptions = \craft\commerce\elements\Subscription::find()
+ ->notRelatedTo($myEntry)
+ ->all();
+```
+:::
+
+
#### `offset`
Determines how many subscriptions should be skipped in the results.
@@ -876,7 +934,7 @@ Narrows the query results to only subscriptions that are related to certain othe
-See [Relations](https://craftcms.com/docs/4.x/relations.html) for a full explanation of how to work with this parameter.
+See [Relations](https://craftcms.com/docs/5.x/system/relations.html) for a full explanation of how to work with this parameter.
@@ -912,7 +970,7 @@ Narrows the query results to only subscriptions that match a search query.
-See [Searching](https://craftcms.com/docs/4.x/searching.html) for a full explanation of how to work with this parameter.
+See [Searching](https://craftcms.com/docs/5.x/system/searching.html) for a full explanation of how to work with this parameter.
@@ -1158,7 +1216,7 @@ Causes the query to return matching subscriptions eager-loaded with related elem
-See [Eager-Loading Elements](https://craftcms.com/docs/4.x/dev/eager-loading-elements.html) for a full explanation of how to work with this parameter.
+See [Eager-Loading Elements](https://craftcms.com/docs/5.x/development/eager-loading.html) for a full explanation of how to work with this parameter.