IBX-9147: Symbol attribute type described in Developer Documentation - v5.0

[julitafalcondusza]

Question	Answer
JIRA Ticket	(https://issues.ibexa.co/browse/IBX-9147)
Versions	5.0
Edition	All

Symbol attribute type described in Developer Documentation - v5.0

Checklist

• Text renders correctly
• Text has been checked with vale
• Description metadata is up to date
• Code samples are working
• PHP code samples have been fixed with PHP CS fixer
• Added link to this PR in relevant JIRA ticket or code PR

[github-actions]

Preview of modified files

Preview of modified Markdown:

• docs/pim/attributes/symbol_attribute_type.md
• docs/search/criteria_reference/product_search_criteria.md
• docs/search/criteria_reference/symbolattribute_criterion.md

[mnocon]

Text looks good, just one small thing: please add the Composer requirement for ibexa/product-catalog-symbol-attribute.

We have that for 4.6:
https://github.com/ibexa/documentation-developer/pull/2525/files#diff-d2ab9925cad7eac58e0ff4cc0d251a937ecf49e4b6bf57f8b95aab76648a9d34R74

The version constraint should be ~5.0.x-dev

[mnocon]

Thank you!

[github-actions]

code_samples/ change report

Before (on target branch)	After (in current PR)
code_samples/back_office/search/src/Query/SymbolAttributeTypeQuery.php	code_samples/back_office/search/src/Query/SymbolAttributeTypeQuery.php
	docs/search/criteria_reference/symbolattribute_criterion.md@18:``` php docs/search/criteria_reference/symbolattribute_criterion.md@19:[[= include_file('code_samples/back_office/search/src/Query/SymbolAttributeTypeQuery.php') =]] docs/search/criteria_reference/symbolattribute_criterion.md@20:``` 001⫶<?php declare(strict_types=1); 002⫶ 003⫶use Ibexa\Contracts\ProductCatalog\Values\Product\ProductQuery; 004⫶use Ibexa\Contracts\ProductCatalogSymbolAttribute\Search\Criterion\SymbolAttribute; 005⫶ 006⫶$query = new ProductQuery(); 007⫶$query->setFilter(new SymbolAttribute('ean', ['5023920187205'])); 008⫶/** @var \Ibexa\Contracts\ProductCatalog\ProductServiceInterface $productService */ 009⫶$results = $productService->findProducts($query);
code_samples/pim/Symbol/Format/Checksum/LuhnChecksum.php	code_samples/pim/Symbol/Format/Checksum/LuhnChecksum.php
	docs/pim/attributes/symbol_attribute_type.md@68:``` php docs/pim/attributes/symbol_attribute_type.md@69:[[= include_file('code_samples/pim/Symbol/Format/Checksum/LuhnChecksum.php') =]] docs/pim/attributes/symbol_attribute_type.md@70:``` 001⫶<?php 002⫶ 003⫶declare(strict_types=1); 004⫶ 005⫶namespace App\PIM\Symbol\Format\Checksum; 006⫶ 007⫶use Ibexa\Contracts\ProductCatalog\Values\AttributeDefinitionInterface; 008⫶use Ibexa\Contracts\ProductCatalogSymbolAttribute\Value\ChecksumInterface; 009⫶ 010⫶final class LuhnChecksum implements ChecksumInterface 011⫶{ 012⫶ public function validate(AttributeDefinitionInterface $attributeDefinition, string $value): bool 013⫶ { 014⫶ $digits = $this->getDigits($value); 015⫶ 016⫶ $count = count($digits); 017⫶ $total = 0; 018⫶ for ($i = $count - 2; $i >= 0; $i -= 2) { 019⫶ $digit = $digits[$i]; 020⫶ if ($i % 2 === 0) { 021⫶ $digit *= 2; 022⫶ } 023⫶ 024⫶ $total += $digit > 9 ? $digit - 9 : $digit; 025⫶ } 026⫶ 027⫶ $checksum = $digits[$count - 1]; 028⫶ 029⫶ return $total + $checksum === 0; 030⫶ } 031⫶ 032⫶ /** 033⫶ * Returns an array of digits from the given value (skipping any formatting characters). 034⫶ * 035⫶ * @return int[] 036⫶ */ 037⫶ private function getDigits(string $value): array 038⫶ { 039⫶ $chars = array_filter( 040⫶ str_split($value), 041⫶ static fn (string $char): bool => $char !== '-' 042⫶ ); 043⫶ 044⫶ return array_map('intval', array_values($chars)); 045⫶ } 046⫶}

Download colorized diff