Merge remote-tracking branch 'upstream/2.3.0-release' into MAGETWO-95654

Author: joanhe

app/code/Magento/Catalog/Model/FilterProductCustomAttribute.php

@@ -27,11 +27,12 @@ public function __construct(array $blackList = [])
 
     /**
      * Delete custom attribute
-     * @param array $attributes
+     *
+     * @param array $attributes set objects attributes @example ['attribute_code'=>'attribute_object']
      * @return array
      */
     public function execute(array $attributes): array
     {
-        return array_diff($attributes, $this->blackList);
+        return array_diff_key($attributes, array_flip($this->blackList));
     }
 }

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

@@ -498,21 +498,26 @@ protected function _getResource()
     }
 
     /**
-     * Get a list of custom attribute codes that belongs to product attribute set. If attribute set not specified for
-     * product will return all product attribute codes
+     * Get a list of custom attribute codes that belongs to product attribute set.
+     *
+     * If attribute set not specified for product will return all product attribute codes
      *
      * @return string[]
      */
     protected function getCustomAttributesCodes()
     {
         if ($this->customAttributesCodes === null) {
-            $this->customAttributesCodes = array_keys($this->eavConfig->getEntityAttributes(
-                self::ENTITY,
-                $this
-            ));
-
-            $this->customAttributesCodes = $this->filterCustomAttribute->execute($this->customAttributesCodes);
-            $this->customAttributesCodes = array_diff($this->customAttributesCodes, ProductInterface::ATTRIBUTES);
+            $this->customAttributesCodes = array_diff(
+                array_keys(
+                    $this->filterCustomAttribute->execute(
+                        $this->eavConfig->getEntityAttributes(
+                            self::ENTITY,
+                            $this
+                        )
+                    )
+                ),
+                ProductInterface::ATTRIBUTES
+            );
         }
 
         return $this->customAttributesCodes;
@@ -584,8 +589,9 @@ public function getPrice()
     }
 
     /**
-     * @codeCoverageIgnoreStart
      * Get visibility status
+     *
+     * @codeCoverageIgnoreStart
      * @see \Magento\Catalog\Model\Product\Visibility
      *
      * @return int
@@ -662,6 +668,7 @@ public function getStatus()
 
     /**
      * Retrieve type instance of the product.
+     *
      * Type instance implements product type depended logic and is a singleton shared by all products of the same type.
      *
      * @return \Magento\Catalog\Model\Product\Type\AbstractType
@@ -822,9 +829,10 @@ public function getStoreIds()
 
     /**
      * Retrieve product attributes
-     * if $groupId is null - retrieve all product attributes
      *
-     * @param int  $groupId   Retrieve attributes of the specified group
+     * If $groupId is null - retrieve all product attributes
+     *
+     * @param int $groupId Retrieve attributes of the specified group
      * @param bool $skipSuper Not used
      * @return \Magento\Eav\Model\Entity\Attribute\AbstractAttribute[]
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
@@ -916,6 +924,7 @@ public function beforeSave()
 
     /**
      * Check/set if options can be affected when saving product
+     *
      * If value specified, it will be set.
      *
      * @param   bool $value
@@ -1036,9 +1045,11 @@ public function reindex()
 
     /**
      * Clear cache related with product and protect delete from not admin
+     *
      * Register indexing event before delete product
      *
      * @return \Magento\Catalog\Model\Product
+     * @throws \Magento\Framework\Exception\LocalizedException
      */
     public function beforeDelete()
     {
@@ -1545,12 +1556,12 @@ public function hasGalleryAttribute()
     /**
      * Add image to media gallery
      *
-     * @param string        $file              file path of image in file system
-     * @param string|array  $mediaAttribute    code of attribute with type 'media_image',
-     *                                          leave blank if image should be only in gallery
-     * @param boolean       $move              if true, it will move source file
-     * @param boolean       $exclude           mark image as disabled in product page view
+     * @param string $file file path of image in file system
+     * @param string|array $mediaAttribute code of type 'media_image', leave blank if image should be only in gallery
+     * @param boolean $move if true, it will move source file
+     * @param boolean $exclude mark image as disabled in product page view
      * @return \Magento\Catalog\Model\Product
+     * @throws \Magento\Framework\Exception\LocalizedException
      */
     public function addImageToMediaGallery($file, $mediaAttribute = null, $move = false, $exclude = true)
     {
@@ -1711,7 +1722,6 @@ public function getIsSalable()
 
     /**
      * Check is a virtual product
-     * Data helper wrapper
      *
      * @return bool
      */
@@ -1804,8 +1814,8 @@ public function formatUrlKey($str)
      * Save current attribute with code $code and assign new value
      *
      * @param string $code  Attribute code
-     * @param mixed  $value New attribute value
-     * @param int    $store Store ID
+     * @param mixed $value New attribute value
+     * @param int $store Store ID
      * @return void
      */
     public function addAttributeUpdate($code, $value, $store)
@@ -1875,6 +1885,7 @@ public function getRequestPath()
 
     /**
      * Custom function for other modules
+     *
      * @return string
      */
     public function getGiftMessageAvailable()
@@ -1993,6 +2004,8 @@ public function getOptions()
     }
 
     /**
+     * Set options for product
+     *
      * @param \Magento\Catalog\Api\Data\ProductCustomOptionInterface[] $options
      * @return $this
      */
@@ -2016,10 +2029,10 @@ public function getIsVirtual()
     /**
      * Add custom option information to product
      *
-     * @param   string $code    Option code
-     * @param   mixed  $value   Value of the option
-     * @param   int|Product    $product Product ID
-     * @return  $this
+     * @param string $code Option code
+     * @param mixed $value Value of the option
+     * @param int|Product $product Product ID
+     * @return $this
      */
     public function addCustomOption($code, $value, $product = null)
     {
@@ -2213,6 +2226,7 @@ public function getPreconfiguredValues()
 
     /**
      * Prepare product custom options.
+     *
      * To be sure that all product custom options does not has ID and has product instance
      *
      * @return \Magento\Catalog\Model\Product
@@ -2547,17 +2561,17 @@ public function setTypeId($typeId)
     }
 
     /**
-     * {@inheritdoc}
+     * Retrieve existing extension attributes object or create a new one.
      *
-     * @return \Magento\Catalog\Api\Data\ProductExtensionInterface
+     * @return \Magento\Framework\Api\ExtensionAttributesInterface
      */
     public function getExtensionAttributes()
     {
         return $this->_getExtensionAttributes();
     }
 
     /**
-     * {@inheritdoc}
+     * Set an extension attributes object.
      *
      * @param \Magento\Catalog\Api\Data\ProductExtensionInterface $extensionAttributes
      * @return $this
@@ -2570,8 +2584,11 @@ public function setExtensionAttributes(\Magento\Catalog\Api\Data\ProductExtensio
     //@codeCoverageIgnoreEnd
 
     /**
+     * Convert to media gallery interface
+     *
      * @param array $mediaGallery
      * @return \Magento\Catalog\Api\Data\ProductAttributeMediaGalleryEntryInterface[]
+     * @throws \Magento\Framework\Exception\LocalizedException
      */
     protected function convertToMediaGalleryInterface(array $mediaGallery)
     {
@@ -2587,7 +2604,10 @@ protected function convertToMediaGalleryInterface(array $mediaGallery)
     }
 
     /**
+     * Get media gallery entries
+     *
      * @return \Magento\Catalog\Api\Data\ProductAttributeMediaGalleryEntryInterface[]|null
+     * @throws \Magento\Framework\Exception\LocalizedException
      */
     public function getMediaGalleryEntries()
     {
@@ -2601,8 +2621,11 @@ public function getMediaGalleryEntries()
     }
 
     /**
+     * Set media gallery entries
+     *
      * @param ProductAttributeMediaGalleryEntryInterface[] $mediaGalleryEntries
      * @return $this
+     * @throws \Magento\Framework\Exception\LocalizedException
      */
     public function setMediaGalleryEntries(array $mediaGalleryEntries = null)
     {
@@ -2643,6 +2666,8 @@ public function setId($value)
     }
 
     /**
+     * Get link repository
+     *
      * @return ProductLinkRepositoryInterface
      */
     private function getLinkRepository()
@@ -2655,6 +2680,8 @@ private function getLinkRepository()
     }
 
     /**
+     * Get media gallery processor
+     *
      * @return Product\Gallery\Processor
      */
     private function getMediaGalleryProcessor()

app/code/Magento/Catalog/Model/Product/Option/Type/File/ExistingValidate.php

@@ -0,0 +1,52 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\Catalog\Model\Product\Option\Type\File;
+
+/**
+ * Validator for existing (already saved) files.
+ */
+class ExistingValidate extends \Zend_Validate
+{
+    /**
+     * @inheritDoc
+     *
+     * @param string $value File's full path.
+     * @param string|null $originalName Original file's name (when uploaded).
+     */
+    public function isValid($value, string $originalName = null)
+    {
+        $this->_messages = [];
+        $this->_errors = [];
+
+        if (!is_string($value)) {
+            $this->_messages[] = __('Full file path is expected.')->render();
+            return false;
+        }
+
+        $result = true;
+        $fileInfo = null;
+        if ($originalName) {
+            $fileInfo = ['name' => $originalName];
+        }
+        foreach ($this->_validators as $element) {
+            $validator = $element['instance'];
+            if ($validator->isValid($value, $fileInfo)) {
+                continue;
+            }
+            $result = false;
+            $messages = $validator->getMessages();
+            $this->_messages = array_merge($this->_messages, $messages);
+            $this->_errors = array_merge($this->_errors, array_keys($messages));
+            if ($element['breakChainOnFailure']) {
+                break;
+            }
+        }
+        return $result;
+    }
+}

app/code/Magento/Catalog/Model/Product/Option/Type/File/ValidateFactory.php

@@ -6,13 +6,18 @@
 
 namespace Magento\Catalog\Model\Product\Option\Type\File;
 
+/**
+ * Class ValidateFactory. Creates Validator with type "ExistingValidate"
+ */
 class ValidateFactory
 {
     /**
+     * Main factory method
+     *
      * @return \Zend_Validate
      */
     public function create()
     {
-        return new \Zend_Validate();
+        return new ExistingValidate();
     }
 }