Merge pull request #1 from pronkoconsulting/coding-standards

Updated coding standards

Author: mcspronko

ViewModel/Videos.php

@@ -40,14 +40,16 @@ class Videos implements ArgumentInterface
     public function __construct(
         Json $serializer,
         Curl $curl,
-        $videosIds = []
+        array $videosIds = []
     ) {
         $this->serializer = $serializer;
         $this->curl = $curl;
         $this->videosIds = $videosIds;
     }
 
     /**
+     * Get video data
+     *
      * @param int $videoId
      * @return mixed
      */
@@ -69,7 +71,9 @@ private function getVideoData($videoId)
     }
 
     /**
-     * @param $duration
+     * Formats duration of a video
+     *
+     * @param int $duration
      * @return string
      */
     private function formatDuration($duration)
@@ -78,6 +82,8 @@ private function formatDuration($duration)
     }
 
     /**
+     * Get videos data in a json format
+     *
      * @return bool|string
      */
     public function getVideosDataJson()

composer.json

@@ -2,7 +2,6 @@
   "name": "pronko/get-started-videos",
   "description": "Learn Magento 2 management from admin",
   "type": "magento2-module",
-  "version": "1.0.0",
   "license": "proprietary",
   "authors": [
     {
@@ -26,5 +25,21 @@
     "psr-4": {
       "Pronko\\GetStartedVideos\\": ""
     }
+  },
+  "config": {
+    "allow-plugins": {
+      "magento/composer-dependency-version-audit-plugin": true
+    }
+  },
+  "require-dev": {
+    "magento/magento-coding-standard": "^26.0"
+  },
+  "scripts": {
+    "post-install-cmd": [
+      "([ $COMPOSER_DEV_MODE -eq 0 ] || vendor/bin/phpcs --config-set installed_paths ../../magento/magento-coding-standard/)"
+    ],
+    "post-update-cmd": [
+      "([ $COMPOSER_DEV_MODE -eq 0 ] || vendor/bin/phpcs --config-set installed_paths ../../magento/magento-coding-standard/)"
+    ]
   }
-}
+}

view/adminhtml/templates/get_started.phtml

@@ -38,7 +38,11 @@ $videosJsonData = $viewModel->getVideosDataJson();
                 <h3 data-bind="text: video.title"></h3>
             </div>
             <div class="video-container">
-                <iframe class="video-frame" data-bind="attr:{src: video.url}" width="600" height="300" frameborder="0" allowfullscreen></iframe>
+                <iframe class="video-frame"
+                        data-bind="attr:{src: video.url}"
+                        width="600"
+                        height="300" frameborder="0"
+                        allowfullscreen></iframe>
             </div>
         </div>
         <!--/ko-->
@@ -50,14 +54,14 @@ $videosJsonData = $viewModel->getVideosDataJson();
                 "components": {
                     "get-started-component": {
                         "component": "Pronko_GetStartedVideos/js/get-started-component",
-                        "videosData": <?= $videosJsonData ?>
+                        "videosData": <?= /** @noEscape */ $videosJsonData ?>
                     },
                     "video-modal-component": {
                         "component": "Pronko_GetStartedVideos/js/video-modal-component",
-                        "videosData": <?= $videosJsonData ?>
+                        "videosData": <?= /** @noEscape */ $videosJsonData ?>
                     }
                 }
               }
         }
     }
-</script>
+</script>