C:/xampp/htdocs/moodle/lib/spikephpcoverage/src/parser/Parser.php

Go to the documentation of this file.

<?php
    /*
    *  $Id: Parser.php,v 1.2 2010/12/14 17:36:00 moodlerobot Exp $
    *  
    *  Copyright(c) 2004-2006, SpikeSource Inc. All Rights Reserved.
    *  Licensed under the Open Software License version 2.1
    *  (See http://www.spikesource.com/license.html)
    */
?>
<?php

    if(!defined("__PHPCOVERAGE_HOME")) {
        define("__PHPCOVERAGE_HOME", dirname(dirname(__FILE__)));
    }
    require_once __PHPCOVERAGE_HOME . "/conf/phpcoverage.conf.php";
    require_once __PHPCOVERAGE_HOME . "/util/Utility.php";


    define("LINE_TYPE_UNKNOWN", "0");
    define("LINE_TYPE_EXEC", "1");
    define("LINE_TYPE_NOEXEC", "2");
    define("LINE_TYPE_CONT", "3");

    abstract class Parser {
        /*{{{ Members */

        protected $totalLines;
        protected $coveredLines;
        protected $uncoveredLines;
        protected $fileRef;
        protected $filename;

        protected $line;
        protected $logger;

        /*}}}*/
        /*{{{ public function __construct() */
        public function __construct() {
            global $util;
            $this->totalLines = 0;
            $this->coveredLines = 0;
            $this->uncoveredLines = 0;

            $this->fileRef = false;
            $this->line = false;
            $this->lineType = false;

            $this->logger = $util->getLogger();
        }

        /*}}}*/
        /*{{{ public abstract function parse() */

        public function parse($filename) {
            $this->filename = $filename;
            $ret = $this->openFileReadOnly();
            if(!$ret) {
                die("Error: Cannot open file: $this->filename \n");
            }
        }

        /*}}}*/
        /*{{{ protected abstract function processLine() */

        protected abstract function processLine($line);

        /*}}}*/
        /*{{{ public function getLine() */

        public function getLine() {
            if(!feof($this->fileRef)) {
                $this->line = fgets($this->fileRef);
                $this->processLine($this->line);
            }
            else {
                fclose($this->fileRef);
                $this->line = false;
            }
            return $this->line;
        }

        /*}}}*/
        /*{{{ public abstract function getLineType() */

        public abstract function getLineType();

        /*}}}*/
        /*{{{ public function getLineTypeStr() */

        public function getLineTypeStr($lineType) {
            if($lineType == LINE_TYPE_EXEC) {
                return "LINE_TYPE_EXEC";
            }
            else if($lineType == LINE_TYPE_NOEXEC) {
                return "LINE_TYPE_NOEXEC";
            }
            else if($lineType == LINE_TYPE_CONT) {
                return "LINE_TYPE_CONT";
            }
            else {
                return "LINE_TYPE_UNKNOWN";
            }
        }

        /*}}}*/
        /*{{{ protected function openFileReadOnly() */

        protected function openFileReadOnly() {
            $this->fileRef = fopen($this->filename, "r");
            return $this->fileRef !== false;
        }

        /*}}}*/
        /*{{{ public function getTotalLines() */

        public function getTotalLines() {
            return $this->totalLines;
        }

        /*}}}*/
        /*{{{ public function getCoveredLines() */

        public function getCoveredLines() {
            return $this->coveredLines;
        }

        /*}}}*/
        /*{{{ public function getUncoveredLines() */

        public function getUncoveredLines() {
            return $this->uncoveredLines;
        }

        /*}}}*/
    }

?>