EtagConditionals::getEtag() - Code Metrics - Inspection of "Generate ETag using a callback" - 365Werk/etagconditionals - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#10)

unknown

created 2021-05-18 21:56 UTC

EtagConditionals::getEtag() A

↳ Parent: EtagConditionals

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	5
nc	2
nop	2
dl	0
loc	9
rs	10
c	0
b	0
f	0

<?php

namespace Werk365\EtagConditionals;

use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Str;
use Symfony\Component\HttpFoundation\Response;

class EtagConditionals
{
    /**
     * The callback used to generate the ETag.
     *
     * @var \Closure|null
     */
    protected static $etagGenerateCallback;

    /**
     * Set a callback that should be used when generating the ETag.
     *
     * @param  \Closure|null  $callback
     * @return void
     */
    public static function etagGenerateUsing(?Closure $callback): void
    {
        static::$etagGenerateCallback = $callback;
    }

    /**
     * Get ETag value for this request and response.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Symfony\Component\HttpFoundation\Response  $response
     * @return string
     */
    public static function getEtag(Request $request, Response $response): string
    {
        if (static::$etagGenerateCallback) {
            $etag = call_user_func(static::$etagGenerateCallback, $request, $response);
        } else {
            $etag = static::defaultGetEtag($response);
        }

        return (string) Str::of($etag)->start('"')->finish('"');
    }

    /**
     * Get default ETag value.
     *
     * @param  \Symfony\Component\HttpFoundation\Response  $response
     * @return string
     */
    private static function defaultGetEtag(Response $response): string
    {
        return md5($response->getContent());
    }
}


1			<?php
2
3			namespace Werk365\EtagConditionals;
4
5			use Closure;
6			use Illuminate\Http\Request;
7			use Illuminate\Support\Str;
8			use Symfony\Component\HttpFoundation\Response;
9
10			class EtagConditionals
11			{
12			/**
13			* The callback used to generate the ETag.
14			*
15			* @var \Closure\|null
16			*/
17			protected static $etagGenerateCallback;
18
19			/**
20			* Set a callback that should be used when generating the ETag.
21			*
22			* @param \Closure\|null $callback
23			* @return void
24			*/
25			public static function etagGenerateUsing(?Closure $callback): void
26			{
27			static::$etagGenerateCallback = $callback;
28			}
29
30			/**
31			* Get ETag value for this request and response.
32			*
33			* @param \Illuminate\Http\Request $request
34			* @param \Symfony\Component\HttpFoundation\Response $response
35			* @return string
36			*/
37			public static function getEtag(Request $request, Response $response): string
38			{
39			if (static::$etagGenerateCallback) {
40			$etag = call_user_func(static::$etagGenerateCallback, $request, $response);
41			} else {
42			$etag = static::defaultGetEtag($response);
43			}
44
45			return (string) Str::of($etag)->start('"')->finish('"');
46			}
47
48			/**
49			* Get default ETag value.
50			*
51			* @param \Symfony\Component\HttpFoundation\Response $response
52			* @return string
53			*/
54			private static function defaultGetEtag(Response $response): string
55			{
56			return md5($response->getContent());
57			}
58			}
59

365Werk / etagconditionals

Pull Request — master (#10)

EtagConditionals::getEtag() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like