Directory.php

1. 8.x drupal/core/vendor/phpunit/php-code-coverage/PHP/CodeCoverage/Report/Node/Directory.php
2. 8.x drupal/core/vendor/phpunit/php-code-coverage/PHP/CodeCoverage/Report/HTML/Renderer/Directory.php

<?php

/**
 * PHP_CodeCoverage
 *
 * Copyright (c) 2009-2013, Sebastian Bergmann <sebastian@phpunit.de>.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the name of Sebastian Bergmann nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @category   PHP
 * @package    CodeCoverage
 * @author     Sebastian Bergmann <sebastian@phpunit.de>
 * @copyright  2009-2013 Sebastian Bergmann <sebastian@phpunit.de>
 * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
 * @link       http://github.com/sebastianbergmann/php-code-coverage
 * @since      File available since Release 1.1.0
 */

/**
 * Represents a directory in the code coverage information tree.
 *
 * @category   PHP
 * @package    CodeCoverage
 * @author     Sebastian Bergmann <sebastian@phpunit.de>
 * @copyright  2009-2013 Sebastian Bergmann <sebastian@phpunit.de>
 * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
 * @link       http://github.com/sebastianbergmann/php-code-coverage
 * @since      Class available since Release 1.1.0
 */
class PHP_CodeCoverage_Report_Node_Directory extends PHP_CodeCoverage_Report_Node implements IteratorAggregate {

  /**
   * @var PHP_CodeCoverage_Report_Node[]
   */
  protected $children = array();

  /**
   * @var PHP_CodeCoverage_Report_Node_Directory[]
   */
  protected $directories = array();

  /**
   * @var PHP_CodeCoverage_Report_Node_File[]
   */
  protected $files = array();

  /**
   * @var array
   */
  protected $classes;

  /**
   * @var array
   */
  protected $traits;

  /**
   * @var array
   */
  protected $functions;

  /**
   * @var array
   */
  protected $linesOfCode = NULL;

  /**
   * @var integer
   */
  protected $numFiles = -1;

  /**
   * @var integer
   */
  protected $numExecutableLines = -1;

  /**
   * @var integer
   */
  protected $numExecutedLines = -1;

  /**
   * @var integer
   */
  protected $numClasses = -1;

  /**
   * @var integer
   */
  protected $numTestedClasses = -1;

  /**
   * @var integer
   */
  protected $numTraits = -1;

  /**
   * @var integer
   */
  protected $numTestedTraits = -1;

  /**
   * @var integer
   */
  protected $numMethods = -1;

  /**
   * @var integer
   */
  protected $numTestedMethods = -1;

  /**
   * @var integer
   */
  protected $numFunctions = -1;

  /**
   * @var integer
   */
  protected $numTestedFunctions = -1;

  /**
   * Returns the number of files in/under this node.
   *
   * @return integer
   */
  public function count() {
    if ($this->numFiles == -1) {
      $this->numFiles = 0;
      foreach ($this->children as $child) {
        $this->numFiles += count($child);
      }
    }
    return $this->numFiles;
  }

  /**
   * Returns an iterator for this node.
   *
   * @return RecursiveIteratorIterator
   */
  public function getIterator() {
    return new RecursiveIteratorIterator(new PHP_CodeCoverage_Report_Node_Iterator($this), RecursiveIteratorIterator::SELF_FIRST);
  }

  /**
   * Adds a new directory.
   *
   * @param  string $name
   * @return PHP_CodeCoverage_Report_Node_Directory
   */
  public function addDirectory($name) {
    $directory = new PHP_CodeCoverage_Report_Node_Directory($name, $this);
    $this->children[] = $directory;
    $this->directories[] =& $this->children[count($this->children) - 1];
    return $directory;
  }

  /**
   * Adds a new file.
   *
   * @param  string  $name
   * @param  array   $coverageData
   * @param  array   $testData
   * @param  boolean $cacheTokens
   * @return PHP_CodeCoverage_Report_Node_File
   * @throws PHP_CodeCoverage_Exception
   */
  public function addFile($name, array $coverageData, array $testData, $cacheTokens) {
    $file = new PHP_CodeCoverage_Report_Node_File($name, $this, $coverageData, $testData, $cacheTokens);
    $this->children[] = $file;
    $this->files[] =& $this->children[count($this->children) - 1];
    $this->numExecutableLines = -1;
    $this->numExecutedLines = -1;
    return $file;
  }

  /**
   * Returns the directories in this directory.
   *
   * @return array
   */
  public function getDirectories() {
    return $this->directories;
  }

  /**
   * Returns the files in this directory.
   *
   * @return array
   */
  public function getFiles() {
    return $this->files;
  }

  /**
   * Returns the child nodes of this node.
   *
   * @return array
   */
  public function getChildNodes() {
    return $this->children;
  }

  /**
   * Returns the classes of this node.
   *
   * @return array
   */
  public function getClasses() {
    if ($this->classes === NULL) {
      $this->classes = array();
      foreach ($this->children as $child) {
        $this->classes = array_merge($this->classes, $child
          ->getClasses());
      }
    }
    return $this->classes;
  }

