AbstractViewModel::isCached() - Code Metrics - Inspection of "REFORMAT todo" - sfneal/view-models - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d81bc3...4650e4 )

by Stephen

created 2021-02-02 19:29 UTC

AbstractViewModel::isCached() A

↳ Parent: AbstractViewModel

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

namespace Sfneal\ViewModels;

use Illuminate\Http\Response;
use Illuminate\Support\Facades\View;
use RuntimeException;
use Sfneal\Helpers\Redis\RedisCache;
use Sfneal\Helpers\Strings\StringHelpers;
use Spatie\ViewModels\ViewModel;

abstract class AbstractViewModel extends ViewModel
{
    // todo: add isCached method
    // todo: make more properties private and add getters/setters

    /**
     * @var int Time to live
     */
    public $ttl = null;

    /**
     * @var string Use manually declare redis_key (warning: can cause issues with caching)
     */
    public $redis_key = null;

    /**
     * View Directory Prefix.
     */
    public $prefix;

    /**
     * @var null View name
     */
    public $view = null;

    /**
     * Render the View.
     *
     * @return string
     */
    private function __render(): string
    {
        return View::make($this->view, $this->toArray())->render();
    }

    /**
     * Retrieve the authenticated user's ID from the session.
     *
     *  - avoid executing database query
     *  // todo: make this optional, we dont always want to tag cached pages by user
     *
     * @return int
     */
    private function userId(): int
    {
        try {
            // Find the 'login_web' session key that holds the authenticated user_id value
            // If there's no key containing 'login_web' the user is not logged in
            $session_key = collect(request()->session()->all())->keys()->filter(function ($key) {
                return is_string($key) && (new StringHelpers($key))->inString('login_web');
            })->first();
        } catch (RuntimeException $runtimeException) {
            // request and/or session is not set (called from a job)
            $session_key = 0;
        }

        // Get the $session_key if it's not null
        return ! empty($session_key) ? session()->get($session_key) : 0;
    }

    /**
     * Retrieve a unique redis key for caching the view.
     *
     * // todo: add property?
     * @return string
     */
    public function cacheKey(): string
    {
        return 'views'.
            ':'.$this->view.
            '#'.$this->userId().
            '#'.(isset($this->redis_key) ? $this->redis_key : request()->fullUrl());
    }

    /**
     * Set an override Redis Key.
     *
     * @param string $redis_key
     * @return $this
     */
    public function setRedisKey(string $redis_key): self
    {
        $this->redis_key = $redis_key;

        return $this;
    }

    /**
     * Retrieve/render the ViewModel from/to the application cache.
     *
     * @param string|null $view
     * @param int|null $ttl
     * @return string
     */
    public function render(string $view = null, int $ttl = null): string
    {
        // Set $view if it is not null
        if ($view) {
            $this->view = $view;

        }

        // Cache the View if it doesn't exist
        return RedisCache::remember($this->cacheKey(), $this->getTTL($ttl), function () {
            return $this->__render();
        });
    }

    /**
     * Render the ViewModel without storing or retrieving from the Cache.
     *
     * @param string|null $view
     * @return Response|string|mixed
     */
    public function renderNoCache(string $view = null)
    {
        // Set $view if it is not null
        if ($view) {
            $this->view = $view;

        }

        return $this->__render();
    }

    /**
     * Invalidate the View Cache for this ViewModel.
     *
     * @return $this
     */
    public function invalidateCache(): self
    {
        RedisCache::delete('views:'.$this->view);

        return $this;
    }

    /**
     * Determine if the ViewModel has been cached.
     *
     * @return bool
     */
    public function isCached(): bool
    {
        return RedisCache::exists($this->cacheKey());
    }

    /**
     * Return a concatenated route or view name by using the PREFIX const.
     *
     * @param string $string
     * @return $this
     */
    public function viewWithPrefix(string $string): self
    {
        $this->view = $this->prefix.$string;


        return $this;
    }

    /**
     * Extend a view name.
     *
     * @param string $string
     * @return $this
     */
    public function viewExtend(string $string): self
    {
        $this->view .= $string;

        return $this;
    }

    /**
     * Retrieve the time to live for the cached values
     *  - 1. passed $ttl parameter
     *  - 2. initialized $this->ttl property
     *  - 3. application default cache ttl.
     *
     * @param int|null $ttl
     * @return int
     */
    public function getTTL(int $ttl = null): int
    {
        return intval($ttl ?? $this->ttl ?? config('redis-helpers.ttl'));
    }

    /**
     * Set the $ttl property during runtime.
     *
     * @param int $ttl
     * @return $this
     */
    public function setTTL(int $ttl): self
    {
        $this->ttl = $ttl;

        return $this;
    }

    // todo: fix issues with getTTL & setTTL methods
}


