ViewHelper::renderBreadcrumbs() - Code Metrics - Inspection of "added - join table tests, example, table alias set..." - bartko-s/stefano-tree - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( e67729...75d57c )

by Bartko

created 2017-10-16 20:33 UTC

ViewHelper::renderBreadcrumbs() A

↳ Parent: ViewHelper

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * Quick end dirty solution only for demonstration purpose.
 */
declare(strict_types=1);

use StefanoTree\Exception\ValidationException;
use StefanoTree\TreeInterface;

session_start();

include_once __DIR__.'/../vendor/autoload.php';

$config = include_once __DIR__.'/config.php';

$dbAdapter = \Doctrine\DBAL\DriverManager::getConnection(
    $config['dbConnection'],
    new \Doctrine\DBAL\Configuration()
);

/**************************************
 *    Tree Adapter
 **************************************/
$treeAdapter = \StefanoTree\NestedSet::factory(
    array(
        'tableName' => 'categories',
        'idColumnName' => 'id',
        'sequenceName' => 'categories_id_seq',
        'scopeColumnName' => 'group_id',
    ),
    $dbAdapter
);

/***************************************
 * Join example
 ***************************************/
/*

$select = $dbAdapter->createQueryBuilder();
$select->from('categories' ,'c')
       ->select('c.*', '...')
       ->leftJoin('c', 'metadata', 'm', 'm.id = c.id');

$adapter = $treeAdapter
    ->getAdapter()
    ->setDefaultDbSelect($select);
*/

class Service
namespace YourVendor;

class YourClass { }
{
    private $treeAdapter;

    public function __construct(TreeInterface $treeAdapter)
    {
        $this->treeAdapter = $treeAdapter;
    }

    private function getTreeAdapter(): TreeInterface
    {
        return $this->treeAdapter;
    }

    public function createRoot(array $data): void
    {
        $errors = array();

        $label = $data['label'] ?? '';
        if (0 == strlen($label)) {
            $errors[] = 'Root Name cannot be empty.';
        } elseif (15 < strlen($label)) {
            $errors[] = 'Root Name is too long. Max length is 15 characters.';
        }

        $scope = $data['scope'] ?? '';
        if (0 === strlen($scope)) {
            $errors[] = 'Scope Name cannot be empty.';
        } elseif (!preg_match('|^[1-9][0-9]*$|', $scope)) {
            $errors[] = 'Scope Name must be integer.';
        } elseif (15 < strlen($scope)) {
            $errors[] = 'Scope Name is too long. Max length is 15 characters.';
        }

        if (count($errors)) {
            throw new ValidationError($errors);
        }

        $data = array(
            'name' => $label,
        );

        try {
            $this->getTreeAdapter()
                ->createRootNode($data, $scope);
        } catch (ValidationException $e) {
            throw new ValidationError([$e->getMessage()]);
        }
    }

    public function createNode(array $data): void
    {
        $errors = array();

        $targetId = $_POST['target_node_id'] ?? '';
        if (0 === strlen($targetId)) {
            $errors[] = 'Target Node cannot be empty.';
        }

        $label = $data['label'] ?? '';
        if (0 == strlen($label)) {
            $errors[] = 'Name cannot be empty.';
        } elseif (15 < strlen($label)) {
            $errors[] = 'Name is too long. Max length is 15 characters.';
        }

        $placement = $data['placement'] ?? '';
        if (0 == strlen($placement)) {
            $errors[] = 'Placement cannot be empty.';
        }

        $data = array(
            'name' => $label,
        );

        if (count($errors)) {
            throw new ValidationError($errors);
        }

        try {
            $this->getTreeAdapter()
                ->addNode($targetId, $data, $placement);
        } catch (ValidationException $e) {
            throw new ValidationError([$e->getMessage()]);
        }
    }

    public function deleteNode(array $data): void
    {
        $errors = array();

        $id = $data['id'] ?? '';

        if (0 == strlen($id)) {
            $errors[] = 'Id is missing. Cannot perform delete operation.';
        }

        if (count($errors)) {
            throw new ValidationError($errors);
        }

        $this->getTreeAdapter()
            ->deleteBranch($id);
    }

