vipnytt\RobotsTxtParser\Client\RenderClient

Complexity

Total Complexity

7

Size/Duplication

Total Lines	87
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	compatibility()	0	4	1
A	generate()	0	14	3
A	normal()	0	4	1
A	compressed()	0	4	1

<?php
/**
 * vipnytt/RobotsTxtParser
 *
 * @link https://github.com/VIPnytt/RobotsTxtParser
 * @license https://github.com/VIPnytt/RobotsTxtParser/blob/master/LICENSE The MIT License (MIT)
 */

namespace vipnytt\RobotsTxtParser\Client;

use vipnytt\RobotsTxtParser\Handler\Directives\RootDirectiveHandler;
use vipnytt\RobotsTxtParser\Handler\RenderHandler;
use vipnytt\RobotsTxtParser\RobotsTxtInterface;

/**
 * Class RenderClient
 *
 * @package vipnytt\RobotsTxtParser\Client
 */
class RenderClient implements RobotsTxtInterface
{
    /**
     * Handler
     * @var RootDirectiveHandler
     */
    private $root;

    /**
     * RenderClient constructor.
     *
     * @param RootDirectiveHandler $handler
     */
    public function __construct(RootDirectiveHandler $handler)
    {
        $this->root = $handler;
    }

    /**
     * Compatibility optimized robots.txt
     *
     * Differences compared to Normal:
     * - Each User-agent is listed with it's own separate rule set (even if it's equal to others)
     * - Byte consuming, may be multiple times larger (depending on the number of user-agents)
     * - Maximum compatibility, optimized for badly written 3rd party parsers with limited specification support
     *
     * @param string $eol
     * @return string
     */
    public function compatibility($eol = "\r\n")
    {
        return $this->generate(2, $eol) . $eol;
    }

    /**
     * Generate an rule string array
     *
     * @param int $level
     * @param string $eol
     * @return string
     */
    private function generate($level, $eol)
    {
        $handler = new RenderHandler($level, $eol);
        if ($level == 2) {
            $this->root->userAgent->render($handler);
        }
        $this->root->host->render($handler);
        $this->root->cleanParam->render($handler);
        $this->root->sitemap->render($handler);
        if ($level != 2) {
            $this->root->userAgent->render($handler);
        }
        return $handler->generate();
    }

    /**
     * Normal looking robots.txt
     *
     * Differences compared to Compressed:
     * - The directives first character is uppercase
     * - Whitespace between the directive and it's value
     * - Easy to edit
     * - User-agent groups are separated with blank lines
     *
     * @param string $eol
     * @return string
     */
    public function normal($eol = "\r\n")
    {
        return $this->generate(1, $eol);
    }

    /**
     * Compressed robots.txt
     *
     * Generates an robots.txt compressed to a absolute minimum.
     * Best suited for parsing purposes and storage in databases.
     *
     * @param string $eol
     * @return string
     */
    public function compressed($eol = PHP_EOL)
    {
        return $this->generate(0, $eol);
    }
}