Skip to content

Commit

Permalink
Update the PHP docs for the $attribute_type and $input_type param…
Browse files Browse the repository at this point in the history
…eters in the `AttributesForm` class.

Address: #2151 (comment)
  • Loading branch information
eason9487 committed Dec 25, 2023
1 parent 466d83e commit 9ff6a97
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions src/Admin/Product/Attributes/AttributesForm.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class AttributesForm extends Form {
/**
* AttributesForm constructor.
*
* @param string[] $attribute_types
* @param string[] $attribute_types The names of the attribute classes extending AttributeInterface.
* @param array $data
*/
public function __construct( array $attribute_types, array $data = [] ) {
Expand Down Expand Up @@ -82,7 +82,7 @@ public function get_view_data(): array {
/**
* Get the hidden and visible types of an attribute's applicable product types.
*
* @param string $attribute_type An attribute class extending AttributeInterface
* @param string $attribute_type The name of an attribute class extending AttributeInterface.
*
* @return array
*/
Expand Down Expand Up @@ -147,8 +147,8 @@ public static function init_input( InputInterface $input, AttributeInterface $at
/**
* Add an attribute to the form
*
* @param string $attribute_type An attribute class extending AttributeInterface
* @param string|null $input_type An input class extending InputInterface to use for attribute input.
* @param string $attribute_type The name of an attribute class extending AttributeInterface.
* @param string|null $input_type The name of an input class extending InputInterface to use for attribute input.
*
* @return AttributesForm
*
Expand Down Expand Up @@ -177,7 +177,7 @@ public function add_attribute( string $attribute_type, ?string $input_type = nul
/**
* Remove an attribute from the form
*
* @param string $attribute_type An attribute class extending AttributeInterface
* @param string $attribute_type The name of an attribute class extending AttributeInterface.
*
* @return AttributesForm
*
Expand All @@ -197,8 +197,8 @@ public function remove_attribute( string $attribute_type ): AttributesForm {
/**
* Sets the input type for the given attribute.
*
* @param string $attribute_type
* @param string $input_type
* @param string $attribute_type The name of an attribute class extending AttributeInterface.
* @param string $input_type The name of an input class extending InputInterface to use for attribute input.
*
* @return $this
*
Expand Down

0 comments on commit 9ff6a97

Please sign in to comment.