PHP统计目录下的文件总数及代码行数(去除注释及空行)

      在开发的时候,为了统计开发出的代码总行数及文件总数,在没有使用工具的时候,总是要去一个文件一个文件的查找,文件夹层次少还行,层次多的时候就累死人了,虽然知道目前可能也是存在这种统计工具可以使用,但是当时就像如果自己能写一个统计方法,每次要统计只要执行一次就行,就能得到自己想要的结果,这样既不用安装统计工具的软件,而且也没有了统计功能工具的学习成本,也能学以致用就好了,于是就写了段代码,这样用起来也很方便,只是运行下程序。
      这个类的原始原型是一堆function,(发表在外博地址中的javaeye中),是在一个批命令不能满足的情况下的产物。因为没有深入研究过批命令,所以批命令只能统计总文件数,及每个文件的去除空行之后的总行数,及所有文件去除空行之后的总行数,却没有去除注释行的功能。后来事后整理了下这堆函数,编成一个类来使用,就方便多了~~也好管理。
     但是我深知这个类还有很多的缺陷,在匹配的规则上也没有很完美的写上规则。所以放这里供大家查阅及批漏~所以如果有想法可以完善这个功能的欢迎给我留言~~
<?php
/**
 * @author xiaoxiao <x_824@sina.com> 2011-1-12
 * @link http://xiaoyaoxia.cnblogs.com/
 * @license
 * 统计目录下的文件行数及总文件数··去除注释
 */

$obj = new CaculateFiles();
//如果设置为false,这不会显示每个文件的信息,否则显示
$obj->setShowFlag(false);
//会跳过所有All开头的文件
$obj->setFileSkip(array('All')); 
$obj->run("D:\PHPAPP\php\_tests");

//所有文件,(默认格式为.php)
$obj->setFileSkip(array());
$obj->run("D:\PHPAPP\php");

$obj->setShowFlag(true);
//跳过所有I和A开头的文件,(比如接口和抽象类开头)
$obj->setFileSkip(array('I', 'A'));
$obj->run("D:\PHPAPP\php");


/**
 * 执行目录中文件的统计(包括文件数及总行数
 * 
 * 1、跳过文件的时候:
 *    匹配的规则只是从文件名上着手,匹配的规则也仅限在开头。
 * 2、跳过文件中的注释行:
 *    匹配的规则只是从注释段落的头部匹配,如果出现// 及 *及 #及/*开头的行及空行会被跳过。所以类似/*这种多汗注释,每行的开头都必须加上*号,否则无法匹配到这种的注释。
 * 3、目录过滤:
 *    匹配的规则是从目录名的全名匹配
 */
class CaculateFiles {
	/**
	 * 统计的后缀
	 */
	private $ext = ".php";
	/**
	 * 是否显示每个文件的统计数
	 */
	private $showEveryFile = true;
	/**
	 * 文件的的跳过规则
	 */
	private $fileSkip = array();
	/**
	 * 统计的跳过行规则
	 */
	private $lineSkip = array("*", "/*", "//", "#");
	/**
	 * 统计跳过的目录规则
	 */
	private $dirSkip = array(".", "..", '.svn');
  
	public function __construct($ext = '', $dir = '', $showEveryFile = true, $dirSkip = array(), $lineSkip = array(), $fileSkip = array()) {
		$this->setExt($ext);
		$this->setDirSkip($dirSkip);
		$this->setFileSkip($fileSkip);
		$this->setLineSkip($lineSkip);
		$this->setShowFlag($showEveryFile);
		$this->run($dir);
	}
  
	public function setExt($ext) {
		trim($ext) && $this->ext = strtolower(trim($ext));
	}
	public function setShowFlag($flag = true) {
		$this->showEveryFile = $flag;
	}
	public function setDirSkip($dirSkip) {
		$dirSkip && is_array($dirSkip) && $this->dirSkip = $dirSkip;
	}
	public function setFileSkip($fileSkip) {
		$this->fileSkip = $fileSkip;
	}
	public function setLineSkip($lineSkip) {
		$lineSkip && is_array($lineSkip) && $this->lineSkip = array_merge($this->lineSkip, $lineSkip);
	}
	/**
	 * 执行统计
	 * @param string $dir 统计的目录
	 */
	public function run($dir = '') {
		if ($dir == '') return;
		if (!is_dir($dir)) exit('Path error!');
		$this->dump($dir, $this->readDir($dir));
	}
    
	/**
	 * 显示统计结果
	 * @param string $dir 目录
	 * @param array $result 统计结果(包含总行数,有效函数,总文件数
	 */
	private function dump($dir, $result) {
		$totalLine = $result['totalLine'];
		$lineNum = $result['lineNum'];
		$fileNum = $result['fileNum'];
		echo "*************************************************************\r\n<br/>";
		echo $dir . ":\r\n<br/>";
		echo "TotalLine: " . $totalLine . "\r\n<br/>";
		echo "TotalLine with no comment and empty: " . $lineNum . "\r\n<br/>";
		echo 'TotalFiles:' . $fileNum . "\r\n<br/>";
	}

	/**
	 * 读取目录
	 * @param string $dir 目录
	 */
	private function readDir($dir) {
		$num = array('totalLine' => 0, 'lineNum' => 0, 'fileNum' => 0);
		if ($dh = opendir($dir)) {
			while (($file = readdir($dh)) !== false) {
				if ($this->skipDir($file)) continue;
				if (is_dir($dir . '/' . $file)) {
					$result = $this->readDir($dir . '/' . $file);
					$num['totalLine'] += $result['totalLine'];
					$num['lineNum'] += $result['lineNum'];
					$num['fileNum'] += $result['fileNum'];
				} else {
					if ($this->skipFile($file)) continue;
					list($num1, $num2) = $this->readfiles($dir . '/' . $file);
					$num['totalLine'] += $num1;
					$num['lineNum'] += $num2;
					$num['fileNum']++;
				}
			}
			closedir($dh);
		} else {
			echo 'open dir <' . $dir . '> error!' . "\r";
		}
		return $num;
	}

	/**
	 * 读取文件
	 * @param string $file 文件
	 */
	private function readfiles($file) {
		$str = file($file);
		$linenum = 0;
		foreach ($str as $value) {
			if ($this->skipLine(trim($value))) continue;
			$linenum++;
		}
		$totalnum = count(file($file));
		if (!$this->showEveryFile) return array($totalnum, $linenum);
		echo $file . "\r\n";
		echo 'TotalLine in the file:' . $totalnum . "\r\n";
		echo 'TotalLine with no comment and empty in the file:' . $linenum . "\r\n";
		return array($totalnum, $linenum);
	}
   
    /**
	 * 执行跳过的目录规则
	 * @param string $dir 目录名
	 */
	private function skipDir($dir) {
		if (in_array($dir, $this->dirSkip)) return true;
		return false;
	}
    
	/**
	 * 执行跳过的文件规则
	 * @param string $file 文件名
	 */
	private function skipFile($file) {
		if (strtolower(strrchr($file, '.')) != $this->ext) return true;
		if (!$this->fileSkip) return false;
		foreach ($this->fileSkip as $skip) {
			if (strpos($file, $skip) === 0) return true;
		}
		return false;
	}
    
	/**
	 * 执行文件中行的跳过规则
	 * @param string $string 行内容
	 */
	private function skipLine($string) {
		if ($string == '') return true;
		foreach ($this->lineSkip as $tag) {
			if (strpos($string, $tag) === 0) return true;
		}
		return false;
	}
}

原文地址:https://www.cnblogs.com/xiaoyaoxia/p/1936141.html