Skip to content

Replace Validate:: method names with Symfony Constraint objects in demoextrafield #251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jeremie-Kiwik wants to merge 1 commit into
base: master
Choose a base branch
from
+27 −19
Open

Replace Validate:: method names with Symfony Constraint objects in demoextrafield #251

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 27 additions & 19 deletions demoextrafield/demoextrafield.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

declare(strict_types=1);

use PrestaShop\PrestaShop\Core\ConstraintValidator\Constraints\CleanHtml;
use PrestaShop\PrestaShop\Core\ConstraintValidator\Constraints\TypedRegex;
use PrestaShop\PrestaShop\Core\ExtraProperty\Definition\ExtraPropertyDefinition;
use PrestaShop\PrestaShop\Core\ExtraProperty\Definition\ExtraPropertyScope;
use PrestaShop\PrestaShop\Core\ExtraProperty\Definition\ExtraPropertySqlIndex;
Expand All @@ -22,6 +24,12 @@
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\Extension\Core\Type\UrlType;
use Symfony\Component\Validator\Constraints\Date;
use Symfony\Component\Validator\Constraints\Json;
use Symfony\Component\Validator\Constraints\NotBlank;
use Symfony\Component\Validator\Constraints\PositiveOrZero;
use Symfony\Component\Validator\Constraints\Regex;
use Symfony\Component\Validator\Constraints\Url;