    public function updateNode(array $data): void
    {
        $errors = array();

        $nodeId = $_POST['node_id'] ?? '';
        if (0 === strlen($nodeId)) {
            $errors[] = 'Node cannot be empty.';
        }

        $label = $data['label'] ?? '';
        if (0 == strlen($label)) {
            $errors[] = 'Name cannot be empty.';
        } elseif (15 < strlen($label)) {
            $errors[] = 'Name is too long. Max length is 15 characters.';
        }

        $data = array(
            'name' => $label,
        );

        if (count($errors)) {
            throw new ValidationError($errors);
        }

        try {
            $this->getTreeAdapter()
                ->updateNode($nodeId, $data);
        } catch (ValidationException $e) {
            throw new ValidationError([$e->getMessage()]);
        }
    }

    public function moveNode(array $data): void
    {
        $errors = array();

        $sourceId = $data['source_node_id'] ?? '';
        if (0 == strlen($sourceId)) {
            $errors[] = 'Source Node cannot be empty.';
        }

        $targetId = $data['target_node_id'] ?? '';
        if (0 == strlen($targetId)) {
            $errors[] = 'Target Node cannot be empty.';
        }

        $placement = $data['placement'] ?? '';
        if (0 == strlen($placement)) {
            $errors[] = 'Placement cannot be empty.';
        }

        if (count($errors)) {
            throw new ValidationError($errors);
        }

        try {
            $this->getTreeAdapter()
                ->moveNode($sourceId, $targetId, $placement);
        } catch (ValidationException $e) {
            throw new ValidationError([$e->getMessage()]);
        }
    }

    public function getRoots(): array
    {
        return $this->getTreeAdapter()
                    ->getRoots();
    }

    public function getDescendants($nodeId): array
    {
        return $this->getTreeAdapter()
            ->getDescendantsQueryBuilder()
            ->get($nodeId);
    }

    public function findDescendants(array $criteria): array
    {
        $queryBuilder = $this->getTreeAdapter()
            ->getDescendantsQueryBuilder();

        $errors = array();

        $nodeId = $criteria['node_id'] ?? '';
        if (0 === strlen($nodeId)) {
            $errors[] = 'Node cannot be empty.';
        }

        $excludeFirstNLevel = $criteria['exclude_first_n_level'] ?? null;
        if (null !== $excludeFirstNLevel) {
            if (!preg_match('|^[0-9]*$|', $excludeFirstNLevel)) {
                $errors[] = 'Exclude First N Level  must be positive integer,';
            } else {
                $queryBuilder->excludeFirstNLevel((int) $excludeFirstNLevel);
            }
        }

        $levelLimit = $criteria['level_limit'] ?? null;
        if (null !== $levelLimit) {
            if (!preg_match('|^[0-9]*$|', $levelLimit)) {
                $errors[] = 'Level limit must be positive integer,';
            } else {
                $queryBuilder->levelLimit((int) $levelLimit);
            }
        }

        $excludeBranch = $criteria['exclude_node_id'] ?? null;
        if (null !== $excludeBranch) {
            $queryBuilder->excludeBranch($excludeBranch);
        }

        if (count($errors)) {
            throw new ValidationError($errors);
        }

        return $queryBuilder->get($nodeId);
    }

    public function findAncestors(array $criteria): array
    {
        $queryBuilder = $this->getTreeAdapter()
            ->getAncestorsQueryBuilder();

        $errors = array();

        $nodeId = $criteria['node_id'] ?? '';
        if (0 === strlen($nodeId)) {
            $errors[] = 'Node cannot be empty.';
        }

        $excludeFirstNLevel = $criteria['exclude_first_n_level'] ?? null;
        if (null !== $excludeFirstNLevel) {
            if (!preg_match('|^[0-9]*$|', $excludeFirstNLevel)) {
                $errors[] = 'Exclude First N Level  must be positive integer,';
            } else {
                $queryBuilder->excludeFirstNLevel((int) $excludeFirstNLevel);
            }
        }

        $excludeLastNLevel = $criteria['exclude_last_n_level'] ?? null;
        if (null !== $excludeLastNLevel) {
            if (!preg_match('|^[0-9]*$|', $excludeLastNLevel)) {
                $errors[] = 'Exclude Last N Level  must be positive integer,';
            } else {
                $queryBuilder->excludeLastNLevel((int) $excludeLastNLevel);
            }
        }

        if (count($errors)) {
            throw new ValidationError($errors);
        }

        return $queryBuilder->get($nodeId);
    }
}

class ViewHelper
namespace YourVendor;

class YourClass { }
{
    public function escape($string): string
    {
        return htmlspecialchars((string) $string);
    }

