consolidation / output-formatters

src/FormatterOptions.php

Doc Comments +4 added lines

@@ -121,6 +121,10 @@
         return $this;
     }
 
+    /**
+     * @param string $key
+     * @param boolean $value
+     */
     public function setConfigurationDefault($key, $value)
     {
         if (!array_key_exists($key, $this->configurationData)) {

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Consolidation\OutputFormatters\Transformations\PropertyParser;
 use Consolidation\OutputFormatters\StructuredData\Xml\XmlSchema;
-use Consolidation\OutputFormatters\StructuredData\Xml\XmlSchemaInterface;
 
 /**
  * FormetterOptions holds information that affects the way a formatter

src/StructuredData/AssociativeList.php

Doc Comments +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
      * transformation object.
      *
      * @param FormatterOptions $options Options that affect output formatting.
-     * @return Consolidation\OutputFormatters\Transformations\TableTransformation
+     * @return TableTransformation
      */
     public function restructure(FormatterOptions $options)
     {

Unused Use Statements -3 removed lines

@@ -2,9 +2,6 @@
 namespace Consolidation\OutputFormatters\StructuredData;
 
 use Consolidation\OutputFormatters\FormatterOptions;
-use Consolidation\OutputFormatters\StructuredData\ListDataInterface;
-use Consolidation\OutputFormatters\Transformations\PropertyParser;
-use Consolidation\OutputFormatters\Transformations\ReorderFields;
 use Consolidation\OutputFormatters\Transformations\TableTransformation;
 
 /**

src/StructuredData/RowsOfFields.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
      * transformation object.
      *
      * @param FormatterOptions $options Options that affect output formatting.
-     * @return Consolidation\OutputFormatters\Transformations\TableTransformation
+     * @return \Consolidation\OutputFormatters\Transformations\TableTransformation
      */
     public function restructure(FormatterOptions $options)
     {

src/StructuredData/Xml/XmlSchema.php

Doc Comments +3 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) {

src/Transformations/DomToArraySimplifier.php

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 use Consolidation\OutputFormatters\SimplifyToArrayInterface;
 use Consolidation\OutputFormatters\FormatterOptions;
 use Consolidation\OutputFormatters\StructuredData\Xml\DomDataInterface;
-use Consolidation\OutputFormatters\StructuredData\Xml\XmlSchema;
 
 /**
  * Simplify a DOMDocument to an array.

Doc Comments +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
     }
 
     /**
-     * @param ReflectionClass $dataType
+     * @param \ReflectionClass $dataType
      */
     public function canSimplify(\ReflectionClass $dataType)
     {

src/Formatters/TsvFormatter.php

Spacing +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
     protected function tsvEscape($data)
     {
         return implode("\t", array_map(
-            function ($item) {
+            function($item) {
                 return str_replace(["\t", "\n"], ['\t', '\n'], $item);
             },
             $data

src/Formatters/StringFormatter.php

Unused Use Statements -1 removed lines

@@ -6,7 +6,6 @@
 use Consolidation\OutputFormatters\OverrideOptionsInterface;
 use Consolidation\OutputFormatters\FormatterOptions;
 use Symfony\Component\Console\Output\OutputInterface;
-use Consolidation\OutputFormatters\StructuredData\RestructureInterface;
 
 /**
  * String formatter

src/Transformations/ReorderFields.php

Spacing +1 added lines, -1 removed lines

@@ -67,7 +67,7 @@
         return
             array_filter(
                 array_keys($fieldLabels),
-                function ($key) use ($fieldRegex, $fieldLabels) {
+                function($key) use ($fieldRegex, $fieldLabels) {
                     $value = $fieldLabels[$key];
                     return preg_match($fieldRegex, $value) || preg_match($fieldRegex, $key);
                 }

src/FormatterManager.php

Doc Comments +4 added lines

@@ -260,6 +260,7 @@ 
 
     /**
      * Test to see if the stipulated format exists
+     * @param string $format
      */
     public function hasFormatter($format)
     {
@@ -335,6 +336,9 @@ 
         return $structuredOutput;
     }
 
+    /**
+     * @param \ReflectionClass $structuredOutput
+     */
     protected function canSimplifyToArray($structuredOutput)
     {
         foreach ($this->arraySimplifiers as $simplifier) {

Spacing +6 added lines, -6 removed lines

@@ -90,7 +90,7 @@ 
 
         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);
         }
 
@@ -99,7 +99,7 @@ 
             // We have fields; that implies 'table', unless someone says something different
             $defaultFormat = 'table';
 
-            $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);
         }
 
@@ -113,8 +113,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)
         );
@@ -210,10 +210,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);

Braces +1 added lines, -2 removed lines

@@ -135,8 +135,7 @@
             if (!empty($formatId) && $this->isValidFormatForSpecifiedDataType($formatter, $dataType)) {
                 $validFormats[] = $formatId;
                 $atLeastOneValidFormat = true;
-            }
-            elseif (!empty($formatId) && ($formatter instanceof ValidationInterface)) {
+            } elseif (!empty($formatId) && ($formatter instanceof ValidationInterface)) {
                 // A formatter that supports NO valid data types (e.g. the
                 // string formatter) can be used with any data type that
                 // is usable with at least one other data formatter.