locomotivemtl / charcoal-translation

src/Charcoal/Translation/ConfigurableTranslationTrait.php

Doc Comments +5 added lines, -5 removed lines

@@ -89,7 +89,7 @@ 
      *
      *     If an empty array is provided, the method should consider this a request
      *     to empty the languages store.
-     * @return MultilingualAwareInterface Chainable
+     * @return ConfigurableTranslationTrait Chainable
      */
     public function setLanguages(array $langs = [])
     {
@@ -103,7 +103,7 @@ 
      *
      * @uses   ConfigurableInterface::config()
      * @param  LanguageInterface|array|string $lang A language object or identifier.
-     * @return MultilingualAwareInterface Chainable
+     * @return ConfigurableTranslationTrait Chainable
      */
     public function addLanguage($lang)
     {
@@ -117,7 +117,7 @@ 
      *
      * @uses   ConfigurableInterface::config()
      * @param  LanguageInterface|string $lang A language object or identifier.
-     * @return MultilingualAwareInterface Chainable
+     * @return ConfigurableTranslationTrait Chainable
      */
     public function removeLanguage($lang)
     {
@@ -171,7 +171,7 @@ 
      *
      * @uses   ConfigurableInterface::config()
      * @param  LanguageInterface|string|null $lang A language object or identifier.
-     * @return MultilingualAwareInterface Chainable
+     * @return ConfigurableTranslationTrait Chainable
      */
     public function setDefaultLanguage($lang = null)
     {
@@ -204,7 +204,7 @@ 
      *
      * @uses   ConfigurableInterface::config()
      * @param  LanguageInterface|string|null $lang A language object or identifier.
-     * @return MultilingualAwareInterface Chainable
+     * @return ConfigurableTranslationTrait Chainable
      */
     public function setCurrentLanguage($lang = null)
     {

src/Charcoal/Translation/Script/CatalogScript.php

Doc Comments +3 added lines, -3 removed lines

@@ -853,7 +853,7 @@ 
     /**
      * Retrieve the default included paths to scan for translatable text.
      *
-     * @return array
+     * @return string[]
      */
     public function defaultIncludedPaths()
     {
@@ -964,7 +964,7 @@ 
     /**
      * Retrieve the supported output formats for the translations file.
      *
-     * @return array
+     * @return string[]
      */
     public function outputFormats()
     {
@@ -1167,7 +1167,7 @@ 
     /**
      * Retrieve the language of the source code.
      *
-     * @return array|null
+     * @return string|null
      */
     public function sourceLanguage()
     {

Indentation +1 added lines, -1 removed lines

@@ -674,7 +674,7 @@
                     'longPrefix'   => 'max-depth',
                     'castTo'       => 'int',
                     'description'  => 'Descend at most the given number of levels of directories. '.
-                                      'A negative value means no limit.',
+                                        'A negative value means no limit.',
                     'defaultValue' => static::DEFAULT_MAX_DEPTH,
                     'prompt'       => 'Scan Depth (of directories)',
                     'acceptValue'  => function ($response) {

Spacing +11 added lines, -11 removed lines

@@ -523,7 +523,7 @@ 
                 } else {
                     $messages[$id] = [
                         'translations' => [],
-                        'context'      => [ $context ],
+                        'context'      => [$context],
                         'status'       => 'new'
                     ];
                 }
@@ -600,7 +600,7 @@ 
             sprintf(
                 'Supported source types are: %1$s; received %2$s'.
                 'Unsupported file type "%1$s". Must be one of %2$s',
-                implode(', ', [ 'mustache', 'php' ]),
+                implode(', ', ['mustache', 'php']),
                 (is_object($type) ? get_class($type) : gettype($type))
             )
         );
@@ -621,7 +621,7 @@ 
         static $arguments;
 
         if ($arguments === null) {
-            $validateLanguages = function ($response) {
+            $validateLanguages = function($response) {
                 if (strlen($response) === 0) {
                     return true;
                 }
@@ -637,7 +637,7 @@ 
             };
             $validateLanguages = $validateLanguages->bindTo($this);
 
-            $validatePaths = function ($response) {
+            $validatePaths = function($response) {
                 if (strlen($response) === 0) {
                     return true;
                 }
@@ -653,7 +653,7 @@ 
             };
             $validatePaths = $validatePaths->bindTo($this);
 
-            $validateCatalog = function ($response) {
+            $validateCatalog = function($response) {
                 if (strlen($response) === 0) {
                     return true;
                 }
@@ -677,7 +677,7 @@ 
                                       'A negative value means no limit.',
                     'defaultValue' => static::DEFAULT_MAX_DEPTH,
                     'prompt'       => 'Scan Depth (of directories)',
-                    'acceptValue'  => function ($response) {
+                    'acceptValue'  => function($response) {
                         return (strlen($response) === 0) || is_numeric($response);
                     }
                 ],
@@ -688,7 +688,7 @@ 
                     'description'  => 'Specify an alternate base path.',
                     'defaultValue' => $this->basePath(),
                     'prompt'       => 'Base Path',
-                    'acceptValue'  => function ($response) {
+                    'acceptValue'  => function($response) {
                         return (strlen($response) === 0) || is_dir($response);
                     }
                 ],
@@ -968,7 +968,7 @@ 
      */
     public function outputFormats()
     {
-        return [ 'csv' ];
+        return ['csv'];
     }
 
     /**
@@ -1220,7 +1220,7 @@ 
         $languages = [];
 
         $r = 0;
-        $blank = [ null ];
+        $blank = [null];
         // @codingStandardsIgnoreStart
         while (($row = fgetcsv($file)) !== false) {
             // @codingStandardsIgnoreEnd
@@ -1308,7 +1308,7 @@ 
         fputcsv($file, $this->csvHeaderRow());
 
         foreach ($messages as $id => $entry) {
-            $row = [ $id ];
+            $row = [$id];
             foreach ($languages as $lang) {
                 if (isset($entry['translations'][$lang])) {
                     $row[] = $entry['translations'][$lang];
@@ -1387,7 +1387,7 @@ 
         static $columns;
 
         if ($columns === null) {
-            $columns   = [ 'source' ];
+            $columns   = ['source'];
             $languages = $this->languages();
             foreach ($languages as $lang) {
                 $columns[] = $lang;

src/Charcoal/Translation/Catalog/ResourceRepository.php

Spacing +4 added lines, -4 removed lines

@@ -68,7 +68,7 @@ 
      *
      * @var array
      */
-    protected $supportedFormats = [ 'ini', 'csv', 'json', 'php', 'yaml', 'yml' ];
+    protected $supportedFormats = ['ini', 'csv', 'json', 'php', 'yaml', 'yml'];
 
     /**
      * A list of available file formats.
@@ -293,7 +293,7 @@ 
         $directory = new RecursiveDirectoryIterator($path);
         $filter    = new RecursiveCallbackFilterIterator(
             $directory,
-            function ($current, $key, $iterator) {
+            function($current, $key, $iterator) {
                 $filename = $current->getFilename();
                 if (preg_match('!^(\.\w+|\.$|\.\.$)!i', $filename)) {
                     return false;
@@ -386,7 +386,7 @@ 
     protected function createTranslationCatalog()
     {
         $catalogClass = $this->catalogClass();
-        $catalog   = new $catalogClass;
+        $catalog = new $catalogClass;
 
         if (!$catalog instanceof CatalogInterface) {
             throw new RuntimeException(
@@ -439,7 +439,7 @@ 
     public function createTranslationResource()
     {
         $resourceClass = $this->resourceClass();
-        $resource   = new $resourceClass;
+        $resource = new $resourceClass;
 
         if (!$resource instanceof ResourceInterface) {
             throw new RuntimeException(

src/Charcoal/Translation/Catalog/Resource.php

Spacing +3 added lines, -3 removed lines

@@ -122,7 +122,7 @@ 
         $messages  = [];
 
         $i = 0;
-        $blank = [ null ];
+        $blank = [null];
         // @codingStandardsIgnoreStart
         while (($data = fgetcsv($handle)) !== false) {
             // @codingStandardsIgnoreEnd
@@ -133,9 +133,9 @@ 
             if ($i === 0) {
                 $i++;
 
-                $source   = $data[0];
+                $source = $data[0];
                 $count   = count($data);
-                $context = $data[( $count-1 )];
+                $context = $data[($count - 1)];
 
                 /**
                  * Remove "ident" and "context" columns.

src/Charcoal/Translation/TranslationString.php

Doc Comments +4 added lines, -4 removed lines

@@ -194,7 +194,7 @@ 
     /**
      * Remove a translation value specified by an available language.
      *
-     * @param  LanguageInterface|string $lang A language object or identifier.
+     * @param  string $lang A language object or identifier.
      * @return self
      * @throws InvalidArgumentException If language is invalid.
      */
@@ -225,7 +225,7 @@ 
      * the translation in the default language is returned.
      * If $lang isn't provided, the translation in the current language is returned.
      *
-     * @param  LanguageInterface|string|null $lang Optional supported language to retrieve a translation in.
+     * @param  string $lang Optional supported language to retrieve a translation in.
      * @return string
      * @throws InvalidArgumentException If language is invalid.
      * @todo   When the language is invalid, should we fallback to the default language
@@ -330,7 +330,7 @@ 
      * a subset of the object's available languages (if any).
      *
      * @param  (LanguageInterface|string)[] $langs Optional language(s) filters.
-     * @return (LanguageInterface|string)[] An array of available languages.
+     * @return string[] An array of available languages.
      */
     public function translations(array $langs = [])
     {
@@ -546,7 +546,7 @@ 
      *
      * @param  mixed $lang A language object or identifier.
      * @throws InvalidArgumentException If language is invalid.
-     * @return string|mixed A language identifier.
+     * @return string A language identifier.
      */
     protected function parseLanguageIdent($lang)
     {

Spacing +3 added lines, -3 removed lines

@@ -300,7 +300,7 @@ 
         $lang = $this->parseLanguageIdent($lang);
         $val  = $this->val($lang);
         if (empty($val)) {
-            $available = array_diff_key($this->val, array_flip([ $lang, $this->defaultLanguage() ]));
+            $available = array_diff_key($this->val, array_flip([$lang, $this->defaultLanguage()]));
             foreach ($available as $code => $l10n) {
                 if (!empty($l10n)) {
                     return $l10n;
@@ -335,7 +335,7 @@ 
     public function translations(array $langs = [])
     {
         if (count($langs)) {
-            array_walk($langs, function (&$val, $key) {
+            array_walk($langs, function(&$val, $key) {
                 $val = self::resolveLanguageIdent($val);
             });
 
@@ -597,7 +597,7 @@ 
         if (is_array($var)) {
             return !!array_filter(
                 $var,
-                function ($v, $k) {
+                function($v, $k) {
                     if (is_string($k) && is_string($v)) {
                         if (strlen($k) && mb_strlen($v)) {
                             return true;

src/Charcoal/Translation/TranslatableTrait.php

Doc Comments +7 added lines, -7 removed lines

@@ -67,7 +67,7 @@ 
      *
      * @used-by self::setLanguages()
      * @used-by self::removeLanguage()
-     * @return  MultilingualAwareInterface Chainable
+     * @return  TranslatableTrait Chainable
      */
     public function resolveSpecialLanguages()
     {
@@ -142,7 +142,7 @@ 
      *
      *     If an empty array is provided, the method should consider this a request
      *     to clear the languages store.
-     * @return MultilingualAwareInterface Chainable
+     * @return TranslatableTrait Chainable
      */
     public function setLanguages(array $langs = [])
     {
@@ -161,7 +161,7 @@ 
      * Append a list of languages to the object.
      *
      * @param  (LanguageInterface|string)[] $langs The languages to set.
-     * @return MultilingualAwareInterface Chainable
+     * @return TranslatableTrait Chainable
      */
     public function addLanguages(array $langs)
     {
@@ -184,7 +184,7 @@ 
      * this method will replace the existing one.
      *
      * @param  LanguageInterface|array|string $lang A language object or identifier.
-     * @return MultilingualAwareInterface Chainable
+     * @return TranslatableTrait Chainable
      *
      * @throws InvalidArgumentException If the language is invalid.
      */
@@ -213,7 +213,7 @@ 
      *
      * @uses   self::resolve_specialLanguages()
      * @param  LanguageInterface|string $lang A language object or identifier.
-     * @return MultilingualAwareInterface Chainable
+     * @return TranslatableTrait Chainable
      *
      * @throws InvalidArgumentException If an array member isn't a string or instance of LanguageInterface.
      */
@@ -304,7 +304,7 @@ 
      *
      * @param  LanguageInterface|string|null $lang A language object or identifier.
      * @throws InvalidArgumentException If language is invalid.
-     * @return MultilingualAwareInterface Chainable
+     * @return TranslatableTrait Chainable
      */
     public function setDefaultLanguage($lang = null)
     {
@@ -356,7 +356,7 @@ 
      *
      * @param  LanguageInterface|string|null $lang A language object or identifier.
      * @throws InvalidArgumentException If language is invalid.
-     * @return MultilingualAwareInterface Chainable
+     * @return TranslatableTrait Chainable
      */
     public function setCurrentLanguage($lang = null)
     {

Spacing +2 added lines, -2 removed lines

@@ -95,7 +95,7 @@ 
     public function languages(array $langs = [])
     {
         if (count($langs)) {
-            array_walk($langs, function (&$val, $key) {
+            array_walk($langs, function(&$val, $key) {
                 $val = self::resolveLanguageIdent($val);
             });
 
@@ -118,7 +118,7 @@ 
         $available = array_keys($this->languages);
 
         if (count($langs)) {
-            array_walk($langs, function (&$val, $key) {
+            array_walk($langs, function(&$val, $key) {
                 $val = self::resolveLanguageIdent($val);
             });