locomotivemtl / charcoal-attachment

src/Charcoal/Admin/Widget/AttachmentWidget.php

Doc Comments +1 added lines, -1 removed lines

@@ -215,7 +215,7 @@
     /**
      * Determine the number of attachments.
      *
-     * @return boolean
+     * @return integer
      */
     public function hasAttachments()
     {

Unused Use Statements -3 removed lines

@@ -2,7 +2,6 @@ 
 
 namespace Charcoal\Admin\Widget;
 
-use ArrayIterator;
 use Charcoal\Model\ModelInterface;
 use RuntimeException;
 use InvalidArgumentException;
@@ -11,7 +10,6 @@ 
 use Pimple\Container;
 
 // From 'bobthecow/mustache.php'
-use Mustache_LambdaHelper as LambdaHelper;
 
 // From 'charcoal-config'
 use Charcoal\Config\ConfigurableInterface;
@@ -20,7 +18,6 @@ 
 use Charcoal\Factory\FactoryInterface;
 
 // From 'charcoal-core'
-use Charcoal\Loader\CollectionLoader;
 
 // From 'charcoal-translator'
 use Charcoal\Translator\Translation;

Spacing +3 added lines, -3 removed lines

@@ -207,7 +207,7 @@ 
         ]);
 
         foreach ($attachments as $attachment) {
-            $GLOBALS['widget_template'] = (string)$attachment->rawPreview();
+            $GLOBALS['widget_template'] = (string) $attachment->rawPreview();
 
             if (isset($attachableObjects[$attachment->objType()])) {
                 $attachment->attachmentType = $attachableObjects[$attachment->objType()];
@@ -473,7 +473,7 @@ 
             );
         }
 
-        $num = (int)$num;
+        $num = (int) $num;
 
         if ($num < 0) {
             throw new InvalidArgumentException(
@@ -501,7 +501,7 @@ 
             );
         }
 
