locomotivemtl / charcoal-cms

src/Charcoal/Cms/AbstractWebTemplate.php

Doc Comments +1 added lines, -1 removed lines

@@ -166,7 +166,7 @@
     /**
      * Retrieve the canonical URI of the object.
      *
-     * @return \Psr\Http\Message\UriInterface|string|null
+     * @return UriInterface|null
      */
     public function canonicalUrl()
     {

Unused Use Statements -1 removed lines

@@ -12,7 +12,6 @@
 use Pimple\Container;
 
 // From 'charcoal-core'
-use Charcoal\Model\ModelInterface;
 
 // From 'charcoal-translator'
 use Charcoal\Translator\TranslatorAwareTrait;

Spacing +11 added lines, -11 removed lines

@@ -197,11 +197,11 @@ 
         $title   = null;
 
         if ($context instanceof MetatagInterface) {
-            $title = (string)$context['metaTitle'];
+            $title = (string) $context['metaTitle'];
         }
 
         if (!$title) {
-            $title = (string)$this->fallbackMetaTitle();
+            $title = (string) $this->fallbackMetaTitle();
         }
 
         return $title;
@@ -216,7 +216,7 @@ 
      */
     protected function fallbackMetaTitle()
     {
-        return (string)$this->title();
+        return (string) $this->title();
     }
 
     /**
@@ -230,11 +230,11 @@ 
 
         $desc = null;
         if ($context instanceof MetatagInterface) {
-            $desc = (string)$context['metaDescription'];
+            $desc = (string) $context['metaDescription'];
         }
 
         if (!$desc) {
-            $desc = (string)$this->fallbackMetaDescription();
+            $desc = (string) $this->fallbackMetaDescription();
         }
 
         return $desc;
@@ -263,11 +263,11 @@ 
 
         $img = null;
         if ($context instanceof MetatagInterface) {
-            $img = (string)$context['metaImage'];
+            $img = (string) $context['metaImage'];
         }
 
         if (!$img) {
-            $img = (string)$this->fallbackMetaImage();
+            $img = (string) $this->fallbackMetaImage();
         }
 
         return $this->resolveMetaImage($img);
@@ -342,11 +342,11 @@ 
 
         $img = null;
         if ($context instanceof MetatagInterface) {
-            $img = (string)$context['opengraphImage'];
+            $img = (string) $context['opengraphImage'];
         }
 
         if (!$img) {
-            $img = (string)$this->fallbackOpengraphImage();
+            $img = (string) $this->fallbackOpengraphImage();
         }
 
         if ($img) {
@@ -412,7 +412,7 @@ 
 
             $this->seoMetadata[] = [
                 'name'    => $key,
-                'content' => (string)$value
+                'content' => (string) $value
             ];
         }
 
@@ -507,7 +507,7 @@ 
         } else {
             $parts = parse_url($uri);
             if (!isset($parts['scheme'])) {
-                if (!in_array($uri[0], [ '/', '#', '?' ])) {
+                if (!in_array($uri[0], ['/', '#', '?'])) {
                     $path  = isset($parts['path']) ? $parts['path'] : '';
                     $query = isset($parts['query']) ? $parts['query'] : '';
                     $hash  = isset($parts['fragment']) ? $parts['fragment'] : '';

src/Charcoal/Cms/Support/ContextualTemplateTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
      *
      * @param  string $className The class name of the section model.
      * @throws InvalidArgumentException If the class name is not a string.
-     * @return AbstractPropertyDisplay Chainable
+     * @return ContextualTemplateTrait Chainable
      */
     public function setGenericContextClass($className)
     {

Spacing +1 added lines, -1 removed lines

@@ -140,7 +140,7 @@
 
                 $base = $uri->getBasePath();
                 $path = $uri->getPath();
-                $path = $base . '/' . ltrim($path, '/');
+                $path = $base.'/'.ltrim($path, '/');
 
                 $endpoint[$lang] = $path;
             }

src/Charcoal/Cms/Support/DocumentTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -111,7 +111,7 @@
      * @param  string $value The value of the current iteration.
      * @param  string $key   The key/index of the current iteration.
      * @param  array  $parts The document title parts.
-     * @return mixed  The mutated value of the current iteration.
+     * @return string  The mutated value of the current iteration.
      *     If $value is equal to FALSE (converted to boolean; excluding "0"), it is excluded from the document title.
      *     If the method returns TRUE, the original $value is included into the document title.
      */

Spacing +2 added lines, -2 removed lines

@@ -86,7 +86,7 @@ 
                 continue;
             }
 
-            $segments[$key] = (string)$value;
+            $segments[$key] = (string) $value;
         }
 
         return $segments;
@@ -129,7 +129,7 @@ 
     final public function documentTitle()
     {
         $parts = $this->documentTitleParts();
-        if (array_diff_key([ 'title' => true, 'site' => true ], $parts)) {
+        if (array_diff_key(['title' => true, 'site' => true], $parts)) {
             throw new InvalidArgumentException(
                 'The document title parts requires at least a "title" and a "site"'
             );

src/Charcoal/Cms/Support/LocaleAwareTrait.php

Doc Comments +2 added lines, -2 removed lines

@@ -168,7 +168,7 @@ 
      * Note: The application's locale is already modified and will be reset
      * after processing all available languages.
      *
-     * @param  mixed $context      The translated {@see \Charcoal\Model\ModelInterface model}
+     * @param  \Charcoal\Model\ModelInterface|null $context      The translated {@see \Charcoal\Model\ModelInterface model}
      *     or array-accessible structure.
      * @param  array $localeStruct The currently iterated language.
      * @return array Returns a link structure.
@@ -213,7 +213,7 @@ 
     /**
      * Yield the alternate translations associated with the current route.
      *
-     * @return Generator|null
+     * @return \Generator
      */
     public function alternateTranslations()
     {

Spacing +4 added lines, -4 removed lines

@@ -72,7 +72,7 @@ 
      */
     private function parseLocale(array $localeStruct, $langCode)
     {
-        $trans = 'locale.' . $langCode;
+        $trans = 'locale.'.$langCode;
 
         /** Setup the name of the language in the current locale */
         if (isset($localeStruct['name'])) {
@@ -176,8 +176,8 @@ 
     protected function formatAlternateTranslation($context, array $localeStruct)
     {
         return [
-            'id'       => ($context['id']) ? : $this->templateName(),
-            'title'    => ((string)$context['title']) ? : $this->title(),
+            'id'       => ($context['id']) ?: $this->templateName(),
+            'title'    => ((string) $context['title']) ?: $this->title(),
             'url'      => $this->formatAlternateTranslationUrl($context, $localeStruct),
             'hreflang' => $localeStruct['code'],
             'locale'   => $localeStruct['locale'],
@@ -201,7 +201,7 @@ 
     {
         $isRoutable = ($context instanceof RoutableInterface && $context->isActiveRoute());
         $langCode   = $localeStruct['code'];
-        $path       = ($isRoutable ? $context->url($langCode) : ($this->currentUrl() ? : $langCode));
+        $path       = ($isRoutable ? $context->url($langCode) : ($this->currentUrl() ?: $langCode));
 
         if ($path instanceof UriInterface) {
             $path = $path->getPath();