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()
     {

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)
     {

src/Charcoal/Translation/Catalog/ResourceRepository.php

Doc Comments +3 added lines, -3 removed lines

@@ -121,7 +121,7 @@ 
      * Set the cache service.
      *
      * @param  CacheItemPoolInterface $cache A PSR-6 compliant cache pool instance.
-     * @return MetadataLoader Chainable
+     * @return ResourceRepository Chainable
      */
     private function setCachePool(CacheItemPoolInterface $cache)
     {
@@ -439,7 +439,7 @@ 
      *
      * @param  string $className The class name of the object catalog model.
      * @throws InvalidArgumentException If the class name is not a string.
-     * @return AbstractPropertyDisplay Chainable
+     * @return ResourceRepository Chainable
      */
     public function setCatalogClass($className)
     {
@@ -492,7 +492,7 @@ 
      *
      * @param  string $className The class name of the object resource model.
      * @throws InvalidArgumentException If the class name is not a string.
-     * @return AbstractPropertyDisplay Chainable
+     * @return ResourceRepository Chainable
      */
     public function setResourceClass($className)
     {

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)
     {