Skip to content

Commit 36dd5ac

Browse files
Replace inheritdoc with full declaration
1 parent 28963fb commit 36dd5ac

File tree

1 file changed

+71
-20
lines changed

1 file changed

+71
-20
lines changed

app/code/Magento/Catalog/Model/Product/Option.php

Lines changed: 71 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,10 @@ public function __construct(
205205
}
206206

207207
/**
208-
* @inheritdoc
208+
* Get resource instance
209+
*
210+
* @return \Magento\Framework\Model\ResourceModel\Db\AbstractDb
211+
* @deprecated 101.1.0 because resource models should be used directly
209212
*/
210213
protected function _getResource()
211214
{
@@ -570,7 +573,9 @@ public function getSearchableData($productId, $storeId)
570573
}
571574

572575
/**
573-
* @inheritdoc
576+
* Clearing object's data
577+
*
578+
* @return $this
574579
*/
575580
protected function _clearData()
576581
{
@@ -580,7 +585,9 @@ protected function _clearData()
580585
}
581586

582587
/**
583-
* @inheritdoc
588+
* Clearing cyclic references
589+
*
590+
* @return $this
584591
*/
585592
protected function _clearReferences()
586593
{
@@ -601,7 +608,9 @@ protected function _getValidationRulesBeforeSave()
601608
}
602609

603610
/**
604-
* @inheritdoc
611+
* Get product SKU
612+
*
613+
* @return string
605614
*/
606615
public function getProductSku()
607616
{
@@ -613,7 +622,9 @@ public function getProductSku()
613622
}
614623

615624
/**
616-
* @inheritdoc
625+
* Get option id
626+
*
627+
* @return int|null
617628
* @codeCoverageIgnoreStart
618629
*/
619630
public function getOptionId()
@@ -622,47 +633,60 @@ public function getOptionId()
622633
}
623634

624635
/**
625-
* @inheritdoc
636+
* Get option title
637+
*
638+
* @return string
626639
*/
627640
public function getTitle()
628641
{
629642
return $this->_getData(self::KEY_TITLE);
630643
}
631644

632645
/**
633-
* @inheritdoc
646+
* Get option type
647+
*
648+
* @return string
634649
*/
635650
public function getType()
636651
{
637652
return $this->_getData(self::KEY_TYPE);
638653
}
639654

640655
/**
641-
* @inheritdoc
656+
* Get sort order
657+
*
658+
* @return int
642659
*/
643660
public function getSortOrder()
644661
{
645662
return $this->_getData(self::KEY_SORT_ORDER);
646663
}
647664

648665
/**
649-
* @inheritdoc
666+
* Get is require
667+
*
668+
* @return bool
669+
* @SuppressWarnings(PHPMD.BooleanGetMethodName)
650670
*/
651671
public function getIsRequire()
652672
{
653673
return $this->_getData(self::KEY_IS_REQUIRE);
654674
}
655675

656676
/**
657-
* @inheritdoc
677+
* Get price type
678+
*
679+
* @return string|null
658680
*/
659681
public function getPriceType()
660682
{
661683
return $this->_getData(self::KEY_PRICE_TYPE);
662684
}
663685

664686
/**
665-
* @inheritdoc
687+
* Get Sku
688+
*
689+
* @return string|null
666690
*/
667691
public function getSku()
668692
{
@@ -710,71 +734,98 @@ public function getImageSizeY()
710734
}
711735

712736
/**
713-
* @inheritdoc
737+
* Set product SKU
738+
*
739+
* @param string $productSku
740+
* @return $this
714741
*/
715742
public function setProductSku($productSku)
716743
{
717744
return $this->setData(self::KEY_PRODUCT_SKU, $productSku);
718745
}
719746

720747
/**
721-
* @inheritdoc
748+
* Set option id
749+
*
750+
* @param int $optionId
751+
* @return $this
722752
*/
723753
public function setOptionId($optionId)
724754
{
725755
return $this->setData(self::KEY_OPTION_ID, $optionId);
726756
}
727757

728758
/**
729-
* @inheritdoc
759+
* Set option title
760+
*
761+
* @param string $title
762+
* @return $this
730763
*/
731764
public function setTitle($title)
732765
{
733766
return $this->setData(self::KEY_TITLE, $title);
734767
}
735768

736769
/**
737-
* @inheritdoc
770+
* Set option type
771+
*
772+
* @param string $type
773+
* @return $this
738774
*/
739775
public function setType($type)
740776
{
741777
return $this->setData(self::KEY_TYPE, $type);
742778
}
743779

744780
/**
745-
* @inheritdoc
781+
* Set sort order
782+
*
783+
* @param int $sortOrder
784+
* @return $this
746785
*/
747786
public function setSortOrder($sortOrder)
748787
{
749788
return $this->setData(self::KEY_SORT_ORDER, $sortOrder);
750789
}
751790

752791
/**
753-
* @inheritdoc
792+
* Set is require
793+
*
794+
* @param bool $isRequired
795+
* @return $this
754796
*/
755797
public function setIsRequire($isRequired)
756798
{
757799
return $this->setData(self::KEY_IS_REQUIRE, $isRequired);
758800
}
759801

760802
/**
761-
* @inheritdoc
803+
* Set price
804+
*
805+
* @param float $price
806+
* @return $this
762807
*/
763808
public function setPrice($price)
764809
{
765810
return $this->setData(self::KEY_PRICE, $price);
766811
}
767812

768813
/**
769-
* @inheritdoc
814+
* Set price type
815+
*
816+
* @param string $priceType
817+
* @return $this
770818
*/
771819
public function setPriceType($priceType)
772820
{
773821
return $this->setData(self::KEY_PRICE_TYPE, $priceType);
774822
}
775823

776824
/**
777-
* @inheritdoc
825+
* Set Sku
826+
*
827+
* @param string $sku
828+
* @return $this
778829
*/
779830
public function setSku($sku)
780831
{

0 commit comments

Comments
 (0)