-        $page = (int)$page;
+        $page = (int) $page;
 
         if ($page < 0) {
             throw new InvalidArgumentException(

src/Charcoal/Attachment/Object/Attachment.php

Unused Use Statements -1 removed lines

@@ -25,7 +25,6 @@
 // From 'locomotivemtl/charcoal-attachments'
 use Charcoal\Attachment\Interfaces\AttachableInterface;
 use Charcoal\Attachment\Interfaces\AttachmentContainerInterface;
-
 use Charcoal\Attachment\Object\File;
 use Charcoal\Attachment\Object\Image;
 use Charcoal\Attachment\Object\Text;

Doc Comments +8 added lines, -8 removed lines

@@ -308,7 +308,7 @@ 
      *
      * @param  string $type The attachment type.
      * @throws InvalidArgumentException If provided argument is not of type 'string'.
-     * @return string
+     * @return Attachment
      */
     public function setType($type)
     {
@@ -525,7 +525,7 @@ 
      * Show/hide the attachment's title on the front-end.
      *
      * @param  boolean $show Show (TRUE) or hide (FALSE) the title.
-     * @return UiItemInterface Chainable
+     * @return Attachment Chainable
      */
     public function setShowTitle($show)
     {
@@ -723,7 +723,7 @@ 
     /**
      * Retrieve the attachment's sub-title.
      *
-     * @return Translation|string|null
+     * @return null|Translation
      */
     public function subtitle()
     {
@@ -733,7 +733,7 @@ 
     /**
      * Retrieve attachment's description.
      *
-     * @return Translation|string|null
+     * @return null|Translation
      */
     public function description()
     {
@@ -753,7 +753,7 @@ 
     /**
      * Retrieve the path to the thumbnail associated with the object.
      *
-     * @return string|null
+     * @return string
      */
     public function thumbnail()
     {
@@ -763,7 +763,7 @@ 
     /**
      * Retrieve the path to the attached file.
      *
-     * @return Translation|string|null
+     * @return File
      */
     public function file()
     {
@@ -773,7 +773,7 @@ 
     /**
      * Retrieve the attached link.
      *
-     * @return Translation|string|null
+     * @return null|Translation
      */
     public function link()
     {
@@ -920,7 +920,7 @@ 
      * Prepend the base URI to the given path.
      *
      * @param  string $text A string to parse relative URIs.
-     * @return UriInterface|null
+     * @return string
      */
     protected function resolveUrls($text)
     {

Spacing +9 added lines, -9 removed lines

@@ -180,7 +180,7 @@ 
     {
         parent::__construct($data);
 
-        if (is_callable([ $this, 'defaultData' ])) {
+        if (is_callable([$this, 'defaultData'])) {
             $defaultData = $this->defaultData();
             if ($defaultData) {
                 $this->setData($defaultData);
@@ -356,7 +356,7 @@ 
      */
     public function heading()
     {
-        $heading = $this->render((string)$this->heading);
+        $heading = $this->render((string) $this->heading);
 
         if (!$heading) {
             $heading = $this->translator()->translation('{{ objType }} #{{ id }}', [
@@ -399,7 +399,7 @@ 
     public function preview()
     {
         if ($this->preview) {
-            return $this->render((string)$this->preview);
+            return $this->render((string) $this->preview);
         }
 
         return '';
@@ -927,19 +927,19 @@ 
         static $search;
 
         if ($search === null) {
-            $attr   = [ 'href', 'link', 'url', 'src' ];
-            $scheme = [ '../', './', '/', 'data', 'mailto', 'http' ];
+            $attr   = ['href', 'link', 'url', 'src'];
+            $scheme = ['../', './', '/', 'data', 'mailto', 'http'];
 
             $search = sprintf(
                 '(?<=%1$s=")(?!%2$s)(\S+)(?=")',
-                implode('="|', array_map('preg_quote', $attr, [ '~' ])),
-                implode('|', array_map('preg_quote', $scheme, [ '~' ]))
+                implode('="|', array_map('preg_quote', $attr, ['~'])),
+                implode('|', array_map('preg_quote', $scheme, ['~']))
             );
         }
 
         $text = preg_replace_callback(
             '~'.$search.'~i',
-            function ($matches) {
+            function($matches) {
                 return $this->createAbsoluteUrl($matches[1]);
             },
             $text
@@ -958,7 +958,7 @@ 
     protected function isRelativeUri($uri)
     {
         if ($uri && !parse_url($uri, PHP_URL_SCHEME)) {
-            if (!in_array($uri[0], [ '/', '#', '?' ])) {
+            if (!in_array($uri[0], ['/', '#', '?'])) {
                 return true;
             }
         }

src/Charcoal/Attachment/Object/File.php

Doc Comments +1 added lines, -1 removed lines

@@ -13,7 +13,7 @@
     /**
      * Alias of {@see Attachment::file()}.
      *
-     * @return string|null
+     * @return \Psr\Http\Message\UriInterface|null
      */
     public function src()
     {

src/Charcoal/Attachment/Object/Image.php

Doc Comments +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
     /**
      * Alias of {@see Attachment::thumbnail()} and {@see Attachment::file()}.
      *
-     * @return string|null
+     * @return \Psr\Http\Message\UriInterface|null
      */
     public function src()
     {

src/Charcoal/Attachment/Traits/AttachmentAwareTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -293,7 +293,7 @@
      * Set the attachment widget.
      *
      * @param  AttachmentWidget $widget The widget displaying attachments.
-     * @return string
+     * @return AttachmentAwareTrait
      */
     protected function setAttachmentWidget(AttachmentWidget $widget)
     {

Unused Use Statements -2 removed lines

@@ -13,8 +13,6 @@
 
 // From 'locomotivemtl/charcoal-attachments'
 use Charcoal\Attachment\Interfaces\AttachableInterface;
-use Charcoal\Attachment\Interfaces\AttachmentContainerInterface;
-
 use Charcoal\Attachment\Object\Join;
 use Charcoal\Attachment\Object\Attachment;
 

Spacing +7 added lines, -7 removed lines

@@ -80,7 +80,7 @@ 
                 $this->logger->warning(
                     'AttachmentAwareTrait::attachments() parameters are deprecated. '.
                     'An array of parameters should be used.',
-                    [ 'package' => 'locomotivemtl/charcoal-attachment' ]
+                    ['package' => 'locomotivemtl/charcoal-attachment']
                 );
             }
             $options = [
@@ -181,7 +181,7 @@ 
         $loader->setDynamicTypeField('type');
 
         if ($widget instanceof AttachmentWidget) {
-            $callable = function (&$att) use ($widget, $before) {
+            $callable = function(&$att) use ($widget, $before) {
                 if ($this instanceof AttachableInterface) {
                     $att->setContainerObj($this);
                 }
@@ -208,11 +208,11 @@ 
                 $att->isPresentable(true);
 
                 if ($before !== null) {
-                    call_user_func_array($before, [ &$att ]);
+                    call_user_func_array($before, [&$att]);
                 }
             };
         } else {
-            $callable = function (&$att) use ($before) {
+            $callable = function(&$att) use ($before) {
                 if ($this instanceof AttachableInterface) {
                     $att->setContainerObj($this);
                 }
@@ -220,7 +220,7 @@ 
                 $att->isPresentable(true);
 
                 if ($before !== null) {
-                    call_user_func_array($before, [ &$att ]);
+                    call_user_func_array($before, [&$att]);
                 }
             };
         }
@@ -294,7 +294,7 @@ 
         $this->logger->warning(
             'AttachmentAwareTrait::removeJoins() is deprecated. '.
             'Use AttachmentAwareTrait::removeAttachmentJoins() instead.',
-            [ 'package' => 'locomotivemtl/charcoal-attachment' ]
+            ['package' => 'locomotivemtl/charcoal-attachment']
         );
 
         return $this->removeAttachmentJoins();
@@ -422,7 +422,7 @@ 
         $defaults = $this->getDefaultAttachmentOptions();
 
         $options = array_intersect_key($options, $defaults);
-        $options = array_filter($options, [ $this, 'filterAttachmentOption' ], ARRAY_FILTER_USE_BOTH);
+        $options = array_filter($options, [$this, 'filterAttachmentOption'], ARRAY_FILTER_USE_BOTH);
         $options = array_replace($defaults, $options);
 
         return $options;

src/Charcoal/Attachment/Traits/ConfigurableAttachmentsTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
      *
      * @param  ConfigInterface|array $config The datas to set.
      * @throws InvalidArgumentException If the parameter is invalid.
-     * @return ConfigurableInterface Chainable
+     * @return ConfigurableAttachmentsTrait Chainable
      */
     public function setConfig($config)
     {

src/Charcoal/Attachment/Traits/AttachmentRelationTrait.php

Spacing +1 added lines, -1 removed lines

@@ -69,7 +69,7 @@
         $pivot = $this->modelFactory()->create(Join::class);
 
         if (is_string($data) && strpos($data, '_') > 1) {
-            $data = array_combine([ 'obj_type', 'obj_id' ], explode('_', $data, 1));
+            $data = array_combine(['obj_type', 'obj_id'], explode('_', $data, 1));
         }
 
         if (is_scalar($data)) {

src/Charcoal/Attachment/Object/Join.php

Spacing +1 added lines, -1 removed lines

@@ -402,7 +402,7 @@
             );
         }
 
-        $this->position = (int)$position;
+        $this->position = (int) $position;
 
         return $this;
     }

src/Charcoal/Attachment/Script/CleanupScript.php

Spacing +6 added lines, -6 removed lines

@@ -256,7 +256,7 @@ 
                     ]);
                     $rows = $source->dbQuery(
                         strtr($sql, $binds),
-                        [ 'objType' => $row['object_type'] ]
+                        ['objType' => $row['object_type']]
                     );
 
                     /** @todo Show found rows, confirm deletion of dead relationships */
@@ -276,7 +276,7 @@ 
                     $sql  = 'SELECT p.* FROM `%pivotTable` AS p WHERE p.`%sourceType` = :objType;';
                     $rows = $source->dbQuery(
                         strtr($sql, $defaultBinds),
-                        [ 'objType' => $model ]
+                        ['objType' => $model]
                     );
 
                     /** @todo Explain missing model, confirm deletion of dead relationships */
@@ -394,7 +394,7 @@ 
                 ];
 
                 if ($ask && $verb) {
-                    $dead = array_merge([ 'Deleted' => null, 'Failed' => null ], $dead);
+                    $dead = array_merge(['Deleted' => null, 'Failed' => null], $dead);
                 }
             }
 
@@ -617,7 +617,7 @@ 
         $cli = $this->climate();
 
         if (is_string($this->action)) {
-            $opts = [ 'y', 'n', 'r', 'q', '?' ];
+            $opts = ['y', 'n', 'r', 'q', '?'];
             $help = [
                 '[y]es    — delete the attachment',
                 '[n]o     — don’t delete the attachment',
@@ -625,7 +625,7 @@ 
                 '[q]uit   — exit immediately (does not undo previous actions)',
             ];
         } else {
-            $opts = [ 'y', 'a', 'n', 's', 'q', '?' ];
+            $opts = ['y', 'a', 'n', 's', 'q', '?'];
             $help = [
                 '[y]es  — delete this attachment',
                 '[a]ll  — delete all attachments',
@@ -686,7 +686,7 @@ 
     {
         $cli = $this->climate();
 
-        $opts = [ 'y', 'n', 'v', '?' ];
+        $opts = ['y', 'n', 'v', '?'];
         $help = [
             '[y]es  — continue to deletion phase',
             '[n]o   — cancel deletion phase',