def extra_params(cls):
return [
SnippetParam(
name='attribute_code',
description='Default to lowercase of label',
regex_validator= r'^[a-zA-Z]{1}\w{0,29}$',
error_message='Only alphanumeric and underscore characters are allowed, and need to start with a alphabetic character. And can\'t be longer then 30 characters'),
SnippetParam(
name='sort_order',
description='333',
regex_validator= r'^\d+$',
error_message='Only numeric value'),
SnippetParam(
name='visible',
default=True,
yes_no=True),
]
def params(cls):
return [
SnippetParam(
name='action_name',
required=True,
description='Console action name. Example: Backup, Import',
regex_validator=r'^[a-zA-Z]{1}\w+$',
error_message=
'Only alphanumeric and underscore characters are allowed, and need to start with a alphabetic character.'
),
SnippetParam(
name='short_description',
required=True,
description=
'Console action description. Example: Backups magento enviroment, Starts product import'
),
]
def params(cls):
return [
SnippetParam(
name='test_suite',
required=True,
regex_validator=r'^[a-zA-Z]{1}\w+$',
error_message=
'Only alphanumeric and underscore characters are allowed, and need to start with a alphabetic character.'
),
SnippetParam(
name='test_name',
required=True,
regex_validator=r'^[a-zA-Z]{1}\w+$',
error_message=
'Only alphanumeric and underscore characters are allowed, and need to start with a alphabetic character.'
),
]
def extra_params(cls):
return [
SnippetParam(
name='attribute_code',
regex_validator=r'^[a-zA-Z]{1}\w+$',
error_message=
'Only alphanumeric and underscore characters are allowed, and need to start with a alphabetic character.'
),
SnippetParam(name='searchable',
required=True,
default=False,
yes_no=True),
SnippetParam(
name='filterable',
required=True,
default=False,
depend={'frontend_input': r'select|multiselect|price'},
yes_no=True),
SnippetParam(name='visible_on_front',
required=True,
default=False,
yes_no=True),
SnippetParam(name='comparable',
required=True,
default=False,
yes_no=True),
SnippetParam(name='used_in_product_listing',
required=True,
default=False,
yes_no=True),
SnippetParam(name='unique',
required=True,
default=False,
yes_no=True),
]
def params(cls):
return [
SnippetParam(
name='method_name',
required=True,
description='Example: Invoice, Credits',
regex_validator= r'^[a-zA-Z]{1}\w+$',
error_message='Only alphanumeric and underscore characters are allowed, and need to start with a alphabetic character.'),
]
def params(cls):
return [
SnippetParam(
name='cronjob_name',
required=True,
description='Cronjob Name',
regex_validator=r'^[a-zA-Z]{1}\w+$',
error_message=
'Only alphanumeric and underscore characters are allowed, and need to start with a alphabetic character.'
),
SnippetParam(
name='schedule',
required=True,
default='*/5 * * * *',
description='Cron Schedule. For example */5 * * * *',
regex_validator=
r'^([\d*,-/]+)\s+([\d*,-/]+)\s+([\d*,-/\?LW]+)\s+([\d\w*,-/]+)\s+([\d\w*,-/\?L#]+)\s*([\d\w*,-/]*)$',
error_message='Enter a valid cron schedule'),
]
def params(cls):
return [
SnippetParam(
name='tab',
required=True,
description='Example: catalog',
regex_validator=r'^[a-z]{1}[a-z0-9_]+$',
error_message=
'Only lowercase alphanumeric and underscore characters are allowed, and need to start with a alphabetic character.',
repeat=True),
SnippetParam(name='new_tab',
default=True,
yes_no=True,
repeat=True),
SnippetParam(
name='section',
required=True,
description='Example: inventory',
regex_validator=r'^[a-z]{1}[a-z0-9_]+$',
error_message=
'Only lowercase alphanumeric and underscore characters are allowed, and need to start with a alphabetic character.',
repeat=True),
SnippetParam(
name='group',
required=True,
description='Example: options',
regex_validator=r'^[a-z]{1}[a-z0-9_]+$',
error_message=
'Only lowercase alphanumeric and underscore characters are allowed, and need to start with a alphabetic character.',
repeat=True),
SnippetParam(
name='field',
required=True,
description='Example: out of stock label ',
regex_validator=r'^[a-z]{1}[a-z0-9_]+$',
error_message=
'Only lowercase alphanumeric and underscore characters are allowed, and need to start with a alphabetic character.'
),
SnippetParam(name='field_type',
choises=cls.TYPE_CHOISES,
default='text'),
SnippetParam(name='source_model',
choises=cls.SOURCE_MODELS,
depend={'field_type': r'select|multiselect'},
default='Magento\Config\Model\Config\Source\Yesno'),
SnippetParam(
name='source_model_options',
required=True,
depend={'source_model': r'custom'},
description='comma seperated options. Example: yes,no.maybe',
error_message='Only alphanumeric')
]
def params(cls):
return [
SnippetParam(
name='method_name',
required=True,
description=
'Shipping Method name. Example: Freeshipping, Per product shipping',
regex_validator=r'^[a-zA-Z]{1}\w+$',
error_message=
'Only alphanumeric and underscore characters are allowed, and need to start with a alphabetic character.'
),
]
def params(cls):
return [
SnippetParam(name='attribute_label',
required=True,
description='Example: short_description',
regex_validator=r'^[a-zA-Z\d\-_\s]+$',
error_message='Only alphanumeric'),
SnippetParam(name='frontend_input',
choises=cls.FRONTEND_INPUT_TYPE,
required=True,
default='text'),
SnippetParam(
name='source_model',
choises=cls.CATEGORY_SOURCE_MODELS,
depend={'frontend_input': r'select|multiselect'},
default='Magento\Eav\Model\Entity\Attribute\Source\Boolean'),
SnippetParam(
name='source_model_options',
required=True,
depend={'source_model': r'custom'},
description='Dropdown or Multiselect options comma seperated',
error_message='Only alphanumeric'),
SnippetParam(name='scope',
required=True,
choises=cls.SCOPE_CHOICES,
default='1'),
SnippetParam(name='required',
required=True,
default=True,
yes_no=True),
]
def params(cls):
return [
SnippetParam(name='classname', required=True,
description='Example: Html\\Notices',
regex_validator=r'^[\w\\]+$',
error_message='Only alphanumeric, underscore and backslash characters are allowed'),
SnippetParam(name='methodname', required=True,
description='Example: displayDemoNotice',
regex_validator= r'^\w+$',
error_message='Only alphanumeric and underscore characters are allowed'),
SnippetParam(name='scope', choises=cls.SCOPE_CHOISES, default=cls.SCOPE_FRONTEND),
SnippetParam(name='layout_handle',
description='Example: cms_index_index',
regex_validator= r'^\w+$',
error_message='Only alphanumeric and underscore characters are allowed'),
SnippetParam(name='reference_type',
choises=cls.REFERENCE_CHOISES,
depend={'layout_handle': r'^\w+$'},
default=cls.REFERENCE_CONTAINER),
SnippetParam(name='reference_name',
description='Example: content',
depend={'layout_handle': r'^\w+$'},
regex_validator=r'^\w+$',
error_message='Only alphanumeric and underscore characters are allowed'),
]
def params(cls):
return [
SnippetParam(
name='classname',
required=True,
description='Example: Magento\Catalog\Model\Product',
regex_validator=r'^[\w\\]+$',
error_message=
'Only alphanumeric, underscore and backslash characters are allowed'
),
SnippetParam(
name='methodname',
required=True,
description='Example: getPrice',
regex_validator=r'^\w+$',
error_message=
'Only alphanumeric and underscore characters are allowed'),
SnippetParam(name='plugintype',
choises=cls.TYPE_CHOISES,
default=cls.TYPE_AFTER),
SnippetParam(name='scope',
choises=cls.SCOPE_CHOISES,
default=cls.SCOPE_ALL),
SnippetParam(name='sortorder',
default=10,
regex_validator=r'^\d*$',
error_message='Must be numeric'),
SnippetParam(name='disabled', yes_no=True),
]
def extra_params(cls):
return [
SnippetParam(
name='attribute_code',
description='Default to lowercase of label',
regex_validator=r'^[a-zA-Z]{1}\w{0,29}$',
error_message=
'Only alphanumeric and underscore characters are allowed, and need to start with a alphabetic character. And can\'t be longer then 30 characters'
),
SnippetParam(name='apply_to',
required=False,
default='',
choises=cls.APPLY_TO_CHOICES,
multiple_choices=True),
SnippetParam(name='searchable',
required=True,
default=False,
yes_no=True),
SnippetParam(
name='filterable',
required=True,
default=False,
depend={'frontend_input': r'select|multiselect|price'},
yes_no=True),
SnippetParam(name='visible_on_front',
required=True,
default=False,
yes_no=True),
SnippetParam(name='comparable',
required=True,
default=False,
yes_no=True),
SnippetParam(name='used_in_product_listing',
required=True,
default=False,
yes_no=True),
SnippetParam(name='unique',
required=True,
default=False,
yes_no=True),
SnippetParam(name='transport_to_quote_item',
required=True,
default=False,
yes_no=True),
]
def params(cls):
return [
SnippetParam(name='config_name',
description='XML config filename',
required=True,
regex_validator=r'^[a-z_]+$',
error_message=
'Only lower case alphabet and underscore characters',
repeat=True),
SnippetParam(name='node_name',
description='Repeating XML node name',
required=True,
regex_validator=r'^[a-z_]+$',
error_message=
'Only lower case alphabet and underscore characters',
repeat=True),
SnippetParam(name='field_name',
description='Configuration field name',
required=True,
regex_validator=r'^[a-z_]+$',
error_message=
'Only lower case alphabet and underscore characters'),
]
def params(cls):
return [
SnippetParam(
name='model_name',
required=True,
regex_validator=r'^[a-zA-Z]{1}\w+$',
error_message=
'Only alphanumeric and underscore characters are allowed, and need to start with a alphabetic character.'
),
SnippetParam(
name='field_name',
required=True,
regex_validator=r'^[a-zA-Z]{1}\w+$',
error_message=
'Only alphanumeric and underscore characters are allowed, and need to start with a alphabetic character.'
),
SnippetParam(
name='field_type',
choises=cls.FIELD_TYPE_CHOISES,
default='text',
),
SnippetParam(name='adminhtml_grid', yes_no=True),
]
def extra_params(cls):
return [
'Tab',
SnippetParam(name='tab_label',
repeat=True,
description='Default uses tab value'),
SnippetParam(name='tab_sortOrder',
description='999',
regex_validator=r'^\d+$',
error_message='Only numeric value',
repeat=True),
'Section',
SnippetParam(name='section_label',
repeat=True,
description='Default uses section value'),
SnippetParam(name='section_sortorder',
description='10',
regex_validator=r'^\d+$',
error_message='Only numeric value',
repeat=True),
SnippetParam(name='section_show_in_website',
default=True,
yes_no=True,
repeat=True),
SnippetParam(name='section_show_in_store',
default=True,
yes_no=True,
repeat=True),
SnippetParam(name='section_show_in_default',
default=True,
yes_no=True,
repeat=True),
'Group',
SnippetParam(name='group_label',
repeat=True,
description='Default uses group value'),
SnippetParam(name='group_sortorder',
description='10',
regex_validator=r'^\d+$',
error_message='Only numeric value',
repeat=True),
SnippetParam(name='group_show_in_website',
default=True,
yes_no=True,
repeat=True),
SnippetParam(name='group_show_in_store',
default=True,
yes_no=True,
repeat=True),
SnippetParam(name='group_show_in_default',
default=True,
yes_no=True,
repeat=True),
'Field',
SnippetParam(name='field_label',
description='Default uses field value'),
SnippetParam(
name='field_comment',
description='Example: Label used to display out of stock status'
),
SnippetParam(name='field_default',
description='Default value of field'),
SnippetParam(name='field_sortorder',
description='10',
regex_validator=r'^\d+$',
error_message='Only numeric value'),
SnippetParam(name='field_show_in_website',
default=True,
yes_no=True),
SnippetParam(name='field_show_in_store', default=True,
yes_no=True),
SnippetParam(name='field_show_in_default',
default=True,
yes_no=True),
SnippetParam(
name='field_backend_model',
regex_validator=r'^[\w\\]+$',
error_message=
'Only alphanumeric, underscore and backslash characters are allowed'
),
]
def extra_params(cls):
return [
'Tab',
SnippetParam(name='tab_label', repeat=True),
SnippetParam(name='tab_sortOrder',
regex_validator=r'^\d+$',
error_message='Only numeric value',
repeat=True),
'Section',
SnippetParam(name='section_label', repeat=True),
SnippetParam(name='section_sortorder',
regex_validator=r'^\d+$',
error_message='Only numeric value',
repeat=True),
SnippetParam(name='section_show_in_website',
default=True,
yes_no=True,
repeat=True),
SnippetParam(name='section_show_in_store',
default=True,
yes_no=True,
repeat=True),
SnippetParam(name='section_show_in_default',
default=True,
yes_no=True,
repeat=True),
'Group',
SnippetParam(name='group_label', repeat=True),
SnippetParam(name='group_sortorder',
regex_validator=r'^\d+$',
error_message='Only numeric value',
repeat=True),
SnippetParam(name='group_show_in_website',
default=True,
yes_no=True,
repeat=True),
SnippetParam(name='group_show_in_store',
default=True,
yes_no=True,
repeat=True),
SnippetParam(name='group_show_in_default',
default=True,
yes_no=True,
repeat=True),
'Field',
SnippetParam(name='field_label'),
SnippetParam(name='field_comment'),
SnippetParam(name='field_default'),
SnippetParam(name='field_sortorder',
regex_validator=r'^\d+$',
error_message='Only numeric value'),
SnippetParam(name='field_show_in_website',
default=True,
yes_no=True),
SnippetParam(name='field_show_in_store', default=True,
yes_no=True),
SnippetParam(name='field_show_in_default',
default=True,
yes_no=True),
SnippetParam(
name='field_backend_model',
regex_validator=r'^[\w\\]+$',
error_message=
'Only alphanumeric, underscore and backslash characters are allowed'
),
]
def params(cls):
return [
SnippetParam(name='language',
choises=cls.LANGUAGE_CHOISES,
default='en_US')
]
