MAGETWO-92163: Redundancy in Custom Option Filenames

Author: roman

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

@@ -6,9 +6,14 @@
 
 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()

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

@@ -14,6 +14,8 @@
 use Magento\Framework\App\ObjectManager;
 
 /**
+ * Validator class. Represents logic for validation file given from product option
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class ValidatorFile extends Validator
@@ -70,6 +72,8 @@ class ValidatorFile extends Validator
     private $random;
 
     /**
+     * Constructor method
+     *
      * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
      * @param \Magento\Framework\Filesystem $filesystem
      * @param \Magento\Framework\File\Size $fileSize
@@ -96,6 +100,8 @@ public function __construct(
     }
 
     /**
+     * Setter method for the product
+     *
      * @param Product $product
      * @return $this
      */
@@ -106,6 +112,8 @@ public function setProduct(Product $product)
     }
 
     /**
+     * Validation method
+     *
      * @param \Magento\Framework\DataObject $processingParams
      * @param \Magento\Catalog\Model\Product\Option $option
      * @return array
@@ -253,6 +261,8 @@ protected function initFilesystem()
     }
 
     /**
+     * Validate contents length method
+     *
      * @return bool
      * @todo need correctly name
      */

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

@@ -37,6 +37,8 @@ class ValidatorInfo extends Validator
     protected $fileRelativePath;
 
     /**
+     * Construct method
+     *
      * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
      * @param \Magento\Framework\Filesystem $filesystem
      * @param \Magento\Framework\File\Size $fileSize
@@ -56,6 +58,8 @@ public function __construct(
     }
 
     /**
+     * Setter method for property "useQuotePath"
+     *
      * @param mixed $useQuotePath
      * @return $this
      */
@@ -66,6 +70,8 @@ public function setUseQuotePath($useQuotePath)
     }
 
     /**
+     * Validate method for the option value depends on an option
+     *
      * @param array $optionValue
      * @param \Magento\Catalog\Model\Product\Option $option
      * @return bool
@@ -112,6 +118,8 @@ public function validate($optionValue, $option)
     }
 
     /**
+     * Method for creation secret key for the given file
+     *
      * @param string $fileRelativePath
      * @return string
      */
@@ -121,6 +129,8 @@ protected function buildSecretKey($fileRelativePath)
     }
 
     /**
+     * Calculates path for the file
+     *
      * @param array $optionValue
      * @return void
      */

app/code/Magento/Sales/Model/Download.php

@@ -8,6 +8,9 @@
 use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\Exception\LocalizedException;
 
+/**
+ * Class Download. Represents download logic for files
+ */
 class Download
 {
     /**
@@ -36,6 +39,8 @@ class Download
     protected $rootDirBasePath;
 
     /**
+     * Constructor method
+     *
      * @param \Magento\Framework\Filesystem $filesystem
      * @param \Magento\MediaStorage\Helper\File\Storage\Database $fileStorageDatabase
      * @param \Magento\MediaStorage\Model\File\Storage\DatabaseFactory $storageDatabaseFactory
@@ -84,6 +89,8 @@ public function downloadFile($info)
     }
 
     /**
+     * Method checks, if file can be returned depends on the given filepath
+     *
      * @param string $relativePath
      * @return bool
      */

app/code/Magento/Wishlist/Controller/Index/DownloadCustomOption.php

@@ -11,6 +11,9 @@
 use Magento\Framework\Controller\ResultFactory;
 use Magento\Framework\Serialize\Serializer\Json;
 
+/**
+ * Class DownloadCustomOption. Represents request-flow logic for option's file download
+ */
 class DownloadCustomOption extends \Magento\Wishlist\Controller\AbstractIndex
 {
     /**
@@ -26,6 +29,8 @@ class DownloadCustomOption extends \Magento\Wishlist\Controller\AbstractIndex
     private $json;
 
     /**
+     * Constructor method
+     *
      * @param Action\Context $context
      * @param \Magento\Framework\App\Response\Http\FileFactory $fileResponseFactory
      * @param Json|null $json