locomotivemtl / charcoal-app

src/Charcoal/App/Language/Language.php

Doc Comments -1 removed lines

@@ -127,7 +127,6 @@
     *
     * @link   http://www.faqs.org/rfcs/rfc4646.html Tags for Identifying Languages
     * @link   http://www.faqs.org/rfcs/rfc4647.html Matching of Language Tags
-    * @param  string $ident Language identifier
     * @return self
     *
     * @todo   Implement proper ISO 639 sanitization

Indentation +71 added lines, -71 removed lines

@@ -13,30 +13,30 @@ 
 class Language implements LanguageInterface
 {
     /**
-    * The language identifier, commonly a ISO 639 code
-    *
-    * @var string $ident
-    */
+     * The language identifier, commonly a ISO 639 code
+     *
+     * @var string $ident
+     */
     private $ident;
 
     /**
-    * The language name
-    *
-    * @var TranslationString $name;
-    */
+     * The language name
+     *
+     * @var TranslationString $name;
+     */
     private $name;
 
     /**
-    * The language locale
-    *
-    * @var string $locale;
-    */
+     * The language locale
+     *
+     * @var string $locale;
+     */
     private $locale;
 
     /**
-    * @param array $data
-    * @return self
-    */
+     * @param array $data
+     * @return self
+     */
     public function set_data(array $data)
     {
         if (isset($data['ident']) && $data['ident'] !== null) {
@@ -49,15 +49,15 @@ 
     }
 
     /**
-    * Set the language identifier
-    *
-    * A valid ISO 639 code is recommended (either 639-1, 639-2, or 639-3).
-    * Within a routable application, the identifier is most often used
-    * as a base URI path.
-    *
-    * @param  string $ident Language identifier
-    * @return self
-    */
+     * Set the language identifier
+     *
+     * A valid ISO 639 code is recommended (either 639-1, 639-2, or 639-3).
+     * Within a routable application, the identifier is most often used
+     * as a base URI path.
+     *
+     * @param  string $ident Language identifier
+     * @return self
+     */
     public function set_ident($ident)
     {
         $this->ident = $ident;
@@ -65,30 +65,30 @@ 
     }
 
     /**
-    * Get the language identifier
-    *
-    * @return string
-    */
+     * Get the language identifier
+     *
+     * @return string
+     */
     public function ident()
     {
         return $this->ident;
     }
 
     /**
-    * Set the name of the language and, optionally,
-    * the name translated in other languages.
-    *
-    * @param  TranslationString|array|string $name {
-    *     The language's name in one or more languages.
-    *
-    *     Accept 3 types of arguments:
-    *     - object (TranslationStringInterface): The data will be copied from the object's.
-    *     - array: All languages available in the array. The format of the array should
-    *       be a hash in the `lang` => `string` format.
-    *     - string: The value will be assigned to the current language.
-    * }
-    * @return self
-    */
+     * Set the name of the language and, optionally,
+     * the name translated in other languages.
+     *
+     * @param  TranslationString|array|string $name {
+     *     The language's name in one or more languages.
+     *
+     *     Accept 3 types of arguments:
+     *     - object (TranslationStringInterface): The data will be copied from the object's.
+     *     - array: All languages available in the array. The format of the array should
+     *       be a hash in the `lang` => `string` format.
+     *     - string: The value will be assigned to the current language.
+     * }
+     * @return self
+     */
     public function set_name($name)
     {
         if ($name instanceof TranslationStringInterface) {
@@ -103,35 +103,35 @@ 
     }
 
     /**
-    * Get the name of the language
-    *
-    * @return TranslationString
-    */
+     * Get the name of the language
+     *
+     * @return TranslationString
+     */
     public function name()
     {
         return $this->name;
     }
 
     /**
-    * Alias of self::name()
-    *
-    * @return string
-    */
+     * Alias of self::name()
+     *
+     * @return string
+     */
     public function __toString()
     {
         return (string)$this->name();
     }
 
     /**
-    * Set the language's locale
-    *
-    * @link   http://www.faqs.org/rfcs/rfc4646.html Tags for Identifying Languages
-    * @link   http://www.faqs.org/rfcs/rfc4647.html Matching of Language Tags
-    * @param  string $ident Language identifier
-    * @return self
-    *
-    * @todo   Implement proper ISO 639 sanitization
-    */
+     * Set the language's locale
+     *
+     * @link   http://www.faqs.org/rfcs/rfc4646.html Tags for Identifying Languages
+     * @link   http://www.faqs.org/rfcs/rfc4647.html Matching of Language Tags
+     * @param  string $ident Language identifier
+     * @return self
+     *
+     * @todo   Implement proper ISO 639 sanitization
+     */
     public function set_locale($locale)
     {
         $this->locale = $locale;
@@ -139,24 +139,24 @@ 
     }
 
     /**
-    * Get the language's locale
-    *
-    * @return string
-    */
+     * Get the language's locale
+     *
+     * @return string
+     */
     public function locale()
     {
         return $this->locale;
     }
 
     /**
-    * Get the language's ISO 639-1 (alpha-2) code.
-    *
-    * @link   http://www.iso.org/iso/home/standards/language_codes.htm for specification
-    * @return string
-    *
-    * @todo   Implement proper ISO 639 sanitization
-    * @todo   Added support for retrieving codes in 639-1, 639-2/B, 639-2/T, and 639-3
-    */
+     * Get the language's ISO 639-1 (alpha-2) code.
+     *
+     * @link   http://www.iso.org/iso/home/standards/language_codes.htm for specification
+     * @return string
+     *
+     * @todo   Implement proper ISO 639 sanitization
+     * @todo   Added support for retrieving codes in 639-1, 639-2/B, 639-2/T, and 639-3
+     */
     public function iso639()
     {
         return $this->ident();

Spacing +1 added lines, -1 removed lines

@@ -94,7 +94,7 @@
         if ($name instanceof TranslationStringInterface) {
             $config = $name->available_langs();
         } elseif (is_array($name)) {
-            $config = [ 'languages' => array_keys($name) ];
+            $config = ['languages' => array_keys($name)];
         } else {
             $config = null;
         }

src/Charcoal/App/Language/LanguageInterface.php

Doc Comments -1 removed lines

@@ -44,7 +44,6 @@
     /**
     * Set the language's locale
     *
-    * @param  string $ident
     * @return LanguageInterface Chainable
     */
     public function set_locale($locale);

Indentation +35 added lines, -35 removed lines

@@ -5,61 +5,61 @@
 interface LanguageInterface
 {
     /**
-    * @param array $data
-    * @return LanguageInterface Chainable
-    */
+     * @param array $data
+     * @return LanguageInterface Chainable
+     */
     public function set_data(array $data);
 
     /**
-    * Set the language identifier
-    *
-    * @param  string $ident
-    * @return LanguageInterface Chainable
-    */
+     * Set the language identifier
+     *
+     * @param  string $ident
+     * @return LanguageInterface Chainable
+     */
     public function set_ident($ident);
 
     /**
-    * Get the language identifier
-    *
-    * @return string
-    */
+     * Get the language identifier
+     *
+     * @return string
+     */
     public function ident();
 
     /**
-    * Set the name of the language and, optionally,
-    * the name translated in other languages.
-    *
-    * @param  TranslationString|array|string $name
-    * @return LanguageInterface Chainable
-    */
+     * Set the name of the language and, optionally,
+     * the name translated in other languages.
+     *
+     * @param  TranslationString|array|string $name
+     * @return LanguageInterface Chainable
+     */
     public function set_name($name);
 
     /**
-    * Get the name of the language
-    *
-    * @return string
-    */
+     * Get the name of the language
+     *
+     * @return string
+     */
     public function name();
 
     /**
-    * Set the language's locale
-    *
-    * @param  string $ident
-    * @return LanguageInterface Chainable
-    */
+     * Set the language's locale
+     *
+     * @param  string $ident
+     * @return LanguageInterface Chainable
+     */
     public function set_locale($locale);
 
     /**
-    * Get the language's locale
-    *
-    * @return string
-    */
+     * Get the language's locale
+     *
+     * @return string
+     */
     public function locale();
 
     /**
-    * Get the language's ISO 639 code.
-    *
-    * @return string
-    */
+     * Get the language's ISO 639 code.
+     *
+     * @return string
+     */
     public function iso639();
 }

src/Charcoal/App/Language/LanguageManager.php

Doc Comments +1 added lines, -2 removed lines

@@ -145,7 +145,7 @@ 
     *
     * @param  LanguageInterface &$lang  The instance that needs resolution
     * @param  array             $config Array element of fallbacks
-    * @param  mixed             $ident  Optional key/index of $config in previous method
+    * @param  string|null             $ident  Optional key/index of $config in previous method
     * @return void
     * @throws InvalidArgumentException
     */
@@ -174,7 +174,6 @@ 
     /**
     * Set the manager's available languages
     *
-    * @param  LanguageInterface[] $lang
     * @return self
     */
     public function set_languages($languages)

Spacing +3 added lines, -3 removed lines

@@ -63,7 +63,7 @@ 
         }
 
         if (isset($config['languages'])) {
-            $available_langs = array_filter($config['languages'], function ($config) {
+            $available_langs = array_filter($config['languages'], function($config) {
                 return (!isset($config['active']) || $config['active']);
             });
 
@@ -133,7 +133,7 @@ 
     public static function language_index()
     {
         if (!isset(self::$language_index)) {
-            self::$language_index = new GenericConfig(__DIR__ . '/../../../../config/languages.json');
+            self::$language_index = new GenericConfig(__DIR__.'/../../../../config/languages.json');
         }
 
         return self::$language_index;
@@ -147,7 +147,7 @@ 
     * @return void
     * @throws InvalidArgumentException
     */
-    public function resolve_ident(LanguageInterface &$lang, $ident = null)
+    public function resolve_ident(LanguageInterface & $lang, $ident = null)
     {
         if (is_string($ident)) {
             $lang->set_ident($ident);

Indentation +53 added lines, -53 removed lines

@@ -23,25 +23,25 @@ 
 class LanguageManager extends AbstractManager
 {
     /**
-    * @var array LanguageInterface
-    */
+     * @var array LanguageInterface
+     */
     private $languages;
 
     /**
-    * @var TranslationConfig
-    */
+     * @var TranslationConfig
+     */
     private $translation_config;
 
     /**
-    * @var GenericConfig
-    */
+     * @var GenericConfig
+     */
     private static $language_index;
 
     /**
-    * Set up the available languages, defaults, and active
-    *
-    * @return void
-    */
+     * Set up the available languages, defaults, and active
+     *
+     * @return void
+     */
     public function setup()
     {
         $this->setup_translations();
@@ -49,14 +49,14 @@ 
     }
 
     /**
-    * Set up the available languages, defaults, and active
-    *
-    * Settings:
-    * - languages
-    * - default_lang
-    *
-    * @return void
-    */
+     * Set up the available languages, defaults, and active
+     *
+     * Settings:
+     * - languages
+     * - default_lang
+     *
+     * @return void
+     */
     public function setup_translations()
     {
         $config = $this->config();
@@ -81,10 +81,10 @@ 
     }
 
     /**
-    * Set up the available languages, defaults, and active
-    *
-    * @return void
-    */
+     * Set up the available languages, defaults, and active
+     *
+     * @return void
+     */
     public function setup_languages()
     {
         $config = $this->config();
@@ -145,13 +145,13 @@ 
     }
 
     /**
-    * Resolve a string identifier for a given Language.
-    *
-    * @param  LanguageInterface &$lang  The instance that needs resolution
-    * @param  mixed             $ident  Optional key/index of $config in previous method
-    * @return void
-    * @throws InvalidArgumentException
-    */
+     * Resolve a string identifier for a given Language.
+     *
+     * @param  LanguageInterface &$lang  The instance that needs resolution
+     * @param  mixed             $ident  Optional key/index of $config in previous method
+     * @return void
+     * @throws InvalidArgumentException
+     */
     public function resolve_ident(LanguageInterface &$lang, $ident = null)
     {
         if (is_string($ident)) {
@@ -178,12 +178,12 @@ 
     }
 
     /**
-    * Set the manager's available languages
-    *
-    * @param  LanguageInterface[] $lang
-    * @return self
-    * @throws InvalidArgumentException if array has a member that isn't an instance of Language
-    */
+     * Set the manager's available languages
+     *
+     * @param  LanguageInterface[] $lang
+     * @return self
+     * @throws InvalidArgumentException if array has a member that isn't an instance of Language
+     */
     public function set_languages($languages)
     {
         $this->languages = [];
@@ -199,11 +199,11 @@ 
     }
 
     /**
-    * Add or update an available language to the manager
-    *
-    * @param  LanguageInterface $lang
-    * @return self
-    */
+     * Add or update an available language to the manager
+     *
+     * @param  LanguageInterface $lang
+     * @return self
+     */
     public function add_language(LanguageInterface $lang)
     {
         $this->languages[$lang->ident()] = $lang;
@@ -211,21 +211,21 @@ 
     }
 
     /**
-    * Get the manager's list of available languages
-    *
-    * @return LanguageInterface[]
-    */
+     * Get the manager's list of available languages
+     *
+     * @return LanguageInterface[]
+     */
     public function languages()
     {
         return $this->languages;
     }
 
     /**
-    * Set the manager's translations for TranslationConfig
-    *
-    * @param  array|TranslationConfig $translation
-    * @return self
-    */
+     * Set the manager's translations for TranslationConfig
+     *
+     * @param  array|TranslationConfig $translation
+     * @return self
+     */
     public function set_translation($translation)
     {
         if ($translation instanceof TranslationConfig) {
@@ -237,10 +237,10 @@ 
     }
 
     /**
-    * Get the manager's translations
-    *
-    * @return TranslationConfig
-    */
+     * Get the manager's translations
+     *
+     * @return TranslationConfig
+     */
     public function translation()
     {
         return $this->translation_config;

src/Charcoal/App/Routable/RoutableInterface.php

Doc Comments -2 removed lines

@@ -12,7 +12,6 @@ 
 interface RoutableInterface
 {
     /**
-    * @param boolean $data
     * @return RoutableInterface Chainable
     */
     public function set_routable($routable);
@@ -23,7 +22,6 @@ 
     public function routable();
 
         /**
-    * @param mixed $url
     * @return RoutableInterface Chainable
     */
     public function set_slug_pattern($pattern);

Indentation +24 added lines, -24 removed lines

@@ -12,53 +12,53 @@
 interface RoutableInterface
 {
     /**
-    * @param boolean $data
-    * @return RoutableInterface Chainable
-    */
+     * @param boolean $data
+     * @return RoutableInterface Chainable
+     */
     public function set_routable($routable);
 
     /**
-    * @return boolean
-    */
+     * @return boolean
+     */
     public function routable();
 
         /**
-    * @param mixed $url
-    * @return RoutableInterface Chainable
-    */
+         * @param mixed $url
+         * @return RoutableInterface Chainable
+         */
     public function set_slug_pattern($pattern);
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function slug_pattern();
 
     /**
-    * @param mixed $slug
-    * @return RoutableInterface Chainable
-    */
+     * @param mixed $slug
+     * @return RoutableInterface Chainable
+     */
     public function set_slug($slug);
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function slug();
 
     /**
-    * Generate a URL slug from the object's URL slug pattern.
-    */
+     * Generate a URL slug from the object's URL slug pattern.
+     */
     public function generate_slug();
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function url();
 
     /**
-    * @param string $path
-    * @param RequestInterface $request
-    * @param ResponseInterface $response
-    * @return callable|null Route callable
-    */
+     * @param string $path
+     * @param RequestInterface $request
+     * @param ResponseInterface $response
+     * @return callable|null Route callable
+     */
     public function route_handler($path, RequestInterface $request, ResponseInterface $response);
 }

src/Charcoal/App/Routable/RoutableTrait.php

Doc Comments +3 added lines, -5 removed lines

@@ -32,8 +32,7 @@ 
     private $slug;
 
     /**
-    * @param boolean $data
-    * @return RoutableInterface Chainable
+    * @return RoutableTrait Chainable
     */
     public function set_routable($routable)
     {
@@ -50,8 +49,7 @@ 
     }
 
     /**
-    * @param mixed $url
-    * @return RoutableInterface Chainable
+    * @return RoutableTrait Chainable
     */
     public function set_slug_pattern($pattern)
     {
@@ -69,7 +67,7 @@ 
 
     /**
     * @param mixed $slug
-    * @return RoutableInterface Chainable
+    * @return RoutableTrait Chainable
     */
     public function set_slug($slug)
     {

Indentation +32 added lines, -32 removed lines

@@ -17,24 +17,24 @@ 
 trait RoutableTrait
 {
     /**
-    * @var boolean routable
-    */
+     * @var boolean routable
+     */
     private $routable = true;
 
     /**
-    * @var string
-    */
+     * @var string
+     */
     private $slug_pattern = '';
 
     /**
-    * @var string $slug
-    */
+     * @var string $slug
+     */
     private $slug;
 
     /**
-    * @param boolean $data
-    * @return RoutableInterface Chainable
-    */
+     * @param boolean $data
+     * @return RoutableInterface Chainable
+     */
     public function set_routable($routable)
     {
         $this->routable = !!$routable;
@@ -42,17 +42,17 @@ 
     }
 
     /**
-    * @return boolean
-    */
+     * @return boolean
+     */
     public function routable()
     {
         return $this->routable;
     }
 
     /**
-    * @param mixed $url
-    * @return RoutableInterface Chainable
-    */
+     * @param mixed $url
+     * @return RoutableInterface Chainable
+     */
     public function set_slug_pattern($pattern)
     {
         $this->slug_pattern = new TranslationString($pattern);
@@ -60,17 +60,17 @@ 
     }
 
     /**
-    * @return TranslationString
-    */
+     * @return TranslationString
+     */
     public function slug_pattern()
     {
         return $this->slug_pattern;
     }
 
     /**
-    * @param mixed $slug
-    * @return RoutableInterface Chainable
-    */
+     * @param mixed $slug
+     * @return RoutableInterface Chainable
+     */
     public function set_slug($slug)
     {
         $this->slug = $slug;
@@ -78,8 +78,8 @@ 
     }
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function slug()
     {
         if ($this->slug === null) {
@@ -89,8 +89,8 @@ 
     }
 
     /**
-    * Generate a URL slug from the object's URL slug pattern.
-    */
+     * Generate a URL slug from the object's URL slug pattern.
+     */
     public function generate_slug()
     {
         $pattern = $this->slug_pattern();
@@ -103,20 +103,20 @@ 
     }
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function url()
     {
         return $this->slug();
     }
 
     /**
-    * Get the route callback that matches a gien path (or null).
-    *
-    * @param string $path
-    * @param RequestInterface $request
-    * @param ResponseInterface $response
-    * @return callable|null Route callable
-    */
+     * Get the route callback that matches a gien path (or null).
+     *
+     * @param string $path
+     * @param RequestInterface $request
+     * @param ResponseInterface $response
+     * @return callable|null Route callable
+     */
     abstract public function route_handler($path, RequestInterface $request, ResponseInterface $response);
 }

src/Charcoal/App/SingletonInterface.php

Doc Comments +1 added lines, -2 removed lines

@@ -10,8 +10,7 @@
     /**
      * Getter for creating/returning the unique instance of this class
      *
-     * @param  mixed $param,...
-     * @return object
+     * @return SingletonTrait
      */
     public static function instance();
 }

src/Charcoal/App/SingletonTrait.php

Doc Comments -1 removed lines

@@ -51,7 +51,6 @@
     /**
      * Getter for creating/returning the unique instance of this class
      *
-     * @param  mixed $param,...
      * @return self
      */
     public static function instance()

src/Charcoal/App/Template/WidgetFactory.php

Doc Comments -1 removed lines

@@ -11,7 +11,6 @@
 class WidgetFactory extends ResolverFactory
 {
     /**
-    * @param array $data
     */
     public function base_class()
     {

Indentation +4 added lines, -4 removed lines

@@ -11,16 +11,16 @@
 class WidgetFactory extends ResolverFactory
 {
     /**
-    * @param array $data
-    */
+     * @param array $data
+     */
     public function base_class()
     {
         return '\Charcoal\App\Template\WidgetInterface';
     }
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function resolver_suffix()
     {
         return 'Widget';

config/config.php

Indentation +46 added lines, -46 removed lines

@@ -1,54 +1,54 @@
 <?php
 return [
 
-	'logger'=>[
-		'level'=>'debug'
-	],
+    'logger'=>[
+        'level'=>'debug'
+    ],
 
-	'view'=>[
-		'path'=>[
-			'../templates/'
-		],
+    'view'=>[
+        'path'=>[
+            '../templates/'
+        ],
         'default_template'=>'default',
-		'default_engine'=>'mustache'
-	],
+        'default_engine'=>'mustache'
+    ],
 
-	'routes' => [
-		'templates' => [
-			'default' => [
-				'ident'=>'default'
-			],
-			'example' => [
-				'ident'=>'example',
-				'controller'=>null,
-				'methods'=>['GET'],
-				'group'=>null,
-				'template'=>'example',
-				'engine'=>'mustache',
-				'cache'=>[
-					'active'=>true,
-					'key'=>'route/{{ident}}/{{lang}}/'
-				],
-				'options'=>[]
-			]
-		],
-		'actions' => [
-			'default' => [],
-			'example' => [
-				'ident'=>'example',
-				'controller'=>null,
-				'methods'=>['POST'],
-				'group'=>null
-			]
-		],
-		'scripts' => [
-			'example' => [
-				'ident'=>'example',
-				'controller'=>null,
-				'methods'=>['GET'],
-				'group'=>null
-			]
-		]
-	]
+    'routes' => [
+        'templates' => [
+            'default' => [
+                'ident'=>'default'
+            ],
+            'example' => [
+                'ident'=>'example',
+                'controller'=>null,
+                'methods'=>['GET'],
+                'group'=>null,
+                'template'=>'example',
+                'engine'=>'mustache',
+                'cache'=>[
+                    'active'=>true,
+                    'key'=>'route/{{ident}}/{{lang}}/'
+                ],
+                'options'=>[]
+            ]
+        ],
+        'actions' => [
+            'default' => [],
+            'example' => [
+                'ident'=>'example',
+                'controller'=>null,
+                'methods'=>['POST'],
+                'group'=>null
+            ]
+        ],
+        'scripts' => [
+            'example' => [
+                'ident'=>'example',
+                'controller'=>null,
+                'methods'=>['GET'],
+                'group'=>null
+            ]
+        ]
+    ]
 ];