if (!defined('_PS_VERSION_')) {
exit;
Expand Down Expand Up @@ -81,7 +89,6 @@ public function install(): bool
associatedForms: ['product:options.suppliers:before'],
associatedGrids: ['product:reference'],
formFieldType: SwitchType::class,
validator: 'isBool',
labelWording: 'Dangerous product',
labelDomain: self::TRANSLATION_DOMAIN,
descriptionWording: 'Indicates whether the product is dangerous',
Expand All @@ -106,7 +113,7 @@ public function install(): bool
associatedApis: ['/products', '/products/{productId}'],
associatedForms: ['product'],
formFieldType: UrlType::class,
validator: 'isUrl',
constraints: [new Url()],
labelWording: 'Video link',
labelDomain: self::TRANSLATION_DOMAIN,
descriptionWording: 'Video URL per language',
Expand All @@ -132,7 +139,7 @@ public function install(): bool
associatedForms: ['product'],
associatedGrids: ['product:final_price_tax_excluded:before'],
formFieldType: DatePickerType::class,
validator: 'isDate',
constraints: [new Date()],
labelWording: 'Custom date',
labelDomain: self::TRANSLATION_DOMAIN,
descriptionWording: 'Custom date per shop',
Expand Down Expand Up @@ -172,9 +179,10 @@ public function install(): bool
// Product (common) : packaging_type
// Demonstrates: CHOICE type, enumValues, formOptions (dropdown choices).
// enumValues constrains the allowed DB values; formOptions drives the Symfony ChoiceType widget.
// formRequired: false + nullable: true + placeholder → the "—" option represents "no selection";
// required: false + nullable: true + placeholder → the "—" option represents "no selection";
// the field can be left empty and the empty value passes server-side validation.
// (For a truly required field, omit the placeholder and set formRequired: true — NotBlank is added automatically.)
// (For a truly required field, omit the placeholder, set required: true, AND pass an explicit
// NotBlank constraint — "required" only drives the HTML/OpenAPI flag, it never validates by itself.)
$productPackagingTypeRegistered = $this->registerExtraProperty(
new ExtraPropertyDefinition(
entityName: 'product',
Expand All @@ -184,7 +192,7 @@ public function install(): bool
enumValues: ['standard', 'gift', 'bulk'],
defaultValue: null,
nullable: true,
formRequired: false,
required: false,
associatedApis: ['/products', '/products/{productId}'],
displayFront: true,
associatedForms: ['product'],
Expand Down Expand Up @@ -215,23 +223,23 @@ enumValues: ['standard', 'gift', 'bulk'],
*/

// Category (common) : theme_color
// Demonstrates: formRequired: true → the form modifier automatically adds a NotBlank
// constraint at build time (server-side enforcement, not just the HTML required attribute).
// No need to put constraints in formOptions — formOptions is persisted as JSON and cannot
// hold Constraint objects.
// Demonstrates: required: true only drives the HTML required attribute and the Admin API
// (OpenAPI) schema — it never adds server-side validation by itself. A real NotBlank
// constraint is passed explicitly below for actual enforcement, alongside a Regex
// reproducing the legacy hex-or-named-color format check.
$categoryThemeColorRegistered = $this->registerExtraProperty(
new ExtraPropertyDefinition(
entityName: 'category',
propertyName: 'theme_color',
type: ExtraPropertyType::STRING,
scope: ExtraPropertyScope::COMMON,
nullable: true,
formRequired: true,
required: true,
associatedApis: ['/categories', '/categories/{categoryId}'],
associatedForms: ['category', 'root_category'],
associatedGrids: ['category'],
formFieldType: ColorType::class,
validator: 'isColor',
constraints: [new NotBlank(), new Regex(['pattern' => '/^(#[0-9a-fA-F]{6}|[a-zA-Z0-9-]*)$/'])],
labelWording: 'Theme color',
labelDomain: self::TRANSLATION_DOMAIN,
descriptionWording: 'Color associated with the category (required)',
Expand Down Expand Up @@ -259,7 +267,7 @@ enumValues: ['standard', 'gift', 'bulk'],
displayFront: false,
associatedForms: ['category'],
formFieldType: FormattedTextareaType::class,
validator: 'isCleanHtml',
constraints: [new CleanHtml()],
labelWording: 'Marketing note',
labelDomain: self::TRANSLATION_DOMAIN,
descriptionWording: 'Merchant-only note displayed in BO and API — never on the front office',
Expand Down Expand Up @@ -288,7 +296,7 @@ enumValues: ['standard', 'gift', 'bulk'],
'label_tag_name' => null,
],
// This prevents using a h3 tag for label
validator: 'isUnsignedId',
constraints: [new PositiveOrZero()],
labelWording: 'Default supplier',
labelDomain: self::TRANSLATION_DOMAIN,
descriptionWording: 'Select a PrestaShop supplier',
Expand Down Expand Up @@ -317,7 +325,7 @@ enumValues: ['standard', 'gift', 'bulk'],
associatedForms: ['customer'],
associatedGrids: ['customer'],
formFieldType: MoneyType::class,
validator: 'isPrice',
constraints: [new PositiveOrZero()],
labelWording: 'Credit limit',
labelDomain: self::TRANSLATION_DOMAIN,
descriptionWording: 'Maximum customer credit amount',
Expand All @@ -341,7 +349,7 @@ enumValues: ['standard', 'gift', 'bulk'],
associatedApis: ['/customers', '/customers/{customerId}'],
associatedForms: ['customer'],
formFieldType: TextareaType::class,
validator: 'isJson',
constraints: [new Json()],
labelWording: 'Metadata JSON',
labelDomain: self::TRANSLATION_DOMAIN,
descriptionWording: 'Free JSON for customer metadata',
Expand Down Expand Up @@ -412,7 +420,7 @@ enumValues: ['standard', 'gift', 'bulk'],
associatedApis: ['/addresses', '/addresses/{addressId}', '/addresses/manufacturers/{addressId}'],
associatedGrids: ['manufacturer_address:city'],
formFieldType: TextareaType::class,
validator: 'isGenericName',
constraints: [new TypedRegex(['type' => TypedRegex::TYPE_GENERIC_NAME])],
labelWording: 'Delivery note',
labelDomain: self::TRANSLATION_DOMAIN,
descriptionWording: 'Free delivery note attached to this address',
Expand Down Expand Up @@ -447,7 +455,7 @@ enumValues: ['standard', 'gift', 'bulk'],
type: ExtraPropertyType::STRING,
scope: ExtraPropertyScope::LANG,
nullable: true,
validator: 'isGenericName',
constraints: [new TypedRegex(['type' => TypedRegex::TYPE_GENERIC_NAME])],
labelWording: 'Promo banner',
labelDomain: self::TRANSLATION_DOMAIN,
descriptionWording: 'Translated promotional text displayed on the CMS page',
Expand All @@ -468,7 +476,7 @@ enumValues: ['standard', 'gift', 'bulk'],
type: ExtraPropertyType::STRING,
scope: ExtraPropertyScope::COMMON,
nullable: true,
validator: 'isGenericName',
constraints: [new TypedRegex(['type' => TypedRegex::TYPE_GENERIC_NAME])],
labelWording: 'Revision code',
labelDomain: self::TRANSLATION_DOMAIN,
descriptionWording: 'Internal revision code displayed on the CMS page',
Expand Down