    public function renderTree(array $nodes): string
    {
        $html = '';

        $previousLevel = -1;
        foreach ($nodes as $node) {
            if ($previousLevel > $node['level']) {
                for ($i = $node['level']; $previousLevel > $i; ++$i) {
                    $html = $html.'</li></ul>';
                }
                $html = $html.'</li>';
            } elseif ($previousLevel < $node['level']) {
                $html = $html.'<ul>';
            } else {
                $html = $html.'</li>';
            }

            $html = $html.'<li>';
            $html = $html.'<span>'.$this->escape($node['name']).'</span>'
                .' <a href="/?action=delete&id='.$this->escape($node['id']).'" class="badge badge-danger">Delete</a>';

            $previousLevel = $node['level'];
        }

        for ($i = -1; $previousLevel > $i; ++$i) {
            $html = $html.'</li></ul>';
        }

        return $html;
    }

    public function renderBreadcrumbs(array $nodes): string
    {
        $html = '';

        foreach ($nodes as $node) {
            $html .= '<a class="breadcrumb-item" href="#">'.$this->escape($node['name']).'</a>';
        }

        return '<nav class="breadcrumb">'.$html.'</nav>';
    }

    public function renderSelectOptions(array $nodes): string
    {
        $pathCache = array();

        $html = '';

        foreach ($nodes as $node) {
            if (!$node['parent_id']) {
                $pathCache[$node['id']] = '/'.$node['name'];
            } else {
                $pathCache[$node['id']] = $pathCache[$node['parent_id']].'/'.$node['name'];
            }
            $html .= '<option value="'.$this->escape($node['id']).'">'.$this->escape($pathCache[$node['id']]).'</option>';
        }

        return '<option value="">---</option>'.$html;
    }

    public function renderPlacementOptions(): string
    {
        $placements = array(
            TreeInterface::PLACEMENT_CHILD_TOP => 'Child Top',
            TreeInterface::PLACEMENT_CHILD_BOTTOM => 'Child Bottom',
            TreeInterface::PLACEMENT_TOP => 'Top',
            TreeInterface::PLACEMENT_BOTTOM => 'Bottom',
        );

        $html = '';

        foreach ($placements as $id => $placement) {
            $html .= '<option value="'.$this->escape($id).'">'.$this->escape($placement).'</option>';
        }

        return '<option value="">---</option>'.$html;
    }

    public function renderErrorMessages(array $errors): string
    {
        $html = '';

        foreach ($errors as $error) {
            $html .= '<li>'.$this->escape($error).'</li>';
        }

        return '<div class="alert alert-danger"><ul class="error-container">'.$html.'</ul></div>';
    }

    public function renderSuccessMessage(string $message): string
    {
        return '<div class="alert alert-success">'.$this->escape($message).'</div>';
    }

    public function renderFlashMessage(): string
    {
        $message = $_SESSION['flashMessage'] ?? '';

        if ($message) {
            unset($_SESSION['flashMessage']);

            return $this->renderSuccessMessage($message);
        } else {
            return '';
        }
    }
}

class ValidationError extends \Exception
namespace YourVendor;

class YourClass { }
{
    private $errorMessages = array();

    public function __construct(array $errorMessages = array())
    {
        $this->errorMessages = $errorMessages;
    }

    public function addError(string $error): void
    {
        $this->errorMessages[] = $error;
    }

    public function addErrors(array $errors): void
    {
        $this->errorMessages = array_merge(array_values($errors), $this->errorMessages);
    }

    public function getErrors(): array
    {
        return $this->errorMessages;
    }
}

function setFlashMessageAndRedirect(string $message, string $url)
{
    $_SESSION['flashMessage'] = $message;
    $redirectUrl = (isset($_SERVER['HTTPS']) ? 'https' : 'http')."://$_SERVER[HTTP_HOST]$url";
    header(sprintf('Location: %s', $redirectUrl));
    die();
}

/************************************
 *    Router
 ***********************************/
$service = new Service($treeAdapter);

