vipnytt\RobotsTxtParser\ObjectTools

Complexity

Total Complexity

12

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	checkPath()	0	17	5
A	generateRulePair()	0	19	4
A	getPath()	0	12	3

<?php
namespace vipnytt\RobotsTxtParser;

trait ObjectTools
{
    /**
     * Check basic rule
     *
     * @param string $path
     * @param array $paths
     * @return bool
     */
    public function checkPath($path, $paths)
    {
        // bug: https://github.com/t1gor/Robots.txt-Parser-Class/issues/62
        foreach ($paths as $robotPath) {
            $escaped = strtr($robotPath, ["@" => '\@']);
            if (preg_match('@' . $escaped . '@', $path)) {
                if (mb_stripos($escaped, '$') !== false) {
                    if (mb_strlen($escaped) - 1 == mb_strlen($path)) {
                        return true;
                    }
                } else {
                    return true;
                }
            }
        }
        return false;
    }

    /**
     * Generate directive/rule pair
     *
     * @param string $line
     * @param array $whiteList
     * @return array|false
     */
    protected function generateRulePair($line, $whiteList)
    {
        $whiteList = array_map('mb_strtolower', $whiteList);
        // Split by directive and rule
        $pair = array_map('trim', mb_split(':', $line, 2));
        // Check if the line contains a rule
        if (
            empty($pair[1]) ||
            empty($pair[0]) ||
            !in_array(($pair[0] = mb_strtolower($pair[0])), $whiteList)
        ) {
            // Line does not contain any supported directive
            return false;
        }
        return [
            'directive' => $pair[0],
            'value' => $pair[1],
        ];
    }

    /**
     * Get path
     *
     * @param string $url
     * @return string
     * @throws Exceptions\ClientException
     */
    protected function getPath($url)
    {
        $url = $this->urlEncode($url);

It seems like urlEncode() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        if (mb_stripos($url, '/') === 0) {
            // URL already is a path
            return $url;
        }
        if (!$this->urlValidate($url)) {

It seems like urlValidate() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            throw new Exceptions\ClientException('Invalid URL');
        }
        return parse_url($url, PHP_URL_PATH);
    }
}