This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Issue-8347 - added new product attribute documentation #8395
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
magento-engcom-team
added
Partner: EY
partners-contribution
added 3 commits
December 16, 2020 16:52
…dd-new-product-attribute-documentation
BarnyShergold
suggested changes
Jan 14, 2021
Contributor
BarnyShergold
left a comment
BarnyShergold
left a comment
There was a problem hiding this comment.
Great addition! Just a few formatting & punctuation suggestions
|
|
||
| ## Product Attribute Option Creation | ||
|
|
||
| A product attribute of type multiselect or select will present selectable options to the user. These options may be added manually through the admin panel, or by upgrade script. The script process is slightly different depending on whether the options are being added at the moment of attribute creation or whether the options are being added at a later time to an existing attribute. |
Contributor
There was a problem hiding this comment.
Suggested change
| A product attribute of type multiselect or select will present selectable options to the user. These options may be added manually through the admin panel, or by upgrade script. The script process is slightly different depending on whether the options are being added at the moment of attribute creation or whether the options are being added at a later time to an existing attribute. | |
| A product attribute of type multiselect or select will present selectable options to the user. These options may be added manually through the admin panel or by upgrade script. The script process is slightly different depending on whether the options are being added at the moment of attribute creation or whether the options are being added at a later time to an existing attribute. |
| Basic instructions for creating a product attribute by setup or upgrade script can be found [above](#CreateProductAttributeByUpgradeScript). Before scripting the attribute creation, pick one of these two use cases for your options: | ||
|
|
||
| * You want a set of options which cannot be modified by a user through the admin panel, and which can only be changed through a future code push. | ||
| * You want a set of options which can be modified, added, or deleted through the admin panel. |
Contributor
There was a problem hiding this comment.
Suggested change
| * You want a set of options which can be modified, added, or deleted through the admin panel. | |
| 1. You want a set of options which can be modified, added or deleted through the admin panel. |
|
|
||
| Basic instructions for creating a product attribute by setup or upgrade script can be found [above](#CreateProductAttributeByUpgradeScript). Before scripting the attribute creation, pick one of these two use cases for your options: | ||
|
|
||
| * You want a set of options which cannot be modified by a user through the admin panel, and which can only be changed through a future code push. |
Contributor
There was a problem hiding this comment.
Change to numbered as each are referred to this way further down
Suggested change
| * You want a set of options which cannot be modified by a user through the admin panel, and which can only be changed through a future code push. | |
| 1. You want a set of options which cannot be modified by a user through the admin panel and which can only be changed through a future code push. |
| * You want a set of options which cannot be modified by a user through the admin panel, and which can only be changed through a future code push. | ||
| * You want a set of options which can be modified, added, or deleted through the admin panel. | ||
|
|
||
| In the case of use case 1 (an 'immutable' set of options), follow the above instructions ["Add a source model"](#AddSourceModel). You will create a model that contains and dynamically returns the attribute's selectable options to the client. |
Contributor
There was a problem hiding this comment.
Suggested change
| In the case of use case 1 (an 'immutable' set of options), follow the above instructions ["Add a source model"](#AddSourceModel). You will create a model that contains and dynamically returns the attribute's selectable options to the client. | |
| For use case `1` (an 'immutable' set of options), follow the above instructions ["Add a source model"](#AddSourceModel). You will create a model that contains and dynamically returns the attribute's selectable options to the client. |
|
|
||
| In the case of use case 1 (an 'immutable' set of options), follow the above instructions ["Add a source model"](#AddSourceModel). You will create a model that contains and dynamically returns the attribute's selectable options to the client. | ||
|
|
||
| In use case 2 (a 'mutable' set of options), see ["EAV and extension attributes"]({{ site.baseurl }}/guides/v2.4/extension-dev-guide/attributes.html). Make sure to declare 'Magento\Eav\Model\Entity\Attribute\Source\Table' as the value for the 'source' attribute option. This ensures that Magento will store options in the appropriate database table. |
Contributor
There was a problem hiding this comment.
Suggested change
| In use case 2 (a 'mutable' set of options), see ["EAV and extension attributes"]({{ site.baseurl }}/guides/v2.4/extension-dev-guide/attributes.html). Make sure to declare 'Magento\Eav\Model\Entity\Attribute\Source\Table' as the value for the 'source' attribute option. This ensures that Magento will store options in the appropriate database table. | |
| For use case `2` (a 'mutable' set of options), see ["EAV and extension attributes"]({{ site.baseurl }}/guides/v2.4/extension-dev-guide/attributes.html). Make sure to declare 'Magento\Eav\Model\Entity\Attribute\Source\Table' as the value for the 'source' attribute option. This ensures that Magento will store options in the appropriate database table. |
| In use case 2 (a 'mutable' set of options), see ["EAV and extension attributes"]({{ site.baseurl }}/guides/v2.4/extension-dev-guide/attributes.html). Make sure to declare 'Magento\Eav\Model\Entity\Attribute\Source\Table' as the value for the 'source' attribute option. This ensures that Magento will store options in the appropriate database table. | ||
|
|
||
| With `\Magento\Eav\Setup\EavSetup.php::addAttribute()` and `\Magento\Eav\Setup\EavSetup.php::addAttributeOptions()` you can add a series of options with the following array: | ||
|
|
Contributor
There was a problem hiding this comment.
Would suggest enclosing the two array segments in ```php for formatting clarity
|
|
||
| 1. Assign an array of new options to a variable: | ||
|
|
||
| `$options = ['attribute_id' => null, 'values' => 'Option 1', 'Option 2', etc]];` |
Contributor
There was a problem hiding this comment.
Would suggest enclosing the three code segments in ```php for formatting clarity
m2-community-project
bot
added
Progress: changes requested
and removed
Progress: ready for review
labels
Contributor
|
@magento run all tests |
BarnyShergold
suggested changes
Jan 15, 2021
Contributor
BarnyShergold
left a comment
BarnyShergold
left a comment
There was a problem hiding this comment.
Please also check linting - it failed last time for some reason (not clear)
|
|
||
| With `\Magento\Eav\Setup\EavSetup.php::addAttribute()` and `\Magento\Eav\Setup\EavSetup.php::addAttributeOptions()` you can add a series of options with the following array: | ||
|
|
||
| ``` |
Contributor
There was a problem hiding this comment.
Suggested change
| ``` | |
| ```php |
|
|
||
| Alternatively, you may designate a specific option sorting order as follows: | ||
|
|
||
| ``` |
Contributor
There was a problem hiding this comment.
Suggested change
| ``` | |
| ```php |
|
|
||
| 1. Assign an array of new options to a variable: | ||
|
|
||
| ``` |
Contributor
There was a problem hiding this comment.
Suggested change
| ``` | |
| ```php |
|
|
||
| 1. Update your array with the attribute ID from the database: | ||
|
|
||
| ``` |
Contributor
There was a problem hiding this comment.
Suggested change
| ``` | |
| ```php |
|
|
||
| 1. Add your options: | ||
|
|
||
| ``` |
Contributor
There was a problem hiding this comment.
Suggested change
| ``` | |
| ```php |
Contributor
Author
|
Hi @BarnyShergold , is this good to be approved? |
BarnyShergold
approved these changes
Jan 20, 2021
m2-community-project
bot
added
Progress: approved
and removed
Progress: changes requested
labels
Contributor
Author
|
Hi @rogyar , is this good to be approved? |
dobooth
approved these changes
Jan 20, 2021
Contributor
|
running tests |
|
Hi @dineshvb, thank you for your contribution! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose of this pull request
This pull request (PR) covers #8347
Affected DevDocs pages
whatsnew
Added the 'Product Attribute Option Creation' section to the How to Add a New Product Attribute topic.