try {
    switch ($_GET['action'] ?? '') {
        case 'create-scope':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
            $service->createRoot($_POST);
            setFlashMessageAndRedirect('New root node and scope was successfully created.', '/');
            break;
        case 'create-node':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
            $service->createNode($_POST);
            setFlashMessageAndRedirect('New node was successfully created.', '/');
            break;
        case 'move-node':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
            $service->moveNode($_POST);
            setFlashMessageAndRedirect('Branch/Node was successfully moved.', '/');
            break;
        case 'update-node':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
            $service->updateNode($_POST);
            setFlashMessageAndRedirect('Node was successfully updated.', '/');
            break;
        case 'delete':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
            $service->deleteNode($_GET);
            setFlashMessageAndRedirect('Branch/Node was successfully deleted.', '/');
            break;
        case 'descendant-test':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
            $descendants = $service->findDescendants($_GET);
            $showDescendantTestBlock = true;
            break;
        case 'ancestor-test':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
            $ancestors = $service->findAncestors($_GET);
            $showAncestorTestBlock = true;
            break;
    }
} catch (ValidationError $e) {
    $errorMessage = $e->getErrors();
}

/************************************
 *   View
 ***********************************/
$wh = new ViewHelper();
?>

<html>
    <head>
        <title>Demo</title>
        <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta/css/bootstrap.min.css" integrity="sha384-/Y6pD6FV/Vv2HJnA6t+vslU6fwYXjCFtcEpHbNJ0lyAFsXTsjBbfaDjzALeQsN6M" crossorigin="anonymous">
        <style>
            .error-container {
                margin-bottom: 0;
                padding-left: 1rem;
            }
        </style>
    </head>
    <body>
        <div class="container-fluid">
            <h1><a href="/">Demo</a></h1>

            <?php
            if ($errorMessage ?? false) {
                echo $wh->renderErrorMessages($errorMessage);
            }

            echo $wh->renderFlashMessage();
            ?>

            <div class="row">
                <div class="col-sm-4">
                    <form action="/?action=create-scope" method="post">
                        <div class="form-group">
                            <label>Root name</label>
                            <input type="text" name="label" class="form-control" />
                        </div>
                        <div class="form-group">
                            <label>Scope name</label>
                            <input type="text" name="scope" class="form-control" />
                        </div>
                        <input type="submit" value="Create" class="btn btn-primary" />
                    </form>
                </div>
            </div>
            <?php
            foreach ($service->getRoots() as $root) {
                $nodes = $service->getDescendants($root['id']); ?>
                <hr />
                <h2>Scope - <?php echo $wh->escape($root['group_id']); ?></h2>

                <div class="row">
                    <div class="col-sm-2">
                        <h3>Create</h3>
                        <form action="/?action=create-node" method="post">
                            <div class="form-group">
                                <label>Name</label>
                                <input type="text" name="label" class="form-control" />
                            </div>
                            <div class="form-group">
                                <label>Target Node</label>
                                <select name="target_node_id" class="form-control"><?php echo $wh->renderSelectOptions($nodes); ?></select>
                            </div>
                            <div class="form-group">
                                <label>Placement</label>
                                <select name="placement" class="form-control"><?php echo $wh->renderPlacementOptions(); ?></select>
                            </div>
                            <div class="form-group">
                                <input type="submit" value="Create" class="btn btn-primary" />
                            </div>
                        </form>
                    </div>

                    <div class="col-sm-2">
                        <h3>Move</h3>
                        <form action="/?action=move-node" method="post">
                            <div class="form-group">
                                <label>Source Node</label>
                                <select name="source_node_id" class="form-control"><?php echo $wh->renderSelectOptions($nodes); ?></select>
                            </div>
                            <div class="form-group">
                                <label>Target Node</label>
                                <select name="target_node_id" class="form-control"><?php echo $wh->renderSelectOptions($nodes); ?></select>
                            </div>
                            <div class="form-group">
                                <label>Placement</label>
                                <select name="placement" class="form-control"><?php echo $wh->renderPlacementOptions(); ?></select>
                            </div>
                            <input type="submit" value="Move" class="btn btn-primary" />
                        </form>
                    </div>

                    <div class="col-sm-2">
                        <h3>Update</h3>
                        <form action="/?action=update-node" method="post">
                            <div class="form-group">
                                <label>Name</label>
                                <input type="text" name="label" class="form-control" />
                            </div>
                            <div class="form-group">
                                <label>Node</label>
                                <select name="node_id" class="form-control"><?php echo $wh->renderSelectOptions($nodes); ?></select>
                            </div>
                            <input type="submit" value="Update" class="btn btn-primary" />
                        </form>
                    </div>

                    <div class="col-sm-3">
                        <h3>Descendant Test</h3>
                        <form action="/" method="get">
                            <div class="form-group">
                                <label>Node</label>
                                <select name="node_id" class="form-control"><?php echo $wh->renderSelectOptions($nodes); ?></select>
                            </div>
                            <div class="form-group">
                                <label>Exclude First N Level</label>
                                <input type="number" min="0" step="1" name="exclude_first_n_level" class="form-control" />
                            </div>
                            <div class="form-group">
                                <label>Level Limit</label>
                                <input type="number" min="0" step="1" name="level_limit" class="form-control" />
                            </div>
                            <div class="form-group">
                                <label>Exclude Branch</label>
                                <select name="exclude_node_id" class="form-control"><?php echo $wh->renderSelectOptions($nodes); ?></select>
                            </div>
                            <input type="hidden" name="action" value="descendant-test" />
                            <input type="hidden" name="scope" value="<?php echo $wh->escape($root['group_id']); ?>" />
                            <input type="submit" value="Show" class="btn btn-primary" />
                        </form>
                    </div>

                    <div class="col-sm-3">
                        <h3>Ancestor Test</h3>
                        <form action="/" method="get">
                            <div class="form-group">
                                <label>Node</label>
                                <select name="node_id" class="form-control"><?php echo $wh->renderSelectOptions($nodes); ?></select>
                            </div>
                            <div class="form-group">
                                <label>Exclude First N Level</label>
                                <input type="number" min="0" step="1" name="exclude_first_n_level" class="form-control" />
                            </div>
                            <div class="form-group">
                                <label>Exclude Last N Level</label>
                                <input type="number" min="0" step="1" name="exclude_last_n_level" class="form-control" />
                            </div>
                            <input type="hidden" name="action" value="ancestor-test" />
                            <input type="hidden" name="scope" value="<?php echo $wh->escape($root['group_id']); ?>" />
                            <input type="submit" value="Show" class="btn btn-primary" />
                        </form>
                    </div>
                </div>

                <hr />

                <div class="row">
                    <div class="col-sm-6">
                        <h3>Whole Tree</h3>
                        <?php echo $wh->renderTree($nodes); ?>
                    </div>
                    <div class="col-sm-6">
                        <?php
                        if (($showDescendantTestBlock ?? false) && $root['group_id'] == $_GET['scope']) {
                            ?>
                            <h3>Descendants Test Result</h3>
                            <?php
                            if (0 == count($descendants)) {
                                echo $wh->renderErrorMessages(['No descendants was found']);
                            } else {
                                echo $wh->renderTree($descendants);
                            } ?>
                        <?php
                        } ?>

                        <?php
                        if (($showAncestorTestBlock ?? false) && $root['group_id'] == $_GET['scope']) {
                            ?>
                            <h3>Ancestors Test Result</h3>
                            <?php
                            if (0 == count($ancestors)) {
                                echo $wh->renderErrorMessages(['No ancestors was found']);
                            } else {
                                echo $wh->renderBreadcrumbs($ancestors);
                                echo $wh->renderTree($ancestors);
                            } ?>
                            <?php
                        } ?>
                    </div>
                </div>
            <?php
            }?>
        </div>
    </body>