1			<?php
2
3			namespace Sfneal\ViewModels;
4
5			use Illuminate\Http\Response;
6			use Illuminate\Support\Facades\View;
7			use RuntimeException;
8			use Sfneal\Helpers\Redis\RedisCache;
9			use Sfneal\Helpers\Strings\StringHelpers;
10			use Spatie\ViewModels\ViewModel;
11
12			abstract class AbstractViewModel extends ViewModel
13			{
14			// todo: add isCached method
15			// todo: make more properties private and add getters/setters
16
17			/**
18			* @var int Time to live
19			*/
20			public $ttl = null;
21
22			/**
23			* @var string Use manually declare redis_key (warning: can cause issues with caching)
24			*/
25			public $redis_key = null;
26
27			/**
28			* View Directory Prefix.
29			*/
30			public $prefix;
31
32			/**
33			* @var null View name
34			*/
35			public $view = null;
36
37			/**
38			* Render the View.
39			*
40			* @return string
41			*/
42			private function __render(): string
43			{
44			return View::make($this->view, $this->toArray())->render();
45			}
46
47			/**
48			* Retrieve the authenticated user's ID from the session.
49			*
50			* - avoid executing database query
51			* // todo: make this optional, we dont always want to tag cached pages by user
52			*
53			* @return int
54			*/
55			private function userId(): int
56			{
57			try {
58			// Find the 'login_web' session key that holds the authenticated user_id value
59			// If there's no key containing 'login_web' the user is not logged in
60			$session_key = collect(request()->session()->all())->keys()->filter(function ($key) {
61			return is_string($key) && (new StringHelpers($key))->inString('login_web');
62			})->first();
63			} catch (RuntimeException $runtimeException) {
64			// request and/or session is not set (called from a job)
65			$session_key = 0;
66			}
67
68			// Get the $session_key if it's not null
69			return ! empty($session_key) ? session()->get($session_key) : 0;
70			}
71
72			/**
73			* Retrieve a unique redis key for caching the view.
74			*
75			* // todo: add property?
76			* @return string
77			*/
78			public function cacheKey(): string
79			{
80			return 'views'.
81			':'.$this->view.
82			'#'.$this->userId().
83			'#'.(isset($this->redis_key) ? $this->redis_key : request()->fullUrl());
84			}
85
86			/**
87			* Set an override Redis Key.
88			*
89			* @param string $redis_key
90			* @return $this
91			*/
92			public function setRedisKey(string $redis_key): self
93			{
94			$this->redis_key = $redis_key;
95
96			return $this;
97			}
98
99			/**
100			* Retrieve/render the ViewModel from/to the application cache.
101			*
102			* @param string\|null $view
103			* @param int\|null $ttl
104			* @return string
105			*/
106			public function render(string $view = null, int $ttl = null): string
107			{
108			// Set $view if it is not null
109			if ($view) {
110			$this->view = $view;
			0 ignored issues – show Documentation Bug introduced 2020-08-19 17:13 UTC by Report Bug Copy Issue Report It seems like `$view` of type `string` is incompatible with the declared type `null` of property `$view`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
111			}
112
113			// Cache the View if it doesn't exist
114			return RedisCache::remember($this->cacheKey(), $this->getTTL($ttl), function () {
115			return $this->__render();
116			});
117			}
118
119			/**
120			* Render the ViewModel without storing or retrieving from the Cache.
121			*
122			* @param string\|null $view
123			* @return Response\|string\|mixed
124			*/
125			public function renderNoCache(string $view = null)
126			{
127			// Set $view if it is not null
128			if ($view) {
129			$this->view = $view;
			0 ignored issues – show Documentation Bug introduced 2020-08-19 17:13 UTC by Report Bug Copy Issue Report It seems like `$view` of type `string` is incompatible with the declared type `null` of property `$view`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
130			}
131
132			return $this->__render();
133			}
134
135			/**
136			* Invalidate the View Cache for this ViewModel.
137			*
138			* @return $this
139			*/
140			public function invalidateCache(): self
141			{
142			RedisCache::delete('views:'.$this->view);
143
144			return $this;
145			}
146
147			/**
148			* Determine if the ViewModel has been cached.
149			*
150			* @return bool
151			*/
152			public function isCached(): bool
153			{
154			return RedisCache::exists($this->cacheKey());
155			}
156
157			/**
158			* Return a concatenated route or view name by using the PREFIX const.
159			*
160			* @param string $string
161			* @return $this
162			*/
163			public function viewWithPrefix(string $string): self
164			{
165			$this->view = $this->prefix.$string;
			0 ignored issues – show Documentation Bug introduced 2020-08-19 17:13 UTC by Report Bug Copy Issue Report It seems like `$this->prefix . $string` of type `string` is incompatible with the declared type `null` of property `$view`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
166
167			return $this;
168			}
169
170			/**
171			* Extend a view name.
172			*
173			* @param string $string
174			* @return $this
175			*/
176			public function viewExtend(string $string): self
177			{
178			$this->view .= $string;
179
180			return $this;
181			}
182
183			/**
184			* Retrieve the time to live for the cached values
185			* - 1. passed $ttl parameter
186			* - 2. initialized $this->ttl property
187			* - 3. application default cache ttl.
188			*
189			* @param int\|null $ttl
190			* @return int
191			*/
192			public function getTTL(int $ttl = null): int
193			{
194			return intval($ttl ?? $this->ttl ?? config('redis-helpers.ttl'));
195			}
196
197			/**
198			* Set the $ttl property during runtime.
199			*
200			* @param int $ttl
201			* @return $this
202			*/
203			public function setTTL(int $ttl): self
204			{
205			$this->ttl = $ttl;
206
207			return $this;
208			}
209
210			// todo: fix issues with getTTL & setTTL methods
211			}
212

sfneal / view-models

Push — master ( d81bc3...4650e4 )

AbstractViewModel::isCached() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like