  /**
   * Returns the traits of this node.
   *
   * @return array
   */
  public function getTraits() {
    if ($this->traits === NULL) {
      $this->traits = array();
      foreach ($this->children as $child) {
        $this->traits = array_merge($this->traits, $child
          ->getTraits());
      }
    }
    return $this->traits;
  }

  /**
   * Returns the functions of this node.
   *
   * @return array
   */
  public function getFunctions() {
    if ($this->functions === NULL) {
      $this->functions = array();
      foreach ($this->children as $child) {
        $this->functions = array_merge($this->functions, $child
          ->getFunctions());
      }
    }
    return $this->functions;
  }

  /**
   * Returns the LOC/CLOC/NCLOC of this node.
   *
   * @return array
   */
  public function getLinesOfCode() {
    if ($this->linesOfCode === NULL) {
      $this->linesOfCode = array(
        'loc' => 0,
        'cloc' => 0,
        'ncloc' => 0,
      );
      foreach ($this->children as $child) {
        $linesOfCode = $child
          ->getLinesOfCode();
        $this->linesOfCode['loc'] += $linesOfCode['loc'];
        $this->linesOfCode['cloc'] += $linesOfCode['cloc'];
        $this->linesOfCode['ncloc'] += $linesOfCode['ncloc'];
      }
    }
    return $this->linesOfCode;
  }

  /**
   * Returns the number of executable lines.
   *
   * @return integer
   */
  public function getNumExecutableLines() {
    if ($this->numExecutableLines == -1) {
      $this->numExecutableLines = 0;
      foreach ($this->children as $child) {
        $this->numExecutableLines += $child
          ->getNumExecutableLines();
      }
    }
    return $this->numExecutableLines;
  }

  /**
   * Returns the number of executed lines.
   *
   * @return integer
   */
  public function getNumExecutedLines() {
    if ($this->numExecutedLines == -1) {
      $this->numExecutedLines = 0;
      foreach ($this->children as $child) {
        $this->numExecutedLines += $child
          ->getNumExecutedLines();
      }
    }
    return $this->numExecutedLines;
  }

  /**
   * Returns the number of classes.
   *
   * @return integer
   */
  public function getNumClasses() {
    if ($this->numClasses == -1) {
      $this->numClasses = 0;
      foreach ($this->children as $child) {
        $this->numClasses += $child
          ->getNumClasses();
      }
    }
    return $this->numClasses;
  }

  /**
   * Returns the number of tested classes.
   *
   * @return integer
   */
  public function getNumTestedClasses() {
    if ($this->numTestedClasses == -1) {
      $this->numTestedClasses = 0;
      foreach ($this->children as $child) {
        $this->numTestedClasses += $child
          ->getNumTestedClasses();
      }
    }
    return $this->numTestedClasses;
  }

  /**
   * Returns the number of traits.
   *
   * @return integer
   */
  public function getNumTraits() {
    if ($this->numTraits == -1) {
      $this->numTraits = 0;
      foreach ($this->children as $child) {
        $this->numTraits += $child
          ->getNumTraits();
      }
    }
    return $this->numTraits;
  }

  /**
   * Returns the number of tested traits.
   *
   * @return integer
   */
  public function getNumTestedTraits() {
    if ($this->numTestedTraits == -1) {
      $this->numTestedTraits = 0;
      foreach ($this->children as $child) {
        $this->numTestedTraits += $child
          ->getNumTestedTraits();
      }
    }
    return $this->numTestedTraits;
  }

  /**
   * Returns the number of methods.
   *
   * @return integer
   */
  public function getNumMethods() {
    if ($this->numMethods == -1) {
      $this->numMethods = 0;
      foreach ($this->children as $child) {
        $this->numMethods += $child
          ->getNumMethods();
      }
    }
    return $this->numMethods;
  }

  /**
   * Returns the number of tested methods.
   *
   * @return integer
   */
  public function getNumTestedMethods() {
    if ($this->numTestedMethods == -1) {
      $this->numTestedMethods = 0;
      foreach ($this->children as $child) {
        $this->numTestedMethods += $child
          ->getNumTestedMethods();
      }
    }
    return $this->numTestedMethods;
  }

  /**
   * Returns the number of functions.
   *
   * @return integer
   */
  public function getNumFunctions() {
    if ($this->numFunctions == -1) {
      $this->numFunctions = 0;
      foreach ($this->children as $child) {
        $this->numFunctions += $child
          ->getNumFunctions();
      }
    }
    return $this->numFunctions;
  }

  /**
   * Returns the number of tested functions.
   *
   * @return integer
   */
  public function getNumTestedFunctions() {
    if ($this->numTestedFunctions == -1) {
      $this->numTestedFunctions = 0;
      foreach ($this->children as $child) {
        $this->numTestedFunctions += $child
          ->getNumTestedFunctions();
      }
    }
    return $this->numTestedFunctions;
  }

}