consolidation / output-formatters

src/Formatters/TableFormatter.php

Doc Comments +1 added lines

@@ -123,6 +123,7 @@
 
     /**
      * Add our custom table style(s) to the table.
+     * @param Table $table
      */
     protected static function addCustomTableStyles($table)
     {

Unused Use Statements -2 removed lines

@@ -4,12 +4,10 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Helper\Table;
 use Symfony\Component\Console\Helper\TableStyle;
-
 use Consolidation\OutputFormatters\Validate\ValidDataTypesInterface;
 use Consolidation\OutputFormatters\Options\FormatterOptions;
 use Consolidation\OutputFormatters\Validate\ValidDataTypesTrait;
 use Consolidation\OutputFormatters\StructuredData\TableDataInterface;
-use Consolidation\OutputFormatters\Transformations\ReorderFields;
 use Consolidation\OutputFormatters\Exception\IncompatibleDataException;
 use Consolidation\OutputFormatters\Transformations\WordWrapper;
 

Spacing +2 added lines, -2 removed lines

@@ -89,7 +89,7 @@ 
             if (!empty($headers)) {
                 array_splice($headers, 1, 0, ':');
             }
-            $data = array_map(function ($item) {
+            $data = array_map(function($item) {
                 array_splice($item, 1, 0, ':');
                 return $item;
             }, $data);
@@ -116,7 +116,7 @@ 
         $wrapper = new WordWrapper($options->get(FormatterOptions::TERMINAL_WIDTH));
         $wrapper->setPaddingFromStyle($tableStyle);
         if (!empty($headers)) {
-            $headerLengths = array_map(function ($item) {
+            $headerLengths = array_map(function($item) {
                 return strlen($item);
             }, $headers);
             $wrapper->setMinimumWidths($headerLengths);

src/StructuredData/Xml/XmlSchema.php

Doc Comments +6 added lines

@@ -34,6 +34,9 @@ 
         $this->addXmlChildren($dom, $element, $elementName, $structuredData);
     }
 
+    /**
+     * @param \DOMElement $xmlParent
+     */
     protected function addXmlChildren(\DOMDocument $dom, $xmlParent, $elementName, $structuredData)
     {
         foreach ($structuredData as $key => $value) {
@@ -52,6 +55,9 @@ 
         $this->addXmlData($dom, $xmlParent, $elementName, $value);
     }
 
+    /**
+     * @param string $childElementName
+     */
     protected function determineElementName($key, $childElementName, $value)
     {
         if (is_numeric($key)) {

Spacing +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
             return $childElementName;
         }
         if (is_object($value)) {
-            $value = (array)$value;
+            $value = (array) $value;
         }
         if (!is_array($value)) {
             return $key;

src/FormatterManager.php

Spacing +6 added lines, -6 removed lines

@@ -111,13 +111,13 @@ 
 
         if (count($validFormats) > 1) {
             // Make an input option for --format
-            $description = 'Format the result data. Available formats: ' . implode(',', $validFormats);
+            $description = 'Format the result data. Available formats: '.implode(',', $validFormats);
             $automaticOptions[FormatterOptions::FORMAT] = new InputOption(FormatterOptions::FORMAT, '', InputOption::VALUE_OPTIONAL, $description, $defaultFormat);
         }
 
         if ($availableFields) {
             $defaultFields = $options->get(FormatterOptions::DEFAULT_FIELDS, [], '');
-            $description = 'Available fields: ' . implode(', ', $this->availableFieldsList($availableFields));
+            $description = 'Available fields: '.implode(', ', $this->availableFieldsList($availableFields));
             $automaticOptions[FormatterOptions::FIELDS] = new InputOption(FormatterOptions::FIELDS, '', InputOption::VALUE_OPTIONAL, $description, $defaultFields);
             $automaticOptions[FormatterOptions::FIELD] = new InputOption(FormatterOptions::FIELD, '', InputOption::VALUE_OPTIONAL, "Select just one field, and force format to 'string'.", '');
         }
@@ -132,8 +132,8 @@ 
     protected function availableFieldsList($availableFields)
     {
         return array_map(
-            function ($key) use ($availableFields) {
-                return $availableFields[$key] . " ($key)";
+            function($key) use ($availableFields) {
+                return $availableFields[$key]." ($key)";
             },
             array_keys($availableFields)
         );
@@ -197,10 +197,10 @@ 
      */
     public function write(OutputInterface $output, $format, $structuredOutput, FormatterOptions $options)
     {
-        $formatter = $this->getFormatter((string)$format);
+        $formatter = $this->getFormatter((string) $format);
         if (!is_string($structuredOutput) && !$this->isValidFormat($formatter, $structuredOutput)) {
             $validFormats = $this->validFormats($structuredOutput);
-            throw new InvalidFormatException((string)$format, $structuredOutput, $validFormats);
+            throw new InvalidFormatException((string) $format, $structuredOutput, $validFormats);
         }
         // Give the formatter a chance to override the options
         $options = $this->overrideOptions($formatter, $structuredOutput, $options);

src/Transformations/Wrap/ColumnWidths.php

Unused Use Statements -2 removed lines

@@ -1,8 +1,6 @@
 <?php
 namespace Consolidation\OutputFormatters\Transformations\Wrap;
 
-use Symfony\Component\Console\Helper\TableStyle;
-
 /**
  * Calculate column widths for table cells.
  *

Doc Comments +1 added lines

@@ -17,6 +17,7 @@
     /**
      * Given the total amount of available space, and the width of
      * the columns to place, calculate the optimum column widths to use.
+     * @param double $availableWidth
      */
     public function calculate($availableWidth, DataCellWidths $dataWidths, DataCellWidths $minimumWidths)
     {

src/Transformations/Wrap/DataCellWidths.php

Spacing +2 added lines, -2 removed lines

@@ -166,7 +166,7 @@ 
     {
         return array_reduce(
             $widths,
-            function ($carry, $item) {
+            function($carry, $item) {
                 return $carry + $item;
             }
         );
@@ -180,7 +180,7 @@ 
     protected static function longestWordLength($str)
     {
         $words = preg_split('#[ /-]#', $str);
-        $lengths = array_map(function ($s) {
+        $lengths = array_map(function($s) {
             return strlen($s);
         }, $words);
         return max($lengths);

Doc Comments +6 added lines

@@ -53,6 +53,9 @@ 
         }
     }
 
+    /**
+     * @param integer $paddingInEachCell
+     */
     public function paddingSpace(
         $paddingInEachCell,
         $extraPaddingAtEndOfLine = 0,
@@ -103,6 +106,7 @@ 
     /**
      * Need to think about the name of this function a bit.
      * Maybe second parameter is just a column count.
+     * @param double $availableWidth
      */
     public function adjustMinimumWidths($availableWidth, DataCellWidths $dataCellWidths)
     {
@@ -157,6 +161,7 @@ 
 
     /**
      * Return the length of the specified column.
+     * @return string
      */
     public function width($key)
     {
@@ -203,6 +208,7 @@ 
     /**
      * Ensure that every item in $widths that has a corresponding entry
      * in $minimumWidths is as least as large as the minimum value held there.
+     * @param DataCellWidths $minimumWidths
      */
     public function enforceMinimums($minimumWidths)
     {

Unused Use Statements -2 removed lines

@@ -1,8 +1,6 @@
 <?php
 namespace Consolidation\OutputFormatters\Transformations\Wrap;
 
-use Symfony\Component\Console\Helper\TableStyle;
-
 /**
  * Calculate the width of data in table cells in preparation for word wrapping.
  */