JuliusHaertl\PHPDocToRst\Extension\HideChildNamespaces

Complexity

Total Complexity

2

Size/Duplication

Total Lines	9
Duplicated Lines	0 %

Importance

Changes	3
Bugs	2	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	shouldRenderIndex()	0	7	2

<?php
/**
 * @copyright Copyright (c) 2017 Julius Härtl <jus@bitgrid.net>
 * @author    Julius Härtl <jus@bitgrid.net>
 * @license   GNU AGPL version 3 or any later version
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as
 *  published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

namespace JuliusHaertl\PHPDocToRst\Extension;

use JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder;

/**
 * Example for hiding a section in the namespace index page.
 */
class HideChildNamespaces extends Extension
{
    public function shouldRenderIndex($type, $element)
    {
        if ($type === NamespaceIndexBuilder::RENDER_INDEX_NAMESPACE) {
            return false;
        }

        return true;
    }
}