</html>

1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2017-10-13 16:33 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 48 and the first side effect is on line 10. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			/**
3			* Quick end dirty solution only for demonstration purpose.
4			*/
5			declare(strict_types=1);
6
7			use StefanoTree\Exception\ValidationException;
8			use StefanoTree\TreeInterface;
9
10			session_start();
11
12			include_once __DIR__.'/../vendor/autoload.php';
13
14			$config = include_once __DIR__.'/config.php';
15
16			$dbAdapter = \Doctrine\DBAL\DriverManager::getConnection(
17			$config['dbConnection'],
18			new \Doctrine\DBAL\Configuration()
19			);
20
21			/**************************************
22			* Tree Adapter
23			**************************************/
24			$treeAdapter = \StefanoTree\NestedSet::factory(
25			array(
26			'tableName' => 'categories',
27			'idColumnName' => 'id',
28			'sequenceName' => 'categories_id_seq',
29			'scopeColumnName' => 'group_id',
30			),
31			$dbAdapter
32			);
33
34			/***************************************
35			* Join example
36			***************************************/
37			/*
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-10-16 20:35 UTC by Report Bug Copy Issue Report `62%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
38			$select = $dbAdapter->createQueryBuilder();

bartko-s / stefano-tree

Push — develop ( e67729...75d57c )

ViewHelper::renderBreadcrumbs() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like