process_admin_request() - Code Metrics - Inspection of "Latest" - ColonelBlimp/html-go - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — main ( 415e55...cf1b5a )

by Marc
created 2021-07-11 07:42 UTC
process_admin_request() A

↳ Parent: Project
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	2
c	1
b	0
f	0
nc	1
nop	2
dl	0
loc	3
rs	10
<?php declare(strict_types=1);

use html_go\exceptions\InternalException;
use html_go\model\Config;

/**
 * The main entry point. Called from <code>index.php</code> in the application
 * root. The parameters are provided for testing thus they have default values.
 * @param string $uri
 * @param string $method
 * @return string The html to be rendered.
 */
function dispatch(string $uri = null, string $method = HTTP_GET): string {
    if ($uri === null) {
        $uri = $_SERVER['REQUEST_URI']; // @codeCoverageIgnore
        $method = \strtoupper($_SERVER['REQUEST_METHOD']); // @codeCoverageIgnore
    }
    $uri = strip_url_parameters($uri);
    $uri = \trim($uri, FWD_SLASH);
    if (empty($uri)) {
        $uri = HOME_INDEX_KEY;
    }
    return route($uri, $method);
}

/**
 * Route the given HTTP request.
 * @param string $uri The requested URI
 * @param string $method the HTTP method
 * @throws InternalException
 * @return string
 */
function route(string $uri, string $method): string {
    if ($method === HTTP_POST) {
        return not_found();
    }

    $result = \preg_match(POST_REQ_REGEX, $uri);
    if ($result === false) {
        throw new InternalException("preg_match() failed checking [$uri]"); // @codeCoverageIgnore
    }

    $adminCtx = get_config()->getString(Config::KEY_ADMIN_CONTEXT);
    if ($result === SINGLE_POST_REQUEST) {
        $content = get_content_object($uri);
    } elseif (\str_starts_with($uri, $adminCtx)) {
        $content = process_admin_request($uri, $method);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
    } else {
        $content = process_request($uri, get_pagination_pagenumber(), get_config()->getInt(Config::KEY_POSTS_PERPAGE));
    }

    if ($content === null) {
        return not_found();
    }

    return render(vars: get_template_context($content));
}

/**
 * Process a request for a single blog-post.
 * @param string $uri
 * @param int $pageNum
 * @param int $perPage
 * @return \stdClass|NULL
 */
function process_request(string $uri, int $pageNum, int $perPage): ?\stdClass {
    $template = LIST_TEMPLATE;

    if (HOME_INDEX_KEY === $uri) {
        return get_homepage($pageNum, $perPage);
    }

    $list = is_landing_page($uri, $pageNum, $perPage);
    if (empty($list)) {
        $list = is_list_page($uri, $pageNum, $perPage);
        if (empty($list)) {
            $template = SINGLE_TEMPLATE;
        }
    }

    return get_content_object($uri, $list, $template);
}

/**
 * Process a request for an admin page.
 * @param string $uri
 * @param string $method
 * @return \stdClass|NULL
 */
function process_admin_request(string $uri, string $method): ?\stdClass {
function process_admin_request(string $uri, /** @scrutinizer ignore-unused */ string $method): ?\stdClass {
    require_once ADMIN_SYS_ROOT.DS.'functions.php';
    exit('admin page');

}

/**
 * Checks if the given URI is a landing page (excluding the home page), if so returns a list of the
 * appropriate content objects for that page.
 * @param string $uri
 * @return array<\stdClass>
 */
function is_landing_page(string $uri, int $pageNum = 1, int $perPage = 0): array {
    $list = [];
    switch (true) {
        case $uri === CAT_INDEX_KEY:
            $list = get_categories($pageNum, $perPage);
            break;
        case $uri === POST_INDEX_KEY:
            $list = get_posts($pageNum, $perPage);
            break;
        case $uri === TAG_INDEX_KEY:
            $list = get_tags($pageNum, $perPage);
            break;
        default:
            // Do nothing
    }
    return $list;
}

/**
 * Checks if the given URI is a list page (excluding the home page), if so returns a list of the
 * approriate content object for that page.
 * @param string $uri
 * @param int $pageNum
 * @param int $perPage
 * @return array<\stdClass>
 */
function is_list_page(string $uri, int $pageNum = 1, int $perPage = 0): array {
    $list = [];
    switch (true) {
        case \str_starts_with($uri, POST_INDEX_KEY):
            $list = get_posts($pageNum, $perPage);
            break;
        case \str_starts_with($uri, CAT_INDEX_KEY.FWD_SLASH):
            $list = get_posts_for_category($uri, $pageNum, $perPage);
            break;
        case \str_starts_with($uri, TAG_INDEX_KEY.FWD_SLASH):
            $list = get_posts_for_tag($uri, $pageNum, $perPage);
            break;
        default:
            // Do nothing
    }
    return $list;
}

/**
 * Returns the home page.
 * @param int $pageNum
 * @param int $perPage
 * @throws InternalException
 * @return \stdClass
 */
function get_homepage(int $pageNum, int $perPage): \stdClass {
    if (get_config()->getBool(Config::KEY_STATIC_INDEX)) {
        if (($content = get_content_object(HOME_INDEX_KEY, /** @scrutinizer ignore-type */ template: SINGLE_TEMPLATE)) === null) {
            throw new InternalException("Unable to find the home index page!");
        }
    } else {
        if (($content = get_content_object(HOME_INDEX_KEY, get_posts($pageNum, $perPage), LIST_TEMPLATE)) === null) {
            throw new InternalException("Unable to find the home index page!");
        }
    }
    return $content;
}

/**
 * Strips parameters from the given URL.
 * @param string $url
 * @return string returns the URL without the parameters.
 */
function strip_url_parameters(string $url): string {
    if (($pos = \strpos($url, '?')) === false) {
        return $url;
    }
    parse_query(\substr($url, $pos + 1));
    return \substr($url, 0, $pos);
}

/**
 * @param string $query (Optional). Calling with this parameter set will populate the returned data array.
 * @return array<string, string>
 */
function parse_query(string $query = null): array {
    static $data = [];
    if (empty($data) && $query !== null) {
        \parse_str($query, $data);
    }
    return $data;
}

/**
 * Return the query string value for the given key.
 * @param string $key
 * @return string|NULL <code>null</code> if the key is not found
 */
function get_query_parameter(string $key): ?string {
    $params = parse_query();
    if (isset($params[$key])) {
        return $params[$key];
    }
    return null;
}

ColonelBlimp / html-go

Push — main ( 415e55...cf1b5a )

process_admin_request() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
