From d220812f5e999a2f6ada59625226916f3b831394 Mon Sep 17 00:00:00 2001 From: Matias Griese Date: Tue, 30 Nov 2021 18:59:44 +0200 Subject: [PATCH] Minor code improvements --- system/src/Grav/Common/Helpers/LogViewer.php | 2 +- .../src/Grav/Framework/Acl/PermissionsReader.php | 10 ++++++---- .../src/Grav/Framework/Cache/Adapter/FileCache.php | 2 +- system/src/Grav/Framework/File/AbstractFile.php | 2 +- .../Grav/Framework/File/Formatter/IniFormatter.php | 3 ++- .../Framework/File/Formatter/MarkdownFormatter.php | 5 +++-- system/src/Grav/Framework/Flex/FlexCollection.php | 2 +- .../Flex/Interfaces/FlexCollectionInterface.php | 2 +- .../Flex/Interfaces/FlexFormInterface.php | 5 +++++ system/src/Grav/Framework/Form/FormFlashFile.php | 3 ++- .../Media/Interfaces/MediaCollectionInterface.php | 6 +++++- .../Object/Base/ObjectCollectionTrait.php | 4 +++- .../Object/Collection/ObjectExpressionVisitor.php | 5 +++-- system/src/Grav/Framework/Psr7/ServerRequest.php | 14 ++------------ system/src/Grav/Framework/Route/Route.php | 3 ++- .../DeferredNodeVisitorCompat.php | 13 +++++++++++++ 16 files changed, 51 insertions(+), 30 deletions(-) diff --git a/system/src/Grav/Common/Helpers/LogViewer.php b/system/src/Grav/Common/Helpers/LogViewer.php index 187828ae3..f2d7d43de 100644 --- a/system/src/Grav/Common/Helpers/LogViewer.php +++ b/system/src/Grav/Common/Helpers/LogViewer.php @@ -145,7 +145,7 @@ class LogViewer 'logger' => $data['logger'], 'level' => $data['level'], 'message' => $data['message'], - 'trace' => isset($data['trace']) ? $this->parseTrace($data['trace']) : null, + 'trace' => isset($data['trace']) ? self::parseTrace($data['trace']) : null, 'context' => json_decode($data['context'], true), 'extra' => json_decode($data['extra'], true) ]; diff --git a/system/src/Grav/Framework/Acl/PermissionsReader.php b/system/src/Grav/Framework/Acl/PermissionsReader.php index b157a5d3b..882050216 100644 --- a/system/src/Grav/Framework/Acl/PermissionsReader.php +++ b/system/src/Grav/Framework/Acl/PermissionsReader.php @@ -62,12 +62,14 @@ class PermissionsReader { $list = []; foreach ($actions as $name => $action) { - $prefixNname = $prefix . $name; - $list[$prefixNname] = null; + $prefixName = $prefix . $name; + $list[$prefixName] = null; // Support nested sets of actions. if (isset($action['actions']) && is_array($action['actions'])) { - $list += static::read($action['actions'], "{$prefixNname}."); + $innerList = static::read($action['actions'], "{$prefixName}."); + + $list += $innerList; } unset($action['actions']); @@ -76,7 +78,7 @@ class PermissionsReader $action = static::addDefaults($action); // Build flat list of actions. - $list[$prefixNname] = $action; + $list[$prefixName] = $action; } return $list; diff --git a/system/src/Grav/Framework/Cache/Adapter/FileCache.php b/system/src/Grav/Framework/Cache/Adapter/FileCache.php index 1995e159d..dc28afcff 100644 --- a/system/src/Grav/Framework/Cache/Adapter/FileCache.php +++ b/system/src/Grav/Framework/Cache/Adapter/FileCache.php @@ -156,7 +156,7 @@ class FileCache extends AbstractCache */ protected function initFileCache($namespace, $directory) { - if (!isset($directory[0])) { + if ($directory === '') { $directory = sys_get_temp_dir() . '/grav-cache'; } else { $directory = realpath($directory) ?: $directory; diff --git a/system/src/Grav/Framework/File/AbstractFile.php b/system/src/Grav/Framework/File/AbstractFile.php index b82bb33d2..0c78dd303 100644 --- a/system/src/Grav/Framework/File/AbstractFile.php +++ b/system/src/Grav/Framework/File/AbstractFile.php @@ -199,7 +199,7 @@ class AbstractFile implements FileInterface $lock = $block ? LOCK_EX : LOCK_EX | LOCK_NB; // Some filesystems do not support file locks, only fail if another process holds the lock. - $this->locked = flock($this->handle, $lock, $wouldblock) || !$wouldblock; + $this->locked = flock($this->handle, $lock, $wouldBlock) || !$wouldBlock; return $this->locked; } diff --git a/system/src/Grav/Framework/File/Formatter/IniFormatter.php b/system/src/Grav/Framework/File/Formatter/IniFormatter.php index ec169598e..2e7404b9c 100644 --- a/system/src/Grav/Framework/File/Formatter/IniFormatter.php +++ b/system/src/Grav/Framework/File/Formatter/IniFormatter.php @@ -12,6 +12,7 @@ declare(strict_types=1); namespace Grav\Framework\File\Formatter; use Grav\Framework\File\Interfaces\FileFormatterInterface; +use RuntimeException; /** * Class IniFormatter @@ -59,7 +60,7 @@ class IniFormatter extends AbstractFormatter $decoded = @parse_ini_string($data); if ($decoded === false) { - throw new \RuntimeException('Decoding INI failed'); + throw new RuntimeException('Decoding INI failed'); } return $decoded; diff --git a/system/src/Grav/Framework/File/Formatter/MarkdownFormatter.php b/system/src/Grav/Framework/File/Formatter/MarkdownFormatter.php index 8a624df55..a30d7a906 100644 --- a/system/src/Grav/Framework/File/Formatter/MarkdownFormatter.php +++ b/system/src/Grav/Framework/File/Formatter/MarkdownFormatter.php @@ -12,6 +12,7 @@ declare(strict_types=1); namespace Grav\Framework\File\Formatter; use Grav\Framework\File\Interfaces\FileFormatterInterface; +use RuntimeException; /** * Class MarkdownFormatter @@ -99,7 +100,7 @@ class MarkdownFormatter extends AbstractFormatter // Normalize line endings to Unix style. $encoded = preg_replace("/(\r\n|\r)/u", "\n", $encoded); if (null === $encoded) { - throw new \RuntimeException('Encoding markdown failed'); + throw new RuntimeException('Encoding markdown failed'); } return $encoded; @@ -126,7 +127,7 @@ class MarkdownFormatter extends AbstractFormatter // Normalize line endings to Unix style. $data = preg_replace("/(\r\n|\r)/u", "\n", $data); if (null === $data) { - throw new \RuntimeException('Decoding markdown failed'); + throw new RuntimeException('Decoding markdown failed'); } // Parse header. diff --git a/system/src/Grav/Framework/Flex/FlexCollection.php b/system/src/Grav/Framework/Flex/FlexCollection.php index 54e06654a..c76c3061b 100644 --- a/system/src/Grav/Framework/Flex/FlexCollection.php +++ b/system/src/Grav/Framework/Flex/FlexCollection.php @@ -460,7 +460,7 @@ class FlexCollection extends ObjectCollection implements FlexCollectionInterface * @param string $key * @return array */ - public function getMetaData(string $key): array + public function getMetaData($key): array { $object = $this->get($key); diff --git a/system/src/Grav/Framework/Flex/Interfaces/FlexCollectionInterface.php b/system/src/Grav/Framework/Flex/Interfaces/FlexCollectionInterface.php index 16be3d5d6..2510e5de7 100644 --- a/system/src/Grav/Framework/Flex/Interfaces/FlexCollectionInterface.php +++ b/system/src/Grav/Framework/Flex/Interfaces/FlexCollectionInterface.php @@ -140,5 +140,5 @@ interface FlexCollectionInterface extends FlexCommonInterface, ObjectCollectionI * @param string $key Key. * @return array */ - public function getMetaData(string $key): array; + public function getMetaData($key): array; } diff --git a/system/src/Grav/Framework/Flex/Interfaces/FlexFormInterface.php b/system/src/Grav/Framework/Flex/Interfaces/FlexFormInterface.php index 32dab1968..eaafaf01c 100644 --- a/system/src/Grav/Framework/Flex/Interfaces/FlexFormInterface.php +++ b/system/src/Grav/Framework/Flex/Interfaces/FlexFormInterface.php @@ -43,4 +43,9 @@ interface FlexFormInterface extends Serializable, FormInterface * @return Route|null Returns Route object or null if file uploads are not enabled. */ public function getFileDeleteAjaxRoute($field, $filename); + +// /** +// * @return FlexObjectInterface +// */ +// public function getObject(); } diff --git a/system/src/Grav/Framework/Form/FormFlashFile.php b/system/src/Grav/Framework/Form/FormFlashFile.php index dc510e28f..51c318346 100644 --- a/system/src/Grav/Framework/Form/FormFlashFile.php +++ b/system/src/Grav/Framework/Form/FormFlashFile.php @@ -11,6 +11,7 @@ namespace Grav\Framework\Form; use Grav\Framework\Psr7\Stream; use InvalidArgumentException; +use JsonSerializable; use Psr\Http\Message\StreamInterface; use Psr\Http\Message\UploadedFileInterface; use RuntimeException; @@ -23,7 +24,7 @@ use function sprintf; * Class FormFlashFile * @package Grav\Framework\Form */ -class FormFlashFile implements UploadedFileInterface, \JsonSerializable +class FormFlashFile implements UploadedFileInterface, JsonSerializable { /** @var string */ private $field; diff --git a/system/src/Grav/Framework/Media/Interfaces/MediaCollectionInterface.php b/system/src/Grav/Framework/Media/Interfaces/MediaCollectionInterface.php index a3587d8cb..e763f42d2 100644 --- a/system/src/Grav/Framework/Media/Interfaces/MediaCollectionInterface.php +++ b/system/src/Grav/Framework/Media/Interfaces/MediaCollectionInterface.php @@ -9,9 +9,13 @@ namespace Grav\Framework\Media\Interfaces; +use ArrayAccess; +use Countable; +use Iterator; + /** * Class implements media collection interface. */ -interface MediaCollectionInterface extends \ArrayAccess, \Countable, \Iterator +interface MediaCollectionInterface extends ArrayAccess, Countable, Iterator { } diff --git a/system/src/Grav/Framework/Object/Base/ObjectCollectionTrait.php b/system/src/Grav/Framework/Object/Base/ObjectCollectionTrait.php index 3c172fecd..c4c470539 100644 --- a/system/src/Grav/Framework/Object/Base/ObjectCollectionTrait.php +++ b/system/src/Grav/Framework/Object/Base/ObjectCollectionTrait.php @@ -11,6 +11,7 @@ namespace Grav\Framework\Object\Base; use Grav\Framework\Compat\Serializable; use Grav\Framework\Object\Interfaces\ObjectInterface; +use InvalidArgumentException; use function call_user_func_array; use function get_class; use function is_callable; @@ -51,6 +52,7 @@ trait ObjectCollectionTrait } $class = get_class($this); + return $type . strtolower(substr($class, strrpos($class, '\\') + 1)); } @@ -167,7 +169,7 @@ trait ObjectCollectionTrait protected function doUnserialize(array $data) { if (!isset($data['key'], $data['type'], $data['elements']) || $data['type'] !== $this->getType()) { - throw new \InvalidArgumentException("Cannot unserialize '{$this->getType()}': Bad data"); + throw new InvalidArgumentException("Cannot unserialize '{$this->getType()}': Bad data"); } $this->setKey($data['key']); diff --git a/system/src/Grav/Framework/Object/Collection/ObjectExpressionVisitor.php b/system/src/Grav/Framework/Object/Collection/ObjectExpressionVisitor.php index d8f152431..eaf589d86 100644 --- a/system/src/Grav/Framework/Object/Collection/ObjectExpressionVisitor.php +++ b/system/src/Grav/Framework/Object/Collection/ObjectExpressionVisitor.php @@ -9,6 +9,7 @@ namespace Grav\Framework\Object\Collection; +use ArrayAccess; use Closure; use Doctrine\Common\Collections\Expr\ClosureExpressionVisitor; use Doctrine\Common\Collections\Expr\Comparison; @@ -42,7 +43,7 @@ class ObjectExpressionVisitor extends ClosureExpressionVisitor $field = rtrim($field, ')'); } - if (isset($object[$field])) { + if ($object instanceof ArrayAccess && isset($object[$field])) { $value = $object[$field]; } else { $accessors = array('', 'get', 'is'); @@ -233,7 +234,7 @@ class ObjectExpressionVisitor extends ClosureExpressionVisitor }; default: - throw new RuntimeException("Unknown comparison operator: " . $comparison->getOperator()); + throw new RuntimeException('Unknown comparison operator: ' . $comparison->getOperator()); } } } diff --git a/system/src/Grav/Framework/Psr7/ServerRequest.php b/system/src/Grav/Framework/Psr7/ServerRequest.php index 40848345b..692e891a4 100644 --- a/system/src/Grav/Framework/Psr7/ServerRequest.php +++ b/system/src/Grav/Framework/Psr7/ServerRequest.php @@ -98,13 +98,8 @@ class ServerRequest implements ServerRequestInterface public function getCookieParam($key, $default = null) { $cookies = $this->getRequest()->getCookieParams(); - $result = $default; - if (isset($cookies[$key])) { - $result = $cookies[$key]; - } - - return $result; + return $cookies[$key] ?? $default; } /** @@ -238,13 +233,8 @@ class ServerRequest implements ServerRequestInterface public function getQueryParam($key, $default = null) { $getParams = $this->getQueryParams(); - $result = $default; - if (isset($getParams[$key])) { - $result = $getParams[$key]; - } - - return $result; + return $getParams[$key] ?? $default; } /** diff --git a/system/src/Grav/Framework/Route/Route.php b/system/src/Grav/Framework/Route/Route.php index f9a7fa722..078c09158 100644 --- a/system/src/Grav/Framework/Route/Route.php +++ b/system/src/Grav/Framework/Route/Route.php @@ -9,6 +9,7 @@ namespace Grav\Framework\Route; +use Grav\Framework\Uri\Uri; use Grav\Framework\Uri\UriFactory; use InvalidArgumentException; use function array_slice; @@ -318,7 +319,7 @@ class Route } /** - * @return \Grav\Framework\Uri\Uri + * @return Uri */ public function getUri() { diff --git a/system/src/Twig/DeferredExtension/DeferredNodeVisitorCompat.php b/system/src/Twig/DeferredExtension/DeferredNodeVisitorCompat.php index da5ff1add..1ff7fd421 100644 --- a/system/src/Twig/DeferredExtension/DeferredNodeVisitorCompat.php +++ b/system/src/Twig/DeferredExtension/DeferredNodeVisitorCompat.php @@ -22,6 +22,11 @@ final class DeferredNodeVisitorCompat implements NodeVisitorInterface { private $hasDeferred = false; + /** + * @param \Twig_NodeInterface $node + * @param Environment $env + * @return Node + */ public function enterNode(\Twig_NodeInterface $node, Environment $env): Node { if (!$this->hasDeferred && $node instanceof DeferredBlockNode) { @@ -33,6 +38,11 @@ final class DeferredNodeVisitorCompat implements NodeVisitorInterface return $node; } + /** + * @param \Twig_NodeInterface $node + * @param Environment $env + * @return Node|null + */ public function leaveNode(\Twig_NodeInterface $node, Environment $env): ?Node { if ($this->hasDeferred && $node instanceof ModuleNode) { @@ -46,6 +56,9 @@ final class DeferredNodeVisitorCompat implements NodeVisitorInterface return $node; } + /** + * @return int + */ public function getPriority() : int { return 0;