pradosoft / prado

demos/quickstart/protected/controls/Comments/CommentBlock.php

Doc Comments +3 added lines

@@ -93,6 +93,9 @@
 		$param->IsValid = $this->password->Text == 'Prado';
 	}
 
+	/**
+	 * @param CommentRecord $record
+	 */
 	protected function format_message($record)
 	{
 		$username=htmlspecialchars($record->username);

Spacing +13 added lines, -13 removed lines

@@ -10,7 +10,7 @@ 
 
 class CommentRecord extends TActiveRecord
 {
-	const TABLE='qs_comments';
+	const TABLE = 'qs_comments';
 
 	public $id;
 	public $username;
@@ -19,7 +19,7 @@ 
 	public $block_id;
 	public $content;
 
-	public static function finder($className=__CLASS__)
+	public static function finder($className = __CLASS__)
 	{
 		return parent::finder($className);
 	}
@@ -31,18 +31,18 @@ 
 
 	function onLoad($param)
 	{
-		if(!$this->Page->IsCallBack)
+		if (!$this->Page->IsCallBack)
 		{
 			$count = array();
 			$data = $this->getCommentData();
-			foreach($data as $r)
+			foreach ($data as $r)
 			{
-				if(!isset($count[$r->block_id]))
-					$count[$r->block_id]=0;
+				if (!isset($count[$r->block_id]))
+					$count[$r->block_id] = 0;
 				$count[$r->block_id]++;
 			}
-			$js = "var comment_count = ".TJavascript::encode($count).";\n";
-			$this->Page->ClientScript->registerBeginScript('count',$js);
+			$js = "var comment_count = " . TJavascript::encode($count) . ";\n";
+			$this->Page->ClientScript->registerBeginScript('count', $js);
 			$this->comments->dataSource = $data;
 			$this->comments->dataBind();
 		}
@@ -55,7 +55,7 @@ 
 
 	function add_comment($sender, $param)
 	{
-		if(!$this->Page->IsValid)
+		if (!$this->Page->IsValid)
 			return;
 		$record = new CommentRecord;
 		$record->username = $this->username->Text;
@@ -71,7 +71,7 @@ 
 		$cc->appendContent('comment-list', $this->format_message($record));
 		$cc->callClientFunction('hide_add_comment');
 		$cc->callClientFunction('increment_count_tag', $record->block_id);
-		if(!$this->Page->IsCallBack)
+		if (!$this->Page->IsCallBack)
 		{
 			$this->comments->dataSource = $this->getCommentData();
 			$this->comments->dataBind();
@@ -80,7 +80,7 @@ 
 
 	protected function getCurrentPagePath()
 	{
-		if(is_null($this->_page))
+		if (is_null($this->_page))
 		{
 			$page = str_replace($this->Service->BasePath, '', $this->Page->Template->TemplateFile);
 			$this->_page = str_replace('\\', '/', $page);
@@ -95,8 +95,8 @@ 
 
 	protected function format_message($record)
 	{
-		$username=htmlspecialchars($record->username);
-		$content=nl2br(htmlspecialchars($record->content));
+		$username = htmlspecialchars($record->username);
+		$content = nl2br(htmlspecialchars($record->content));
 		return <<<EOD
 	<div class="comment c-{$record->block_id}">
 		<span><strong>{$username}</strong> on {$record->date_added}.</span>

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -102,6 +102,6 @@
 		<span><strong>{$username}</strong> on {$record->date_added}.</span>
 		<div>{$content}</div>
 	</div>
-EOD;
+eod;
 	}
 }
\ No newline at end of file

demos/quickstart/protected/index/Zend/Search/Lucene.php

Doc Comments +1 added lines, -2 removed lines

@@ -268,7 +268,7 @@ 
      * Returns a Zend_Search_Lucene_Document object for the document
      * number $id in this index.
      *
-     * @param integer|Zend_Search_Lucene_Search_QueryHit $id
+     * @param integer $id
      * @return Zend_Search_Lucene_Document
      */
     public function getDocument($id)
@@ -553,7 +553,6 @@ 
      * or the number of the document to delete.
      *
      * @todo Implementation
-     * @param mixed $item_to_del
      */
     public function delete($doc)
     {}

Indentation +504 added lines, -504 removed lines

@@ -59,511 +59,511 @@
  */
 class Zend_Search_Lucene
 {
-    /**
-     * File system adapter.
-     *
-     * @var Zend_Search_Lucene_Storage_Directory
-     */
-    private $_directory = null;
-
-    /**
-     * File system adapter closing option
-     *
-     * @var boolean
-     */
-    private $_closeDirOnExit = true;
-
-    /**
-     * Writer for this index, not instantiated unless required.
-     *
-     * @var Zend_Search_Lucene_Index_Writer
-     */
-    private $_writer = null;
-
-    /**
-     * Array of Zend_Search_Lucene_Index_SegmentInfo objects for this index.
-     *
-     * @var array Zend_Search_Lucene_Index_SegmentInfo
-     */
-    private $_segmentInfos = array();
-
-    /**
-     * Number of documents in this index.
-     *
-     * @var integer
-     */
-    private $_docCount = 0;
-
-
-    /**
-     * Opens the index.
-     *
-     * IndexReader constructor needs Directory as a parameter. It should be
-     * a string with a path to the index folder or a Directory object.
-     *
-     * @param mixed $directory
-     * @throws Zend_Search_Lucene_Exception
-     */
-    public function __construct($directory = null, $create = false)
-    {
-        if ($directory === null) {
-            throw new Zend_Search_Exception('No index directory specified');
-        }
-
-        if ($directory instanceof Zend_Search_Lucene_Storage_Directory_Filesystem) {
-            $this->_directory      = $directory;
-            $this->_closeDirOnExit = false;
-        } else {
-            $this->_directory      = new Zend_Search_Lucene_Storage_Directory_Filesystem($directory);
-            $this->_closeDirOnExit = true;
-        }
-
-        if ($create) {
-            $this->_writer = new Zend_Search_Lucene_Index_Writer($this->_directory, true);
-        } else {
-            $this->_writer = null;
-        }
-
-        $this->_segmentInfos = array();
-
-        $segmentsFile = $this->_directory->getFileObject('segments');
-
-        $format = $segmentsFile->readInt();
-
-        if ($format != (int)0xFFFFFFFF) {
-            throw new Zend_Search_Lucene_Exception('Wrong segments file format');
-        }
-
-        // read version
-        $segmentsFile->readLong();
-
-        // read counter
-        $segmentsFile->readInt();
-
-        $segments = $segmentsFile->readInt();
-
-        $this->_docCount = 0;
-
-        // read segmentInfos
-        for ($count = 0; $count < $segments; $count++) {
-            $segName = $segmentsFile->readString();
-            $segSize = $segmentsFile->readInt();
-            $this->_docCount += $segSize;
-
-            $this->_segmentInfos[$count] =
-                                new Zend_Search_Lucene_Index_SegmentInfo($segName,
-                                                                         $segSize,
-                                                                         $this->_directory);
-        }
-    }
-
-
-    /**
-     * Object destructor
-     */
-    public function __destruct()
-    {
-        $this->commit();
-
-        if ($this->_closeDirOnExit) {
-            $this->_directory->close();
-        }
-    }
-
-    /**
-     * Returns an instance of Zend_Search_Lucene_Index_Writer for the index
-     *
-     * @return Zend_Search_Lucene_Index_Writer
-     */
-    public function getIndexWriter()
-    {
-        if (!$this->_writer instanceof Zend_Search_Lucene_Index_Writer) {
-            $this->_writer = new Zend_Search_Lucene_Index_Writer($this->_directory);
-        }
-
-        return $this->_writer;
-    }
-
-
-    /**
-     * Returns the Zend_Search_Lucene_Storage_Directory instance for this index.
-     *
-     * @return Zend_Search_Lucene_Storage_Directory
-     */
-    public function getDirectory()
-    {
-        return $this->_directory;
-    }
-
-
-    /**
-     * Returns the total number of documents in this index.
-     *
-     * @return integer
-     */
-    public function count()
-    {
-        return $this->_docCount;
-    }
-
-
-    /**
-     * Performs a query against the index and returns an array
-     * of Zend_Search_Lucene_Search_QueryHit objects.
-     * Input is a string or Zend_Search_Lucene_Search_Query.
-     *
-     * @param mixed $query
-     * @return array ZSearchHit
-     */
-    public function find($query)
-    {
-        if (is_string($query)) {
-            $query = Zend_Search_Lucene_Search_QueryParser::parse($query);
-        }
-
-        if (!$query instanceof Zend_Search_Lucene_Search_Query) {
-            throw new Zend_Search_Lucene_Exception('Query must be a string or Zend_Search_Lucene_Search_Query object');
-        }
-
-        $this->commit();
-
-        $hits = array();
-        $scores = array();
-
-        $docNum = $this->count();
-        for( $count=0; $count < $docNum; $count++ ) {
-            $docScore = $query->score( $count, $this);
-            if( $docScore != 0 ) {
-                $hit = new Zend_Search_Lucene_Search_QueryHit($this);
-                $hit->id = $count;
-                $hit->score = $docScore;
-
-                $hits[] = $hit;
-                $scores[] = $docScore;
-            }
-        }
-        array_multisort($scores, SORT_DESC, SORT_REGULAR, $hits);
-
-        return $hits;
-    }
-
-
-    /**
-     * Returns a list of all unique field names that exist in this index.
-     *
-     * @param boolean $indexed
-     * @return array
-     */
-    public function getFieldNames($indexed = false)
-    {
-        $result = array();
-        foreach( $this->_segmentInfos as $segmentInfo ) {
-            $result = array_merge($result, $segmentInfo->getFields($indexed));
-        }
-        return $result;
-    }
-
-
-    /**
-     * Returns a Zend_Search_Lucene_Document object for the document
-     * number $id in this index.
-     *
-     * @param integer|Zend_Search_Lucene_Search_QueryHit $id
-     * @return Zend_Search_Lucene_Document
-     */
-    public function getDocument($id)
-    {
-        if ($id instanceof Zend_Search_Lucene_Search_QueryHit) {
-            /* @var $id Zend_Search_Lucene_Search_QueryHit */
-            $id = $id->id;
-        }
-
-        if ($id >= $this->_docCount) {
-            /**
-             * @todo exception here?
-             */
-            return null;
-        }
-
-        $segCount = 0;
-        $nextSegmentStartId = $this->_segmentInfos[ 0 ]->count();
-        while( $nextSegmentStartId <= $id ) {
-               $segCount++;
-               $nextSegmentStartId += $this->_segmentInfos[ $segCount ]->count();
-        }
-        $segmentStartId = $nextSegmentStartId - $this->_segmentInfos[ $segCount ]->count();
-
-        $fdxFile = $this->_segmentInfos[ $segCount ]->openCompoundFile('.fdx');
-        $fdxFile->seek( ($id-$segmentStartId)*8, SEEK_CUR );
-        $fieldValuesPosition = $fdxFile->readLong();
-
-        $fdtFile = $this->_segmentInfos[ $segCount ]->openCompoundFile('.fdt');
-        $fdtFile->seek( $fieldValuesPosition, SEEK_CUR );
-        $fieldCount = $fdtFile->readVInt();
-
-        $doc = new Zend_Search_Lucene_Document();
-        for( $count = 0; $count < $fieldCount; $count++ ) {
-            $fieldNum = $fdtFile->readVInt();
-            $bits = $fdtFile->readByte();
-
-            $fieldInfo = $this->_segmentInfos[ $segCount ]->getField($fieldNum);
-
-            if( !($bits & 2) ) { // Text data
-                $field = new Zend_Search_Lucene_Field($fieldInfo->name,
-                                                      $fdtFile->readString(),
-                                                      true,
-                                                      $fieldInfo->isIndexed,
-                                                      $bits & 1 );
-            } else {
-                $field = new Zend_Search_Lucene_Field($fieldInfo->name,
-                                                      $fdtFile->readBinary(),
-                                                      true,
-                                                      $fieldInfo->isIndexed,
-                                                      $bits & 1 );
-            }
-
-            $doc->addField($field);
-        }
-
-        return $doc;
-    }
-
-
-    /**
-     * Returns an array of all the documents which contain term.
-     *
-     * @param Zend_Search_Lucene_Index_Term $term
-     * @return array
-     */
-    public function termDocs(Zend_Search_Lucene_Index_Term $term)
-    {
-        $result = array();
-        $segmentStartDocId = 0;
-
-        foreach ($this->_segmentInfos as $segInfo) {
-            $termInfo = $segInfo->getTermInfo($term);
-
-            if (!$termInfo instanceof Zend_Search_Lucene_Index_TermInfo) {
-                $segmentStartDocId += $segInfo->count();
-                continue;
-            }
-
-            $frqFile = $segInfo->openCompoundFile('.frq');
-            $frqFile->seek($termInfo->freqPointer,SEEK_CUR);
-            $docId = 0;
-            for( $count=0; $count < $termInfo->docFreq; $count++ ) {
-                $docDelta = $frqFile->readVInt();
-                if( $docDelta % 2 == 1 ) {
-                    $docId += ($docDelta-1)/2;
-                } else {
-                    $docId += $docDelta/2;
-                    // read freq
-                    $frqFile->readVInt();
-                }
-                $result[] = $segmentStartDocId + $docId;
-            }
-
-            $segmentStartDocId += $segInfo->count();
-        }
-
-        return $result;
-    }
-
-
-    /**
-     * Returns an array of all term positions in the documents.
-     * Return array structure: array( docId => array( pos1, pos2, ...), ...)
-     *
-     * @param Zend_Search_Lucene_Index_Term $term
-     * @return array
-     */
-    public function termPositions(Zend_Search_Lucene_Index_Term $term)
-    {
-        $result = array();
-        $segmentStartDocId = 0;
-        foreach( $this->_segmentInfos as $segInfo ) {
-            $termInfo = $segInfo->getTermInfo($term);
-
-            if (!$termInfo instanceof Zend_Search_Lucene_Index_TermInfo) {
-                $segmentStartDocId += $segInfo->count();
-                continue;
-            }
-
-            $frqFile = $segInfo->openCompoundFile('.frq');
-            $frqFile->seek($termInfo->freqPointer,SEEK_CUR);
-            $freqs = array();
-            $docId = 0;
-
-            for( $count = 0; $count < $termInfo->docFreq; $count++ ) {
-                $docDelta = $frqFile->readVInt();
-                if( $docDelta % 2 == 1 ) {
-                    $docId += ($docDelta-1)/2;
-                    $freqs[ $docId ] = 1;
-                } else {
-                    $docId += $docDelta/2;
-                    $freqs[ $docId ] = $frqFile->readVInt();
-                }
-            }
-
-            $prxFile = $segInfo->openCompoundFile('.prx');
-            $prxFile->seek($termInfo->proxPointer,SEEK_CUR);
-            foreach ($freqs as $docId => $freq) {
-                $termPosition = 0;
-                $positions = array();
-
-                for ($count = 0; $count < $freq; $count++ ) {
-                    $termPosition += $prxFile->readVInt();
-                    $positions[] = $termPosition;
-                }
-                $result[ $segmentStartDocId + $docId ] = $positions;
-            }
-
-            $segmentStartDocId += $segInfo->count();
-        }
-
-        return $result;
-    }
-
-
-    /**
-     * Returns the number of documents in this index containing the $term.
-     *
-     * @param Zend_Search_Lucene_Index_Term $term
-     * @return integer
-     */
-    public function docFreq(Zend_Search_Lucene_Index_Term $term)
-    {
-        $result = 0;
-        foreach ($this->_segmentInfos as $segInfo) {
-            $termInfo = $segInfo->getTermInfo($term);
-            if ($termInfo !== null) {
-                $result += $termInfo->docFreq;
-            }
-        }
-
-        return $result;
-    }
-
-
-    /**
-     * Retrive similarity used by index reader
-     *
-     * @return Zend_Search_Lucene_Search_Similarity
-     */
-    public function getSimilarity()
-    {
-        return Zend_Search_Lucene_Search_Similarity::getDefault();
-    }
-
-
-    /**
-     * Returns a normalization factor for "field, document" pair.
-     *
-     * @param integer $id
-     * @param string $fieldName
-     * @return Zend_Search_Lucene_Document
-     */
-    public function norm( $id, $fieldName )
-    {
-        if( $id >= $this->_docCount )
-            return null;
-
-        $segCount = 0;
-        $nextSegmentStartId = $this->_segmentInfos[ 0 ]->count();
-        while( $nextSegmentStartId <= $id ) {
-               $segCount++;
-               $nextSegmentStartId += $this->_segmentInfos[ $segCount ]->count();
-        }
-
-        $segmentStartId = $nextSegmentStartId - $this->_segmentInfos[ $segCount ]->count();
-
-        return $this->_segmentInfos[ $segCount ]->norm($id - $segmentStartId, $fieldName);
-    }
-
-
-    /**
-     * Adds a document to this index.
-     *
-     * @param Zend_Search_Lucene_Document $document
-     */
-    public function addDocument(Zend_Search_Lucene_Document $document)
-    {
-        if (!$this->_writer instanceof Zend_Search_Lucene_Index_Writer) {
-            $this->_writer = new Zend_Search_Lucene_Index_Writer($this->_directory);
-        }
-
-        $this->_writer->addDocument($document);
-    }
-
-
-    /**
-     * Commit changes resulting from delete() or undeleteAll() operations.
-     *
-     * @todo delete() and undeleteAll processing.
-     */
-    public function commit()
-    {
-        if ($this->_writer !== null) {
-            foreach ($this->_writer->commit() as $segmentName => $segmentInfo) {
-                if ($segmentInfo !== null) {
-                    $this->_segmentInfos[] = $segmentInfo;
-                    $this->_docCount += $segmentInfo->count();
-                } else {
-                    foreach ($this->_segmentInfos as $segId => $segInfo) {
-                        if ($segInfo->getName() == $segmentName) {
-                            unset($this->_segmentInfos[$segId]);
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /*************************************************************************
+	/**
+	 * File system adapter.
+	 *
+	 * @var Zend_Search_Lucene_Storage_Directory
+	 */
+	private $_directory = null;
+
+	/**
+	 * File system adapter closing option
+	 *
+	 * @var boolean
+	 */
+	private $_closeDirOnExit = true;
+
+	/**
+	 * Writer for this index, not instantiated unless required.
+	 *
+	 * @var Zend_Search_Lucene_Index_Writer
+	 */
+	private $_writer = null;
+
+	/**
+	 * Array of Zend_Search_Lucene_Index_SegmentInfo objects for this index.
+	 *
+	 * @var array Zend_Search_Lucene_Index_SegmentInfo
+	 */
+	private $_segmentInfos = array();
+
+	/**
+	 * Number of documents in this index.
+	 *
+	 * @var integer
+	 */
+	private $_docCount = 0;
+
+
+	/**
+	 * Opens the index.
+	 *
+	 * IndexReader constructor needs Directory as a parameter. It should be
+	 * a string with a path to the index folder or a Directory object.
+	 *
+	 * @param mixed $directory
+	 * @throws Zend_Search_Lucene_Exception
+	 */
+	public function __construct($directory = null, $create = false)
+	{
+		if ($directory === null) {
+			throw new Zend_Search_Exception('No index directory specified');
+		}
+
+		if ($directory instanceof Zend_Search_Lucene_Storage_Directory_Filesystem) {
+			$this->_directory      = $directory;
+			$this->_closeDirOnExit = false;
+		} else {
+			$this->_directory      = new Zend_Search_Lucene_Storage_Directory_Filesystem($directory);
+			$this->_closeDirOnExit = true;
+		}
+
+		if ($create) {
+			$this->_writer = new Zend_Search_Lucene_Index_Writer($this->_directory, true);
+		} else {
+			$this->_writer = null;
+		}
+
+		$this->_segmentInfos = array();
+
+		$segmentsFile = $this->_directory->getFileObject('segments');
+
+		$format = $segmentsFile->readInt();
+
+		if ($format != (int)0xFFFFFFFF) {
+			throw new Zend_Search_Lucene_Exception('Wrong segments file format');
+		}
+
+		// read version
+		$segmentsFile->readLong();
+
+		// read counter
+		$segmentsFile->readInt();
+
+		$segments = $segmentsFile->readInt();
+
+		$this->_docCount = 0;
+
+		// read segmentInfos
+		for ($count = 0; $count < $segments; $count++) {
+			$segName = $segmentsFile->readString();
+			$segSize = $segmentsFile->readInt();
+			$this->_docCount += $segSize;
+
+			$this->_segmentInfos[$count] =
+								new Zend_Search_Lucene_Index_SegmentInfo($segName,
+																		 $segSize,
+																		 $this->_directory);
+		}
+	}
+
+
+	/**
+	 * Object destructor
+	 */
+	public function __destruct()
+	{
+		$this->commit();
+
+		if ($this->_closeDirOnExit) {
+			$this->_directory->close();
+		}
+	}
+
+	/**
+	 * Returns an instance of Zend_Search_Lucene_Index_Writer for the index
+	 *
+	 * @return Zend_Search_Lucene_Index_Writer
+	 */
+	public function getIndexWriter()
+	{
+		if (!$this->_writer instanceof Zend_Search_Lucene_Index_Writer) {
+			$this->_writer = new Zend_Search_Lucene_Index_Writer($this->_directory);
+		}
+
+		return $this->_writer;
+	}
+
+
+	/**
+	 * Returns the Zend_Search_Lucene_Storage_Directory instance for this index.
+	 *
+	 * @return Zend_Search_Lucene_Storage_Directory
+	 */
+	public function getDirectory()
+	{
+		return $this->_directory;
+	}
+
+
+	/**
+	 * Returns the total number of documents in this index.
+	 *
+	 * @return integer
+	 */
+	public function count()
+	{
+		return $this->_docCount;
+	}
+
+
+	/**
+	 * Performs a query against the index and returns an array
+	 * of Zend_Search_Lucene_Search_QueryHit objects.
+	 * Input is a string or Zend_Search_Lucene_Search_Query.
+	 *
+	 * @param mixed $query
+	 * @return array ZSearchHit
+	 */
+	public function find($query)
+	{
+		if (is_string($query)) {
+			$query = Zend_Search_Lucene_Search_QueryParser::parse($query);
+		}
+
+		if (!$query instanceof Zend_Search_Lucene_Search_Query) {
+			throw new Zend_Search_Lucene_Exception('Query must be a string or Zend_Search_Lucene_Search_Query object');
+		}
+
+		$this->commit();
+
+		$hits = array();
+		$scores = array();
+
+		$docNum = $this->count();
+		for( $count=0; $count < $docNum; $count++ ) {
+			$docScore = $query->score( $count, $this);
+			if( $docScore != 0 ) {
+				$hit = new Zend_Search_Lucene_Search_QueryHit($this);
+				$hit->id = $count;
+				$hit->score = $docScore;
+
+				$hits[] = $hit;
+				$scores[] = $docScore;
+			}
+		}
+		array_multisort($scores, SORT_DESC, SORT_REGULAR, $hits);
+
+		return $hits;
+	}
+
+
+	/**
+	 * Returns a list of all unique field names that exist in this index.
+	 *
+	 * @param boolean $indexed
+	 * @return array
+	 */
+	public function getFieldNames($indexed = false)
+	{
+		$result = array();
+		foreach( $this->_segmentInfos as $segmentInfo ) {
+			$result = array_merge($result, $segmentInfo->getFields($indexed));
+		}
+		return $result;
+	}
+
+
+	/**
+	 * Returns a Zend_Search_Lucene_Document object for the document
+	 * number $id in this index.
+	 *
+	 * @param integer|Zend_Search_Lucene_Search_QueryHit $id
+	 * @return Zend_Search_Lucene_Document
+	 */
+	public function getDocument($id)
+	{
+		if ($id instanceof Zend_Search_Lucene_Search_QueryHit) {
+			/* @var $id Zend_Search_Lucene_Search_QueryHit */
+			$id = $id->id;
+		}
+
+		if ($id >= $this->_docCount) {
+			/**
+			 * @todo exception here?
+			 */
+			return null;
+		}
+
+		$segCount = 0;
+		$nextSegmentStartId = $this->_segmentInfos[ 0 ]->count();
+		while( $nextSegmentStartId <= $id ) {
+			   $segCount++;
+			   $nextSegmentStartId += $this->_segmentInfos[ $segCount ]->count();
+		}
+		$segmentStartId = $nextSegmentStartId - $this->_segmentInfos[ $segCount ]->count();
+
+		$fdxFile = $this->_segmentInfos[ $segCount ]->openCompoundFile('.fdx');
+		$fdxFile->seek( ($id-$segmentStartId)*8, SEEK_CUR );
+		$fieldValuesPosition = $fdxFile->readLong();
+
+		$fdtFile = $this->_segmentInfos[ $segCount ]->openCompoundFile('.fdt');
+		$fdtFile->seek( $fieldValuesPosition, SEEK_CUR );
+		$fieldCount = $fdtFile->readVInt();
+
+		$doc = new Zend_Search_Lucene_Document();
+		for( $count = 0; $count < $fieldCount; $count++ ) {
+			$fieldNum = $fdtFile->readVInt();
+			$bits = $fdtFile->readByte();
+
+			$fieldInfo = $this->_segmentInfos[ $segCount ]->getField($fieldNum);
+
+			if( !($bits & 2) ) { // Text data
+				$field = new Zend_Search_Lucene_Field($fieldInfo->name,
+													  $fdtFile->readString(),
+													  true,
+													  $fieldInfo->isIndexed,
+													  $bits & 1 );
+			} else {
+				$field = new Zend_Search_Lucene_Field($fieldInfo->name,
+													  $fdtFile->readBinary(),
+													  true,
+													  $fieldInfo->isIndexed,
+													  $bits & 1 );
+			}
+
+			$doc->addField($field);
+		}
+
+		return $doc;
+	}
+
+
+	/**
+	 * Returns an array of all the documents which contain term.
+	 *
+	 * @param Zend_Search_Lucene_Index_Term $term
+	 * @return array
+	 */
+	public function termDocs(Zend_Search_Lucene_Index_Term $term)
+	{
+		$result = array();
+		$segmentStartDocId = 0;
+
+		foreach ($this->_segmentInfos as $segInfo) {
+			$termInfo = $segInfo->getTermInfo($term);
+
+			if (!$termInfo instanceof Zend_Search_Lucene_Index_TermInfo) {
+				$segmentStartDocId += $segInfo->count();
+				continue;
+			}
+
+			$frqFile = $segInfo->openCompoundFile('.frq');
+			$frqFile->seek($termInfo->freqPointer,SEEK_CUR);
+			$docId = 0;
+			for( $count=0; $count < $termInfo->docFreq; $count++ ) {
+				$docDelta = $frqFile->readVInt();
+				if( $docDelta % 2 == 1 ) {
+					$docId += ($docDelta-1)/2;
+				} else {
+					$docId += $docDelta/2;
+					// read freq
+					$frqFile->readVInt();
+				}
+				$result[] = $segmentStartDocId + $docId;
+			}
+
+			$segmentStartDocId += $segInfo->count();
+		}
+
+		return $result;
+	}
+
+
+	/**
+	 * Returns an array of all term positions in the documents.
+	 * Return array structure: array( docId => array( pos1, pos2, ...), ...)
+	 *
+	 * @param Zend_Search_Lucene_Index_Term $term
+	 * @return array
+	 */
+	public function termPositions(Zend_Search_Lucene_Index_Term $term)
+	{
+		$result = array();
+		$segmentStartDocId = 0;
+		foreach( $this->_segmentInfos as $segInfo ) {
+			$termInfo = $segInfo->getTermInfo($term);
+
+			if (!$termInfo instanceof Zend_Search_Lucene_Index_TermInfo) {
+				$segmentStartDocId += $segInfo->count();
+				continue;
+			}
+
+			$frqFile = $segInfo->openCompoundFile('.frq');
+			$frqFile->seek($termInfo->freqPointer,SEEK_CUR);
+			$freqs = array();
+			$docId = 0;
+
+			for( $count = 0; $count < $termInfo->docFreq; $count++ ) {
+				$docDelta = $frqFile->readVInt();
+				if( $docDelta % 2 == 1 ) {
+					$docId += ($docDelta-1)/2;
+					$freqs[ $docId ] = 1;
+				} else {
+					$docId += $docDelta/2;
+					$freqs[ $docId ] = $frqFile->readVInt();
+				}
+			}
+
+			$prxFile = $segInfo->openCompoundFile('.prx');
+			$prxFile->seek($termInfo->proxPointer,SEEK_CUR);
+			foreach ($freqs as $docId => $freq) {
+				$termPosition = 0;
+				$positions = array();
+
+				for ($count = 0; $count < $freq; $count++ ) {
+					$termPosition += $prxFile->readVInt();
+					$positions[] = $termPosition;
+				}
+				$result[ $segmentStartDocId + $docId ] = $positions;
+			}
+
+			$segmentStartDocId += $segInfo->count();
+		}
+
+		return $result;
+	}
+
+
+	/**
+	 * Returns the number of documents in this index containing the $term.
+	 *
+	 * @param Zend_Search_Lucene_Index_Term $term
+	 * @return integer
+	 */
+	public function docFreq(Zend_Search_Lucene_Index_Term $term)
+	{
+		$result = 0;
+		foreach ($this->_segmentInfos as $segInfo) {
+			$termInfo = $segInfo->getTermInfo($term);
+			if ($termInfo !== null) {
+				$result += $termInfo->docFreq;
+			}
+		}
+
+		return $result;
+	}
+
+
+	/**
+	 * Retrive similarity used by index reader
+	 *
+	 * @return Zend_Search_Lucene_Search_Similarity
+	 */
+	public function getSimilarity()
+	{
+		return Zend_Search_Lucene_Search_Similarity::getDefault();
+	}
+
+
+	/**
+	 * Returns a normalization factor for "field, document" pair.
+	 *
+	 * @param integer $id
+	 * @param string $fieldName
+	 * @return Zend_Search_Lucene_Document
+	 */
+	public function norm( $id, $fieldName )
+	{
+		if( $id >= $this->_docCount )
+			return null;
+
+		$segCount = 0;
+		$nextSegmentStartId = $this->_segmentInfos[ 0 ]->count();
+		while( $nextSegmentStartId <= $id ) {
+			   $segCount++;
+			   $nextSegmentStartId += $this->_segmentInfos[ $segCount ]->count();
+		}
+
+		$segmentStartId = $nextSegmentStartId - $this->_segmentInfos[ $segCount ]->count();
+
+		return $this->_segmentInfos[ $segCount ]->norm($id - $segmentStartId, $fieldName);
+	}
+
+
+	/**
+	 * Adds a document to this index.
+	 *
+	 * @param Zend_Search_Lucene_Document $document
+	 */
+	public function addDocument(Zend_Search_Lucene_Document $document)
+	{
+		if (!$this->_writer instanceof Zend_Search_Lucene_Index_Writer) {
+			$this->_writer = new Zend_Search_Lucene_Index_Writer($this->_directory);
+		}
+
+		$this->_writer->addDocument($document);
+	}
+
+
+	/**
+	 * Commit changes resulting from delete() or undeleteAll() operations.
+	 *
+	 * @todo delete() and undeleteAll processing.
+	 */
+	public function commit()
+	{
+		if ($this->_writer !== null) {
+			foreach ($this->_writer->commit() as $segmentName => $segmentInfo) {
+				if ($segmentInfo !== null) {
+					$this->_segmentInfos[] = $segmentInfo;
+					$this->_docCount += $segmentInfo->count();
+				} else {
+					foreach ($this->_segmentInfos as $segId => $segInfo) {
+						if ($segInfo->getName() == $segmentName) {
+							unset($this->_segmentInfos[$segId]);
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/*************************************************************************
     @todo UNIMPLEMENTED
     *************************************************************************/
 
-    /**
-     * Returns an array of all terms in this index.
-     *
-     * @todo Implementation
-     * @return array
-     */
-    public function terms()
-    {
-        return array();
-    }
-
-
-    /**
-     * Returns true if any documents have been deleted from this index.
-     *
-     * @todo Implementation
-     * @return boolean
-     */
-    public function hasDeletions()
-    {
-        return false;
-    }
-
-
-    /**
-     * Deletes a document from the index.  $doc may contain a Zend_Search_Lucene_Document
-     * or the number of the document to delete.
-     *
-     * @todo Implementation
-     * @param mixed $item_to_del
-     */
-    public function delete($doc)
-    {}
-
-
-    /**
-     * Undeletes all documents currently marked as deleted in this index.
-     *
-     * @todo Implementation
-     */
-    public function undeleteAll()
-    {}
+	/**
+	 * Returns an array of all terms in this index.
+	 *
+	 * @todo Implementation
+	 * @return array
+	 */
+	public function terms()
+	{
+		return array();
+	}
+
+
+	/**
+	 * Returns true if any documents have been deleted from this index.
+	 *
+	 * @todo Implementation
+	 * @return boolean
+	 */
+	public function hasDeletions()
+	{
+		return false;
+	}
+
+
+	/**
+	 * Deletes a document from the index.  $doc may contain a Zend_Search_Lucene_Document
+	 * or the number of the document to delete.
+	 *
+	 * @todo Implementation
+	 * @param mixed $item_to_del
+	 */
+	public function delete($doc)
+	{}
+
+
+	/**
+	 * Undeletes all documents currently marked as deleted in this index.
+	 *
+	 * @todo Implementation
+	 */
+	public function undeleteAll()
+	{}
 }
\ No newline at end of file

Spacing +41 added lines, -41 removed lines

@@ -130,7 +130,7 @@ 
 
         $format = $segmentsFile->readInt();
 
-        if ($format != (int)0xFFFFFFFF) {
+        if ($format != (int) 0xFFFFFFFF) {
             throw new Zend_Search_Lucene_Exception('Wrong segments file format');
         }
 
@@ -231,9 +231,9 @@ 
         $scores = array();
 
         $docNum = $this->count();
-        for( $count=0; $count < $docNum; $count++ ) {
-            $docScore = $query->score( $count, $this);
-            if( $docScore != 0 ) {
+        for ($count = 0; $count < $docNum; $count++) {
+            $docScore = $query->score($count, $this);
+            if ($docScore != 0) {
                 $hit = new Zend_Search_Lucene_Search_QueryHit($this);
                 $hit->id = $count;
                 $hit->score = $docScore;
@@ -257,7 +257,7 @@ 
     public function getFieldNames($indexed = false)
     {
         $result = array();
-        foreach( $this->_segmentInfos as $segmentInfo ) {
+        foreach ($this->_segmentInfos as $segmentInfo) {
             $result = array_merge($result, $segmentInfo->getFields($indexed));
         }
         return $result;
@@ -286,40 +286,40 @@ 
         }
 
         $segCount = 0;
-        $nextSegmentStartId = $this->_segmentInfos[ 0 ]->count();
-        while( $nextSegmentStartId <= $id ) {
+        $nextSegmentStartId = $this->_segmentInfos[0]->count();
+        while ($nextSegmentStartId <= $id) {
                $segCount++;
-               $nextSegmentStartId += $this->_segmentInfos[ $segCount ]->count();
+               $nextSegmentStartId += $this->_segmentInfos[$segCount]->count();
         }
-        $segmentStartId = $nextSegmentStartId - $this->_segmentInfos[ $segCount ]->count();
+        $segmentStartId = $nextSegmentStartId - $this->_segmentInfos[$segCount]->count();
 
-        $fdxFile = $this->_segmentInfos[ $segCount ]->openCompoundFile('.fdx');
-        $fdxFile->seek( ($id-$segmentStartId)*8, SEEK_CUR );
+        $fdxFile = $this->_segmentInfos[$segCount]->openCompoundFile('.fdx');
+        $fdxFile->seek(($id - $segmentStartId) * 8, SEEK_CUR);
         $fieldValuesPosition = $fdxFile->readLong();
 
-        $fdtFile = $this->_segmentInfos[ $segCount ]->openCompoundFile('.fdt');
-        $fdtFile->seek( $fieldValuesPosition, SEEK_CUR );
+        $fdtFile = $this->_segmentInfos[$segCount]->openCompoundFile('.fdt');
+        $fdtFile->seek($fieldValuesPosition, SEEK_CUR);
         $fieldCount = $fdtFile->readVInt();
 
         $doc = new Zend_Search_Lucene_Document();
-        for( $count = 0; $count < $fieldCount; $count++ ) {
+        for ($count = 0; $count < $fieldCount; $count++) {
             $fieldNum = $fdtFile->readVInt();
             $bits = $fdtFile->readByte();
 
-            $fieldInfo = $this->_segmentInfos[ $segCount ]->getField($fieldNum);
+            $fieldInfo = $this->_segmentInfos[$segCount]->getField($fieldNum);
 
-            if( !($bits & 2) ) { // Text data
+            if (!($bits & 2)) { // Text data
                 $field = new Zend_Search_Lucene_Field($fieldInfo->name,
                                                       $fdtFile->readString(),
                                                       true,
                                                       $fieldInfo->isIndexed,
-                                                      $bits & 1 );
+                                                      $bits & 1);
             } else {
                 $field = new Zend_Search_Lucene_Field($fieldInfo->name,
                                                       $fdtFile->readBinary(),
                                                       true,
                                                       $fieldInfo->isIndexed,
-                                                      $bits & 1 );
+                                                      $bits & 1);
             }
 
             $doc->addField($field);
@@ -349,14 +349,14 @@ 
             }
 
             $frqFile = $segInfo->openCompoundFile('.frq');
-            $frqFile->seek($termInfo->freqPointer,SEEK_CUR);
+            $frqFile->seek($termInfo->freqPointer, SEEK_CUR);
             $docId = 0;
-            for( $count=0; $count < $termInfo->docFreq; $count++ ) {
+            for ($count = 0; $count < $termInfo->docFreq; $count++) {
                 $docDelta = $frqFile->readVInt();
-                if( $docDelta % 2 == 1 ) {
-                    $docId += ($docDelta-1)/2;
+                if ($docDelta % 2 == 1) {
+                    $docId += ($docDelta - 1) / 2;
                 } else {
-                    $docId += $docDelta/2;
+                    $docId += $docDelta / 2;
                     // read freq
                     $frqFile->readVInt();
                 }
@@ -381,7 +381,7 @@ 
     {
         $result = array();
         $segmentStartDocId = 0;
-        foreach( $this->_segmentInfos as $segInfo ) {
+        foreach ($this->_segmentInfos as $segInfo) {
             $termInfo = $segInfo->getTermInfo($term);
 
             if (!$termInfo instanceof Zend_Search_Lucene_Index_TermInfo) {
@@ -390,32 +390,32 @@ 
             }
 
             $frqFile = $segInfo->openCompoundFile('.frq');
-            $frqFile->seek($termInfo->freqPointer,SEEK_CUR);
+            $frqFile->seek($termInfo->freqPointer, SEEK_CUR);
             $freqs = array();
             $docId = 0;
 
-            for( $count = 0; $count < $termInfo->docFreq; $count++ ) {
+            for ($count = 0; $count < $termInfo->docFreq; $count++) {
                 $docDelta = $frqFile->readVInt();
-                if( $docDelta % 2 == 1 ) {
-                    $docId += ($docDelta-1)/2;
-                    $freqs[ $docId ] = 1;
+                if ($docDelta % 2 == 1) {
+                    $docId += ($docDelta - 1) / 2;
+                    $freqs[$docId] = 1;
                 } else {
-                    $docId += $docDelta/2;
-                    $freqs[ $docId ] = $frqFile->readVInt();
+                    $docId += $docDelta / 2;
+                    $freqs[$docId] = $frqFile->readVInt();
                 }
             }
 
             $prxFile = $segInfo->openCompoundFile('.prx');
-            $prxFile->seek($termInfo->proxPointer,SEEK_CUR);
+            $prxFile->seek($termInfo->proxPointer, SEEK_CUR);
             foreach ($freqs as $docId => $freq) {
                 $termPosition = 0;
                 $positions = array();
 
-                for ($count = 0; $count < $freq; $count++ ) {
+                for ($count = 0; $count < $freq; $count++) {
                     $termPosition += $prxFile->readVInt();
                     $positions[] = $termPosition;
                 }
-                $result[ $segmentStartDocId + $docId ] = $positions;
+                $result[$segmentStartDocId + $docId] = $positions;
             }
 
             $segmentStartDocId += $segInfo->count();
@@ -463,21 +463,21 @@ 
      * @param string $fieldName
      * @return Zend_Search_Lucene_Document
      */
-    public function norm( $id, $fieldName )
+    public function norm($id, $fieldName)
     {
-        if( $id >= $this->_docCount )
+        if ($id >= $this->_docCount)
             return null;
 
         $segCount = 0;
-        $nextSegmentStartId = $this->_segmentInfos[ 0 ]->count();
-        while( $nextSegmentStartId <= $id ) {
+        $nextSegmentStartId = $this->_segmentInfos[0]->count();
+        while ($nextSegmentStartId <= $id) {
                $segCount++;
-               $nextSegmentStartId += $this->_segmentInfos[ $segCount ]->count();
+               $nextSegmentStartId += $this->_segmentInfos[$segCount]->count();
         }
 
-        $segmentStartId = $nextSegmentStartId - $this->_segmentInfos[ $segCount ]->count();
+        $segmentStartId = $nextSegmentStartId - $this->_segmentInfos[$segCount]->count();
 
-        return $this->_segmentInfos[ $segCount ]->norm($id - $segmentStartId, $fieldName);
+        return $this->_segmentInfos[$segCount]->norm($id - $segmentStartId, $fieldName);
     }
 
 

demos/quickstart/protected/index/Zend/Search/Lucene/Analysis/Analyzer.php

Doc Comments -1 removed lines

@@ -68,7 +68,6 @@
     /**
      * Set the default Analyzer implementation used by indexing code.
      *
-     * @param Zend_Search_Lucene_Analysis_Analyzer $similarity
      */
     static public function setDefault(Zend_Search_Lucene_Analysis_Analyzer $analyzer)
     {

Indentation +41 added lines, -41 removed lines

@@ -48,47 +48,47 @@
 
 abstract class Zend_Search_Lucene_Analysis_Analyzer
 {
-    /**
-     * The Analyzer implementation used by default.
-     *
-     * @var Zend_Search_Lucene_Analysis_Analyzer
-     */
-    static private $_defaultImpl;
-
-    /**
-     * Tokenize text to a terms
-     * Returns array of Zend_Search_Lucene_Analysis_Token objects
-     *
-     * @param string $data
-     * @return array
-     */
-    abstract public function tokenize($data);
-
-
-    /**
-     * Set the default Analyzer implementation used by indexing code.
-     *
-     * @param Zend_Search_Lucene_Analysis_Analyzer $similarity
-     */
-    static public function setDefault(Zend_Search_Lucene_Analysis_Analyzer $analyzer)
-    {
-        self::$_defaultImpl = $analyzer;
-    }
-
-
-    /**
-     * Return the default Analyzer implementation used by indexing code.
-     *
-     * @return Zend_Search_Lucene_Analysis_Analyzer
-     */
-    static public function getDefault()
-    {
-        if (!self::$_defaultImpl instanceof Zend_Search_Lucene_Analysis_Analyzer) {
-            self::$_defaultImpl = new Zend_Search_Lucene_Analysis_Analyzer_Common_Text_CaseInsensitive();
-        }
-
-        return self::$_defaultImpl;
-    }
+	/**
+	 * The Analyzer implementation used by default.
+	 *
+	 * @var Zend_Search_Lucene_Analysis_Analyzer
+	 */
+	static private $_defaultImpl;
+
+	/**
+	 * Tokenize text to a terms
+	 * Returns array of Zend_Search_Lucene_Analysis_Token objects
+	 *
+	 * @param string $data
+	 * @return array
+	 */
+	abstract public function tokenize($data);
+
+
+	/**
+	 * Set the default Analyzer implementation used by indexing code.
+	 *
+	 * @param Zend_Search_Lucene_Analysis_Analyzer $similarity
+	 */
+	static public function setDefault(Zend_Search_Lucene_Analysis_Analyzer $analyzer)
+	{
+		self::$_defaultImpl = $analyzer;
+	}
+
+
+	/**
+	 * Return the default Analyzer implementation used by indexing code.
+	 *
+	 * @return Zend_Search_Lucene_Analysis_Analyzer
+	 */
+	static public function getDefault()
+	{
+		if (!self::$_defaultImpl instanceof Zend_Search_Lucene_Analysis_Analyzer) {
+			self::$_defaultImpl = new Zend_Search_Lucene_Analysis_Analyzer_Common_Text_CaseInsensitive();
+		}
+
+		return self::$_defaultImpl;
+	}
 
 }
 

demos/quickstart/protected/index/Zend/Search/Lucene/Index/SegmentInfo.php

Doc Comments +1 added lines, -1 removed lines

@@ -391,7 +391,7 @@
      *
      * @param integer $id
      * @param string $fieldName
-     * @return string
+     * @return null|double
      */
     public function norm($id, $fieldName)
     {

Indentation +377 added lines, -377 removed lines

@@ -31,382 +31,382 @@
  */
 class Zend_Search_Lucene_Index_SegmentInfo
 {
-    /**
-     * Number of docs in a segment
-     *
-     * @var integer
-     */
-    private $_docCount;
-
-    /**
-     * Segment name
-     *
-     * @var string
-     */
-    private $_name;
-
-    /**
-     * Term Dictionary Index
-     * Array of the Zend_Search_Lucene_Index_Term objects
-     * Corresponding Zend_Search_Lucene_Index_TermInfo object stored in the $_termDictionaryInfos
-     *
-     * @var array
-     */
-    private $_termDictionary;
-
-    /**
-     * Term Dictionary Index TermInfos
-     * Array of the Zend_Search_Lucene_Index_TermInfo objects
-     *
-     * @var array
-     */
-    private $_termDictionaryInfos;
-
-    /**
-     * Segment fields. Array of Zend_Search_Lucene_Index_FieldInfo objects for this segment
-     *
-     * @var array
-     */
-    private $_fields;
-
-    /**
-     * Field positions in a dictionary.
-     * (Term dictionary contains filelds ordered by names)
-     *
-     * @var array
-     */
-    private $_fieldsDicPositions;
-
-
-    /**
-     * Associative array where the key is the file name and the value is data offset
-     * in a compound segment file (.csf).
-     *
-     * @var array
-     */
-    private $_segFiles;
-
-    /**
-     * File system adapter.
-     *
-     * @var Zend_Search_Lucene_Storage_Directory_Filesystem
-     */
-    private $_directory;
-
-    /**
-     * Normalization factors.
-     * An array fieldName => normVector
-     * normVector is a binary string.
-     * Each byte corresponds to an indexed document in a segment and
-     * encodes normalization factor (float value, encoded by
-     * Zend_Search_Lucene_Search_Similarity::encodeNorm())
-     *
-     * @var array
-     */
-    private $_norms = array();
-
-    /**
-     * Zend_Search_Lucene_Index_SegmentInfo constructor needs Segmentname,
-     * Documents count and Directory as a parameter.
-     *
-     * @param string $name
-     * @param integer $docCount
-     * @param Zend_Search_Lucene_Storage_Directory $directory
-     */
-    public function __construct($name, $docCount, $directory)
-    {
-        $this->_name = $name;
-        $this->_docCount = $docCount;
-        $this->_directory = $directory;
-        $this->_termDictionary = null;
-
-        $this->_segFiles = array();
-        $cfsFile = $this->_directory->getFileObject($name . '.cfs');
-        $segFilesCount = $cfsFile->readVInt();
-
-        for ($count = 0; $count < $segFilesCount; $count++) {
-            $dataOffset = $cfsFile->readLong();
-            $fileName = $cfsFile->readString();
-            $this->_segFiles[$fileName] = $dataOffset;
-        }
-
-        $fnmFile = $this->openCompoundFile('.fnm');
-        $fieldsCount = $fnmFile->readVInt();
-        $fieldNames = array();
-        $fieldNums  = array();
-        $this->_fields = array();
-        for ($count=0; $count < $fieldsCount; $count++) {
-            $fieldName = $fnmFile->readString();
-            $fieldBits = $fnmFile->readByte();
-            $this->_fields[$count] = new Zend_Search_Lucene_Index_FieldInfo($fieldName,
-                                                                            $fieldBits & 1,
-                                                                            $count,
-                                                                            $fieldBits & 2 );
-            if ($fieldBits & 0x10) {
-                // norms are omitted for the indexed field
-                $this->_norms[$count] = str_repeat(chr(Zend_Search_Lucene_Search_Similarity::encodeNorm(1.0)), $docCount);
-            }
-
-            $fieldNums[$count]  = $count;
-            $fieldNames[$count] = $fieldName;
-        }
-        array_multisort($fieldNames, SORT_ASC, SORT_REGULAR, $fieldNums);
-        $this->_fieldsDicPositions = array_flip($fieldNums);
-    }
-
-    /**
-     * Opens index file stoted within compound index file
-     *
-     * @param string $extension
-     * @throws Zend_Search_Lucene_Exception
-     * @return Zend_Search_Lucene_Storage_File
-     */
-    public function openCompoundFile($extension)
-    {
-        $filename = $this->_name . $extension;
-
-        if( !isset($this->_segFiles[ $filename ]) ) {
-            throw new Zend_Search_Lucene_Exception('Index compound file doesn\'t contain '
-                                       . $filename . ' file.' );
-        }
-
-        $file = $this->_directory->getFileObject( $this->_name.".cfs" );
-        $file->seek( $this->_segFiles[ $filename ] );
-        return $file;
-    }
-
-    /**
-     * Returns field index or -1 if field is not found
-     *
-     * @param string $fieldName
-     * @return integer
-     */
-    public function getFieldNum($fieldName)
-    {
-        foreach( $this->_fields as $field ) {
-            if( $field->name == $fieldName ) {
-                return $field->number;
-            }
-        }
-
-        return -1;
-    }
-
-    /**
-     * Returns field info for specified field
-     *
-     * @param integer $fieldNum
-     * @return ZSearchFieldInfo
-     */
-    public function getField($fieldNum)
-    {
-        return $this->_fields[$fieldNum];
-    }
-
-    /**
-     * Returns array of fields.
-     * if $indexed parameter is true, then returns only indexed fields.
-     *
-     * @param boolean $indexed
-     * @return array
-     */
-    public function getFields($indexed = false)
-    {
-        $result = array();
-        foreach( $this->_fields as $field ) {
-            if( (!$indexed) || $field->isIndexed ) {
-                $result[ $field->name ] = $field->name;
-            }
-        }
-        return $result;
-    }
-
-    /**
-     * Returns the total number of documents in this segment.
-     *
-     * @return integer
-     */
-    public function count()
-    {
-        return $this->_docCount;
-    }
-
-
-    /**
-     * Loads Term dictionary from TermInfoIndex file
-     */
-    protected function _loadDictionary()
-    {
-        if ($this->_termDictionary !== null) {
-            return;
-        }
-
-        $this->_termDictionary = array();
-        $this->_termDictionaryInfos = array();
-
-        $tiiFile = $this->openCompoundFile('.tii');
-        $tiVersion = $tiiFile->readInt();
-        if ($tiVersion != (int)0xFFFFFFFE) {
-            throw new Zend_Search_Lucene_Exception('Wrong TermInfoIndexFile file format');
-        }
-
-        $indexTermCount = $tiiFile->readLong();
-                          $tiiFile->readInt();  // IndexInterval
-        $skipInterval   = $tiiFile->readInt();
-
-        $prevTerm     = '';
-        $freqPointer  =  0;
-        $proxPointer  =  0;
-        $indexPointer =  0;
-        for ($count = 0; $count < $indexTermCount; $count++) {
-            $termPrefixLength = $tiiFile->readVInt();
-            $termSuffix       = $tiiFile->readString();
-            $termValue        = substr( $prevTerm, 0, $termPrefixLength ) . $termSuffix;
-
-            $termFieldNum     = $tiiFile->readVInt();
-            $docFreq          = $tiiFile->readVInt();
-            $freqPointer     += $tiiFile->readVInt();
-            $proxPointer     += $tiiFile->readVInt();
-            if( $docFreq >= $skipInterval ) {
-                $skipDelta = $tiiFile->readVInt();
-            } else {
-                $skipDelta = 0;
-            }
-
-            $indexPointer += $tiiFile->readVInt();
-
-            $this->_termDictionary[] =  new Zend_Search_Lucene_Index_Term($termValue,$termFieldNum);
-            $this->_termDictionaryInfos[] =
-                new Zend_Search_Lucene_Index_TermInfo($docFreq, $freqPointer, $proxPointer, $skipDelta, $indexPointer);
-            $prevTerm = $termValue;
-        }
-    }
-
-
-    /**
-     * Return segment name
-     *
-     * @return string
-     */
-    public function getName()
-    {
-        return $this->_name;
-    }
-
-
-    /**
-     * Scans terms dictionary and returns term info
-     *
-     * @param Zend_Search_Lucene_Index_Term $term
-     * @return Zend_Search_Lucene_Index_TermInfo
-     */
-    public function getTermInfo($term)
-    {
-        $this->_loadDictionary();
-
-        $searchField = $this->getFieldNum($term->field);
-
-        if ($searchField == -1) {
-            return null;
-        }
-        $searchDicField = $this->_fieldsDicPositions[$searchField];
-
-        // search for appropriate value in dictionary
-        $lowIndex = 0;
-        $highIndex = count($this->_termDictionary)-1;
-        while ($highIndex >= $lowIndex) {
-            // $mid = ($highIndex - $lowIndex)/2;
-            $mid = ($highIndex + $lowIndex) >> 1;
-            $midTerm = $this->_termDictionary[$mid];
-
-            $delta = $searchDicField - $this->_fieldsDicPositions[$midTerm->field];
-            if ($delta == 0) {
-                $delta = strcmp($term->text, $midTerm->text);
-            }
-
-            if ($delta < 0) {
-                $highIndex = $mid-1;
-            } elseif ($delta > 0) {
-                $lowIndex  = $mid+1;
-            } else {
-                return $this->_termDictionaryInfos[$mid]; // We got it!
-            }
-        }
-
-        if ($highIndex == -1) {
-            // Term is out of the dictionary range
-            return null;
-        }
-
-        $prevPosition = $highIndex;
-        $prevTerm = $this->_termDictionary[$prevPosition];
-        $prevTermInfo = $this->_termDictionaryInfos[ $prevPosition ];
-
-        $tisFile = $this->openCompoundFile('.tis');
-        $tiVersion = $tisFile->readInt();
-        if ($tiVersion != (int)0xFFFFFFFE) {
-            throw new Zend_Search_Lucene_Exception('Wrong TermInfoFile file format');
-        }
-
-        $termCount     = $tisFile->readLong();
-        $indexInterval = $tisFile->readInt();
-        $skipInterval  = $tisFile->readInt();
-
-        $tisFile->seek($prevTermInfo->indexPointer - 20 /* header size*/, SEEK_CUR);
-
-        $termValue    = $prevTerm->text;
-        $termFieldNum = $prevTerm->field;
-        $freqPointer = $prevTermInfo->freqPointer;
-        $proxPointer = $prevTermInfo->proxPointer;
-        for ($count = $prevPosition*$indexInterval + 1;
-             $count < $termCount &&
-             ( $this->_fieldsDicPositions[ $termFieldNum ] < $searchDicField ||
-              ($this->_fieldsDicPositions[ $termFieldNum ] == $searchDicField &&
-               strcmp($termValue, $term->text) < 0) );
-             $count++) {
-            $termPrefixLength = $tisFile->readVInt();
-            $termSuffix       = $tisFile->readString();
-            $termFieldNum     = $tisFile->readVInt();
-            $termValue        = substr( $termValue, 0, $termPrefixLength ) . $termSuffix;
-
-            $docFreq      = $tisFile->readVInt();
-            $freqPointer += $tisFile->readVInt();
-            $proxPointer += $tisFile->readVInt();
-            if( $docFreq >= $skipInterval ) {
-                $skipOffset = $tisFile->readVInt();
-            } else {
-                $skipOffset = 0;
-            }
-        }
-
-        if ($termFieldNum == $searchField && $termValue == $term->text) {
-            return new Zend_Search_Lucene_Index_TermInfo($docFreq, $freqPointer, $proxPointer, $skipOffset);
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Returns normalization factor for specified documents
-     *
-     * @param integer $id
-     * @param string $fieldName
-     * @return string
-     */
-    public function norm($id, $fieldName)
-    {
-        $fieldNum = $this->getFieldNum($fieldName);
-
-        if ( !($this->_fields[$fieldNum]->isIndexed) ) {
-            return null;
-        }
-
-        if ( !isset( $this->_norms[$fieldNum] )) {
-            $fFile = $this->openCompoundFile('.f' . $fieldNum);
-            $this->_norms[$fieldNum] = $fFile->readBytes($this->_docCount);
-        }
-
-        return Zend_Search_Lucene_Search_Similarity::decodeNorm( ord($this->_norms[$fieldNum]{$id}) );
-    }
+	/**
+	 * Number of docs in a segment
+	 *
+	 * @var integer
+	 */
+	private $_docCount;
+
+	/**
+	 * Segment name
+	 *
+	 * @var string
+	 */
+	private $_name;
+
+	/**
+	 * Term Dictionary Index
+	 * Array of the Zend_Search_Lucene_Index_Term objects
+	 * Corresponding Zend_Search_Lucene_Index_TermInfo object stored in the $_termDictionaryInfos
+	 *
+	 * @var array
+	 */
+	private $_termDictionary;
+
+	/**
+	 * Term Dictionary Index TermInfos
+	 * Array of the Zend_Search_Lucene_Index_TermInfo objects
+	 *
+	 * @var array
+	 */
+	private $_termDictionaryInfos;
+
+	/**
+	 * Segment fields. Array of Zend_Search_Lucene_Index_FieldInfo objects for this segment
+	 *
+	 * @var array
+	 */
+	private $_fields;
+
+	/**
+	 * Field positions in a dictionary.
+	 * (Term dictionary contains filelds ordered by names)
+	 *
+	 * @var array
+	 */
+	private $_fieldsDicPositions;
+
+
+	/**
+	 * Associative array where the key is the file name and the value is data offset
+	 * in a compound segment file (.csf).
+	 *
+	 * @var array
+	 */
+	private $_segFiles;
+
+	/**
+	 * File system adapter.
+	 *
+	 * @var Zend_Search_Lucene_Storage_Directory_Filesystem
+	 */
+	private $_directory;
+
+	/**
+	 * Normalization factors.
+	 * An array fieldName => normVector
+	 * normVector is a binary string.
+	 * Each byte corresponds to an indexed document in a segment and
+	 * encodes normalization factor (float value, encoded by
+	 * Zend_Search_Lucene_Search_Similarity::encodeNorm())
+	 *
+	 * @var array
+	 */
+	private $_norms = array();
+
+	/**
+	 * Zend_Search_Lucene_Index_SegmentInfo constructor needs Segmentname,
+	 * Documents count and Directory as a parameter.
+	 *
+	 * @param string $name
+	 * @param integer $docCount
+	 * @param Zend_Search_Lucene_Storage_Directory $directory
+	 */
+	public function __construct($name, $docCount, $directory)
+	{
+		$this->_name = $name;
+		$this->_docCount = $docCount;
+		$this->_directory = $directory;
+		$this->_termDictionary = null;
+
+		$this->_segFiles = array();
+		$cfsFile = $this->_directory->getFileObject($name . '.cfs');
+		$segFilesCount = $cfsFile->readVInt();
+
+		for ($count = 0; $count < $segFilesCount; $count++) {
+			$dataOffset = $cfsFile->readLong();
+			$fileName = $cfsFile->readString();
+			$this->_segFiles[$fileName] = $dataOffset;
+		}
+
+		$fnmFile = $this->openCompoundFile('.fnm');
+		$fieldsCount = $fnmFile->readVInt();
+		$fieldNames = array();
+		$fieldNums  = array();
+		$this->_fields = array();
+		for ($count=0; $count < $fieldsCount; $count++) {
+			$fieldName = $fnmFile->readString();
+			$fieldBits = $fnmFile->readByte();
+			$this->_fields[$count] = new Zend_Search_Lucene_Index_FieldInfo($fieldName,
+																			$fieldBits & 1,
+																			$count,
+																			$fieldBits & 2 );
+			if ($fieldBits & 0x10) {
+				// norms are omitted for the indexed field
+				$this->_norms[$count] = str_repeat(chr(Zend_Search_Lucene_Search_Similarity::encodeNorm(1.0)), $docCount);
+			}
+
+			$fieldNums[$count]  = $count;
+			$fieldNames[$count] = $fieldName;
+		}
+		array_multisort($fieldNames, SORT_ASC, SORT_REGULAR, $fieldNums);
+		$this->_fieldsDicPositions = array_flip($fieldNums);
+	}
+
+	/**
+	 * Opens index file stoted within compound index file
+	 *
+	 * @param string $extension
+	 * @throws Zend_Search_Lucene_Exception
+	 * @return Zend_Search_Lucene_Storage_File
+	 */
+	public function openCompoundFile($extension)
+	{
+		$filename = $this->_name . $extension;
+
+		if( !isset($this->_segFiles[ $filename ]) ) {
+			throw new Zend_Search_Lucene_Exception('Index compound file doesn\'t contain '
+									   . $filename . ' file.' );
+		}
+
+		$file = $this->_directory->getFileObject( $this->_name.".cfs" );
+		$file->seek( $this->_segFiles[ $filename ] );
+		return $file;
+	}
+
+	/**
+	 * Returns field index or -1 if field is not found
+	 *
+	 * @param string $fieldName
+	 * @return integer
+	 */
+	public function getFieldNum($fieldName)
+	{
+		foreach( $this->_fields as $field ) {
+			if( $field->name == $fieldName ) {
+				return $field->number;
+			}
+		}
+
+		return -1;
+	}
+
+	/**
+	 * Returns field info for specified field
+	 *
+	 * @param integer $fieldNum
+	 * @return ZSearchFieldInfo
+	 */
+	public function getField($fieldNum)
+	{
+		return $this->_fields[$fieldNum];
+	}
+
+	/**
+	 * Returns array of fields.
+	 * if $indexed parameter is true, then returns only indexed fields.
+	 *
+	 * @param boolean $indexed
+	 * @return array
+	 */
+	public function getFields($indexed = false)
+	{
+		$result = array();
+		foreach( $this->_fields as $field ) {
+			if( (!$indexed) || $field->isIndexed ) {
+				$result[ $field->name ] = $field->name;
+			}
+		}
+		return $result;
+	}
+
+	/**
+	 * Returns the total number of documents in this segment.
+	 *
+	 * @return integer
+	 */
+	public function count()
+	{
+		return $this->_docCount;
+	}
+
+
+	/**
+	 * Loads Term dictionary from TermInfoIndex file
+	 */
+	protected function _loadDictionary()
+	{
+		if ($this->_termDictionary !== null) {
+			return;
+		}
+
+		$this->_termDictionary = array();
+		$this->_termDictionaryInfos = array();
+
+		$tiiFile = $this->openCompoundFile('.tii');
+		$tiVersion = $tiiFile->readInt();
+		if ($tiVersion != (int)0xFFFFFFFE) {
+			throw new Zend_Search_Lucene_Exception('Wrong TermInfoIndexFile file format');
+		}
+
+		$indexTermCount = $tiiFile->readLong();
+						  $tiiFile->readInt();  // IndexInterval
+		$skipInterval   = $tiiFile->readInt();
+
+		$prevTerm     = '';
+		$freqPointer  =  0;
+		$proxPointer  =  0;
+		$indexPointer =  0;
+		for ($count = 0; $count < $indexTermCount; $count++) {
+			$termPrefixLength = $tiiFile->readVInt();
+			$termSuffix       = $tiiFile->readString();
+			$termValue        = substr( $prevTerm, 0, $termPrefixLength ) . $termSuffix;
+
+			$termFieldNum     = $tiiFile->readVInt();
+			$docFreq          = $tiiFile->readVInt();
+			$freqPointer     += $tiiFile->readVInt();
+			$proxPointer     += $tiiFile->readVInt();
+			if( $docFreq >= $skipInterval ) {
+				$skipDelta = $tiiFile->readVInt();
+			} else {
+				$skipDelta = 0;
+			}
+
+			$indexPointer += $tiiFile->readVInt();
+
+			$this->_termDictionary[] =  new Zend_Search_Lucene_Index_Term($termValue,$termFieldNum);
+			$this->_termDictionaryInfos[] =
+				new Zend_Search_Lucene_Index_TermInfo($docFreq, $freqPointer, $proxPointer, $skipDelta, $indexPointer);
+			$prevTerm = $termValue;
+		}
+	}
+
+
+	/**
+	 * Return segment name
+	 *
+	 * @return string
+	 */
+	public function getName()
+	{
+		return $this->_name;
+	}
+
+
+	/**
+	 * Scans terms dictionary and returns term info
+	 *
+	 * @param Zend_Search_Lucene_Index_Term $term
+	 * @return Zend_Search_Lucene_Index_TermInfo
+	 */
+	public function getTermInfo($term)
+	{
+		$this->_loadDictionary();
+
+		$searchField = $this->getFieldNum($term->field);
+
+		if ($searchField == -1) {
+			return null;
+		}
+		$searchDicField = $this->_fieldsDicPositions[$searchField];
+
+		// search for appropriate value in dictionary
+		$lowIndex = 0;
+		$highIndex = count($this->_termDictionary)-1;
+		while ($highIndex >= $lowIndex) {
+			// $mid = ($highIndex - $lowIndex)/2;
+			$mid = ($highIndex + $lowIndex) >> 1;
+			$midTerm = $this->_termDictionary[$mid];
+
+			$delta = $searchDicField - $this->_fieldsDicPositions[$midTerm->field];
+			if ($delta == 0) {
+				$delta = strcmp($term->text, $midTerm->text);
+			}
+
+			if ($delta < 0) {
+				$highIndex = $mid-1;
+			} elseif ($delta > 0) {
+				$lowIndex  = $mid+1;
+			} else {
+				return $this->_termDictionaryInfos[$mid]; // We got it!
+			}
+		}
+
+		if ($highIndex == -1) {
+			// Term is out of the dictionary range
+			return null;
+		}
+
+		$prevPosition = $highIndex;
+		$prevTerm = $this->_termDictionary[$prevPosition];
+		$prevTermInfo = $this->_termDictionaryInfos[ $prevPosition ];
+
+		$tisFile = $this->openCompoundFile('.tis');
+		$tiVersion = $tisFile->readInt();
+		if ($tiVersion != (int)0xFFFFFFFE) {
+			throw new Zend_Search_Lucene_Exception('Wrong TermInfoFile file format');
+		}
+
+		$termCount     = $tisFile->readLong();
+		$indexInterval = $tisFile->readInt();
+		$skipInterval  = $tisFile->readInt();
+
+		$tisFile->seek($prevTermInfo->indexPointer - 20 /* header size*/, SEEK_CUR);
+
+		$termValue    = $prevTerm->text;
+		$termFieldNum = $prevTerm->field;
+		$freqPointer = $prevTermInfo->freqPointer;
+		$proxPointer = $prevTermInfo->proxPointer;
+		for ($count = $prevPosition*$indexInterval + 1;
+			 $count < $termCount &&
+			 ( $this->_fieldsDicPositions[ $termFieldNum ] < $searchDicField ||
+			  ($this->_fieldsDicPositions[ $termFieldNum ] == $searchDicField &&
+			   strcmp($termValue, $term->text) < 0) );
+			 $count++) {
+			$termPrefixLength = $tisFile->readVInt();
+			$termSuffix       = $tisFile->readString();
+			$termFieldNum     = $tisFile->readVInt();
+			$termValue        = substr( $termValue, 0, $termPrefixLength ) . $termSuffix;
+
+			$docFreq      = $tisFile->readVInt();
+			$freqPointer += $tisFile->readVInt();
+			$proxPointer += $tisFile->readVInt();
+			if( $docFreq >= $skipInterval ) {
+				$skipOffset = $tisFile->readVInt();
+			} else {
+				$skipOffset = 0;
+			}
+		}
+
+		if ($termFieldNum == $searchField && $termValue == $term->text) {
+			return new Zend_Search_Lucene_Index_TermInfo($docFreq, $freqPointer, $proxPointer, $skipOffset);
+		} else {
+			return null;
+		}
+	}
+
+	/**
+	 * Returns normalization factor for specified documents
+	 *
+	 * @param integer $id
+	 * @param string $fieldName
+	 * @return string
+	 */
+	public function norm($id, $fieldName)
+	{
+		$fieldNum = $this->getFieldNum($fieldName);
+
+		if ( !($this->_fields[$fieldNum]->isIndexed) ) {
+			return null;
+		}
+
+		if ( !isset( $this->_norms[$fieldNum] )) {
+			$fFile = $this->openCompoundFile('.f' . $fieldNum);
+			$this->_norms[$fieldNum] = $fFile->readBytes($this->_docCount);
+		}
+
+		return Zend_Search_Lucene_Search_Similarity::decodeNorm( ord($this->_norms[$fieldNum]{$id}) );
+	}
 }
 

Spacing +33 added lines, -33 removed lines

@@ -135,13 +135,13 @@ 
         $fieldNames = array();
         $fieldNums  = array();
         $this->_fields = array();
-        for ($count=0; $count < $fieldsCount; $count++) {
+        for ($count = 0; $count < $fieldsCount; $count++) {
             $fieldName = $fnmFile->readString();
             $fieldBits = $fnmFile->readByte();
             $this->_fields[$count] = new Zend_Search_Lucene_Index_FieldInfo($fieldName,
                                                                             $fieldBits & 1,
                                                                             $count,
-                                                                            $fieldBits & 2 );
+                                                                            $fieldBits & 2);
             if ($fieldBits & 0x10) {
                 // norms are omitted for the indexed field
                 $this->_norms[$count] = str_repeat(chr(Zend_Search_Lucene_Search_Similarity::encodeNorm(1.0)), $docCount);
@@ -165,13 +165,13 @@ 
     {
         $filename = $this->_name . $extension;
 
-        if( !isset($this->_segFiles[ $filename ]) ) {
+        if (!isset($this->_segFiles[$filename])) {
             throw new Zend_Search_Lucene_Exception('Index compound file doesn\'t contain '
-                                       . $filename . ' file.' );
+                                       . $filename . ' file.');
         }
 
-        $file = $this->_directory->getFileObject( $this->_name.".cfs" );
-        $file->seek( $this->_segFiles[ $filename ] );
+        $file = $this->_directory->getFileObject($this->_name . ".cfs");
+        $file->seek($this->_segFiles[$filename]);
         return $file;
     }
 
@@ -183,8 +183,8 @@ 
      */
     public function getFieldNum($fieldName)
     {
-        foreach( $this->_fields as $field ) {
-            if( $field->name == $fieldName ) {
+        foreach ($this->_fields as $field) {
+            if ($field->name == $fieldName) {
                 return $field->number;
             }
         }
@@ -213,9 +213,9 @@ 
     public function getFields($indexed = false)
     {
         $result = array();
-        foreach( $this->_fields as $field ) {
-            if( (!$indexed) || $field->isIndexed ) {
-                $result[ $field->name ] = $field->name;
+        foreach ($this->_fields as $field) {
+            if ((!$indexed) || $field->isIndexed) {
+                $result[$field->name] = $field->name;
             }
         }
         return $result;
@@ -246,28 +246,28 @@ 
 
         $tiiFile = $this->openCompoundFile('.tii');
         $tiVersion = $tiiFile->readInt();
-        if ($tiVersion != (int)0xFFFFFFFE) {
+        if ($tiVersion != (int) 0xFFFFFFFE) {
             throw new Zend_Search_Lucene_Exception('Wrong TermInfoIndexFile file format');
         }
 
         $indexTermCount = $tiiFile->readLong();
-                          $tiiFile->readInt();  // IndexInterval
+                          $tiiFile->readInt(); // IndexInterval
         $skipInterval   = $tiiFile->readInt();
 
         $prevTerm     = '';
-        $freqPointer  =  0;
-        $proxPointer  =  0;
-        $indexPointer =  0;
+        $freqPointer  = 0;
+        $proxPointer  = 0;
+        $indexPointer = 0;
         for ($count = 0; $count < $indexTermCount; $count++) {
             $termPrefixLength = $tiiFile->readVInt();
             $termSuffix       = $tiiFile->readString();
-            $termValue        = substr( $prevTerm, 0, $termPrefixLength ) . $termSuffix;
+            $termValue        = substr($prevTerm, 0, $termPrefixLength) . $termSuffix;
 
             $termFieldNum     = $tiiFile->readVInt();
             $docFreq          = $tiiFile->readVInt();
             $freqPointer     += $tiiFile->readVInt();
             $proxPointer     += $tiiFile->readVInt();
-            if( $docFreq >= $skipInterval ) {
+            if ($docFreq >= $skipInterval) {
                 $skipDelta = $tiiFile->readVInt();
             } else {
                 $skipDelta = 0;
@@ -275,7 +275,7 @@ 
 
             $indexPointer += $tiiFile->readVInt();
 
-            $this->_termDictionary[] =  new Zend_Search_Lucene_Index_Term($termValue,$termFieldNum);
+            $this->_termDictionary[] = new Zend_Search_Lucene_Index_Term($termValue, $termFieldNum);
             $this->_termDictionaryInfos[] =
                 new Zend_Search_Lucene_Index_TermInfo($docFreq, $freqPointer, $proxPointer, $skipDelta, $indexPointer);
             $prevTerm = $termValue;
@@ -313,7 +313,7 @@ 
 
         // search for appropriate value in dictionary
         $lowIndex = 0;
-        $highIndex = count($this->_termDictionary)-1;
+        $highIndex = count($this->_termDictionary) - 1;
         while ($highIndex >= $lowIndex) {
             // $mid = ($highIndex - $lowIndex)/2;
             $mid = ($highIndex + $lowIndex) >> 1;
@@ -325,9 +325,9 @@ 
             }
 
             if ($delta < 0) {
-                $highIndex = $mid-1;
+                $highIndex = $mid - 1;
             } elseif ($delta > 0) {
-                $lowIndex  = $mid+1;
+                $lowIndex  = $mid + 1;
             } else {
                 return $this->_termDictionaryInfos[$mid]; // We got it!
             }
@@ -340,11 +340,11 @@ 
 
         $prevPosition = $highIndex;
         $prevTerm = $this->_termDictionary[$prevPosition];
-        $prevTermInfo = $this->_termDictionaryInfos[ $prevPosition ];
+        $prevTermInfo = $this->_termDictionaryInfos[$prevPosition];
 
         $tisFile = $this->openCompoundFile('.tis');
         $tiVersion = $tisFile->readInt();
-        if ($tiVersion != (int)0xFFFFFFFE) {
+        if ($tiVersion != (int) 0xFFFFFFFE) {
             throw new Zend_Search_Lucene_Exception('Wrong TermInfoFile file format');
         }
 
@@ -358,21 +358,21 @@ 
         $termFieldNum = $prevTerm->field;
         $freqPointer = $prevTermInfo->freqPointer;
         $proxPointer = $prevTermInfo->proxPointer;
-        for ($count = $prevPosition*$indexInterval + 1;
+        for ($count = $prevPosition * $indexInterval + 1;
              $count < $termCount &&
-             ( $this->_fieldsDicPositions[ $termFieldNum ] < $searchDicField ||
-              ($this->_fieldsDicPositions[ $termFieldNum ] == $searchDicField &&
-               strcmp($termValue, $term->text) < 0) );
+             ($this->_fieldsDicPositions[$termFieldNum] < $searchDicField ||
+              ($this->_fieldsDicPositions[$termFieldNum] == $searchDicField &&
+               strcmp($termValue, $term->text) < 0));
              $count++) {
             $termPrefixLength = $tisFile->readVInt();
             $termSuffix       = $tisFile->readString();
             $termFieldNum     = $tisFile->readVInt();
-            $termValue        = substr( $termValue, 0, $termPrefixLength ) . $termSuffix;
+            $termValue        = substr($termValue, 0, $termPrefixLength) . $termSuffix;
 
             $docFreq      = $tisFile->readVInt();
             $freqPointer += $tisFile->readVInt();
             $proxPointer += $tisFile->readVInt();
-            if( $docFreq >= $skipInterval ) {
+            if ($docFreq >= $skipInterval) {
                 $skipOffset = $tisFile->readVInt();
             } else {
                 $skipOffset = 0;
@@ -397,16 +397,16 @@ 
     {
         $fieldNum = $this->getFieldNum($fieldName);
 
-        if ( !($this->_fields[$fieldNum]->isIndexed) ) {
+        if (!($this->_fields[$fieldNum]->isIndexed)) {
             return null;
         }
 
-        if ( !isset( $this->_norms[$fieldNum] )) {
+        if (!isset($this->_norms[$fieldNum])) {
             $fFile = $this->openCompoundFile('.f' . $fieldNum);
             $this->_norms[$fieldNum] = $fFile->readBytes($this->_docCount);
         }
 
-        return Zend_Search_Lucene_Search_Similarity::decodeNorm( ord($this->_norms[$fieldNum]{$id}) );
+        return Zend_Search_Lucene_Search_Similarity::decodeNorm(ord($this->_norms[$fieldNum]{$id}));
     }
 }
 

demos/quickstart/protected/index/Zend/Search/Lucene/Search/Query/Phrase.php

Doc Comments +1 added lines, -1 removed lines

@@ -258,7 +258,7 @@
      * Score calculator for exact phrase queries (terms sequence is fixed)
      *
      * @param integer $docId
-     * @return float
+     * @return integer
      */
     public function _exactPhraseFreq($docId)
     {

Indentation +374 added lines, -374 removed lines

@@ -40,385 +40,385 @@
  */
 class Zend_Search_Lucene_Search_Query_Phrase extends Zend_Search_Lucene_Search_Query
 {
-    /**
-     * Terms to find.
-     * Array of Zend_Search_Lucene_Index_Term objects.
-     *
-     * @var array
-     */
-    private $_terms;
-
-    /**
-     * Term positions (relative positions of terms within the phrase).
-     * Array of integers
-     *
-     * @var array
-     */
-    private $_offsets;
-
-    /**
-     * Sets the number of other words permitted between words in query phrase.
-     * If zero, then this is an exact phrase search.  For larger values this works
-     * like a WITHIN or NEAR operator.
-     *
-     * The slop is in fact an edit-distance, where the units correspond to
-     * moves of terms in the query phrase out of position.  For example, to switch
-     * the order of two words requires two moves (the first move places the words
-     * atop one another), so to permit re-orderings of phrases, the slop must be
-     * at least two.
-     * More exact matches are scored higher than sloppier matches, thus search
-     * results are sorted by exactness.
-     *
-     * The slop is zero by default, requiring exact matches.
-     *
-     * @var unknown_type
-     */
-    private $_slop;
-
-    /**
-     * Result vector.
-     * Bitset or array of document IDs
-     * (depending from Bitset extension availability).
-     *
-     * @var mixed
-     */
-    private $_resVector = null;
-
-    /**
-     * Terms positions vectors.
-     * Array of Arrays:
-     * term1Id => (docId => array( pos1, pos2, ... ), ...)
-     * term2Id => (docId => array( pos1, pos2, ... ), ...)
-     *
-     * @var array
-     */
-    private $_termsPositions = array();
-
-    /**
-     * Class constructor.  Create a new prase query.
-     *
-     * @param string $field    Field to search.
-     * @param array  $terms    Terms to search Array of strings.
-     * @param array  $offsets  Relative term positions. Array of integers.
-     * @throws Zend_Search_Lucene_Exception
-     */
-    public function __construct($terms = null, $offsets = null, $field = null)
-    {
-        $this->_slop = 0;
-
-        if (is_array($terms)) {
-            $this->_terms = array();
-            foreach ($terms as $termId => $termText) {
-                $this->_terms[$termId] = ($field !== null)? new Zend_Search_Lucene_Index_Term($termText, $field):
-                                                            new Zend_Search_Lucene_Index_Term($termText);
-            }
-        } else if ($terms === null) {
-            $this->_terms = array();
-        } else {
-            throw new Zend_Search_Lucene_Exception('terms argument must be array of strings or null');
-        }
-
-        if (is_array($offsets)) {
-            if (count($this->_terms) != count($offsets)) {
-                throw new Zend_Search_Lucene_Exception('terms and offsets arguments must have the same size.');
-            }
-            $this->_offsets = $offsets;
-        } else if ($offsets === null) {
-            $this->_offsets = array();
-            foreach ($this->_terms as $termId => $term) {
-                $position = count($this->_offsets);
-                $this->_offsets[$termId] = $position;
-            }
-        } else {
-            throw new Zend_Search_Lucene_Exception('offsets argument must be array of strings or null');
-        }
-    }
-
-    /**
-     * Set slop
-     *
-     * @param integer $slop
-     */
-    public function setSlop($slop)
-    {
-        $this->_slop = $slop;
-    }
-
-
-    /**
-     * Get slop
-     *
-     * @return integer
-     */
-    public function getSlop()
-    {
-        return $this->_slop;
-    }
-
-
-    /**
-     * Adds a term to the end of the query phrase.
-     * The relative position of the term is specified explicitly or the one immediately
-     * after the last term added.
-     *
-     * @param Zend_Search_Lucene_Index_Term $term
-     * @param integer $position
-     */
-    public function addTerm(Zend_Search_Lucene_Index_Term $term, $position = null) {
-        if ((count($this->_terms) != 0)&&(end($this->_terms)->field != $term->field)) {
-            throw new Zend_Search_Lucene_Exception('All phrase terms must be in the same field: ' .
-                                                   $term->field . ':' . $term->text);
-        }
-
-        $this->_terms[] = $term;
-        if ($position !== null) {
-            $this->_offsets[] = $position;
-        } else if (count($this->_offsets) != 0) {
-            $this->_offsets[] = end($this->_offsets) + 1;
-        } else {
-            $this->_offsets[] = 0;
-        }
-    }
-
-
-    /**
-     * Returns query term
-     *
-     * @return array
-     */
-    public function getTerms()
-    {
-        return $this->_terms;
-    }
-
-
-    /**
-     * Set weight for specified term
-     *
-     * @param integer $num
-     * @param Zend_Search_Lucene_Search_Weight_Term $weight
-     */
-    public function setWeight($num, $weight)
-    {
-        $this->_weights[$num] = $weight;
-    }
-
-
-    /**
-     * Constructs an appropriate Weight implementation for this query.
-     *
-     * @param Zend_Search_Lucene $reader
-     * @return Zend_Search_Lucene_Search_Weight
-     */
-    protected function _createWeight($reader)
-    {
-        return new Zend_Search_Lucene_Search_Weight_Phrase($this, $reader);
-    }
-
-
-    /**
-     * Calculate result vector
-     *
-     * @param Zend_Search_Lucene $reader
-     */
-    private function _calculateResult($reader)
-    {
-        if (extension_loaded('bitset')) {
-            foreach( $this->_terms as $termId=>$term ) {
-                if($this->_resVector === null) {
-                    $this->_resVector = bitset_from_array($reader->termDocs($term));
-                } else {
-                    $this->_resVector = bitset_intersection(
-                                $this->_resVector,
-                                bitset_from_array($reader->termDocs($term)) );
-                }
-
-                $this->_termsPositions[$termId] = $reader->termPositions($term);
-            }
-        } else {
-            foreach( $this->_terms as $termId=>$term ) {
-                if($this->_resVector === null) {
-                    $this->_resVector = array_flip($reader->termDocs($term));
-                } else {
-                    $termDocs = array_flip($reader->termDocs($term));
-                    foreach($this->_resVector as $key=>$value) {
-                        if (!isset( $termDocs[$key] )) {
-                            unset( $this->_resVector[$key] );
-                        }
-                    }
-                }
-
-                $this->_termsPositions[$termId] = $reader->termPositions($term);
-            }
-        }
-    }
-
-
-    /**
-     * Score calculator for exact phrase queries (terms sequence is fixed)
-     *
-     * @param integer $docId
-     * @return float
-     */
-    public function _exactPhraseFreq($docId)
-    {
-        $freq = 0;
-
-        // Term Id with lowest cardinality
-        $lowCardTermId = null;
-
-        // Calculate $lowCardTermId
-        foreach ($this->_terms as $termId => $term) {
-            if ($lowCardTermId === null ||
-                count($this->_termsPositions[$termId][$docId]) <
-                count($this->_termsPositions[$lowCardTermId][$docId]) ) {
-                    $lowCardTermId = $termId;
-                }
-        }
-
-        // Walk through positions of the term with lowest cardinality
-        foreach ($this->_termsPositions[$lowCardTermId][$docId] as $lowCardPos) {
-            // We expect phrase to be found
-            $freq++;
-
-            // Walk through other terms
-            foreach ($this->_terms as $termId => $term) {
-                if ($termId != $lowCardTermId) {
-                    $expectedPosition = $lowCardPos +
-                                            ($this->_offsets[$termId] -
-                                             $this->_offsets[$lowCardTermId]);
-
-                    if (!in_array($expectedPosition, $this->_termsPositions[$termId][$docId])) {
-                        $freq--;  // Phrase wasn't found.
-                        break;
-                    }
-                }
-            }
-        }
-
-        return $freq;
-    }
-
-    /**
-     * Score calculator for sloppy phrase queries (terms sequence is fixed)
-     *
-     * @param integer $docId
-     * @param Zend_Search_Lucene $reader
-     * @return float
-     */
-    public function _sloppyPhraseFreq($docId, Zend_Search_Lucene $reader)
-    {
-        $freq = 0;
-
-        $phraseQueue = array();
-        $phraseQueue[0] = array(); // empty phrase
-        $lastTerm = null;
-
-        // Walk through the terms to create phrases.
-        foreach ($this->_terms as $termId => $term) {
-            $queueSize = count($phraseQueue);
-            $firstPass = true;
-
-            // Walk through the term positions.
-            // Each term position produces a set of phrases.
-            foreach ($this->_termsPositions[$termId][$docId] as $termPosition ) {
-                if ($firstPass) {
-                    for ($count = 0; $count < $queueSize; $count++) {
-                        $phraseQueue[$count][$termId] = $termPosition;
-                    }
-                } else {
-                    for ($count = 0; $count < $queueSize; $count++) {
-                        if ($lastTerm !== null &&
-                            abs( $termPosition - $phraseQueue[$count][$lastTerm] -
-                                 ($this->_offsets[$termId] - $this->_offsets[$lastTerm])) > $this->_slop) {
-                            continue;
-                        }
-
-                        $newPhraseId = count($phraseQueue);
-                        $phraseQueue[$newPhraseId]          = $phraseQueue[$count];
-                        $phraseQueue[$newPhraseId][$termId] = $termPosition;
-                    }
-
-                }
-
-                $firstPass = false;
-            }
-            $lastTerm = $termId;
-        }
-
-
-        foreach ($phraseQueue as $phrasePos) {
-            $minDistance = null;
-
-            for ($shift = -$this->_slop; $shift <= $this->_slop; $shift++) {
-                $distance = 0;
-                $start = reset($phrasePos) - reset($this->_offsets) + $shift;
-
-                foreach ($this->_terms as $termId => $term) {
-                    $distance += abs($phrasePos[$termId] - $this->_offsets[$termId] - $start);
-
-                    if($distance > $this->_slop) {
-                        break;
-                    }
-                }
-
-                if ($minDistance === null || $distance < $minDistance) {
-                    $minDistance = $distance;
-                }
-            }
-
-            if ($minDistance <= $this->_slop) {
-                $freq += $reader->getSimilarity()->sloppyFreq($minDistance);
-            }
-        }
-
-        return $freq;
-    }
-
-
-    /**
-     * Score specified document
-     *
-     * @param integer $docId
-     * @param Zend_Search_Lucene $reader
-     * @return float
-     */
-    public function score($docId, $reader)
-    {
-        // optimize zero-term case
-        if (count($this->_terms) == 0) {
-            return 0;
-        }
-
-        if($this->_resVector === null) {
-            $this->_calculateResult($reader);
-            $this->_initWeight($reader);
-        }
-
-        if ( (extension_loaded('bitset')) ?
-                bitset_in($this->_resVector, $docId) :
-                isset($this->_resVector[$docId])  ) {
-            if ($this->_slop == 0) {
-                $freq = $this->_exactPhraseFreq($docId);
-            } else {
-                $freq = $this->_sloppyPhraseFreq($docId, $reader);
-            }
+	/**
+	 * Terms to find.
+	 * Array of Zend_Search_Lucene_Index_Term objects.
+	 *
+	 * @var array
+	 */
+	private $_terms;
+
+	/**
+	 * Term positions (relative positions of terms within the phrase).
+	 * Array of integers
+	 *
+	 * @var array
+	 */
+	private $_offsets;
+
+	/**
+	 * Sets the number of other words permitted between words in query phrase.
+	 * If zero, then this is an exact phrase search.  For larger values this works
+	 * like a WITHIN or NEAR operator.
+	 *
+	 * The slop is in fact an edit-distance, where the units correspond to
+	 * moves of terms in the query phrase out of position.  For example, to switch
+	 * the order of two words requires two moves (the first move places the words
+	 * atop one another), so to permit re-orderings of phrases, the slop must be
+	 * at least two.
+	 * More exact matches are scored higher than sloppier matches, thus search
+	 * results are sorted by exactness.
+	 *
+	 * The slop is zero by default, requiring exact matches.
+	 *
+	 * @var unknown_type
+	 */
+	private $_slop;
+
+	/**
+	 * Result vector.
+	 * Bitset or array of document IDs
+	 * (depending from Bitset extension availability).
+	 *
+	 * @var mixed
+	 */
+	private $_resVector = null;
+
+	/**
+	 * Terms positions vectors.
+	 * Array of Arrays:
+	 * term1Id => (docId => array( pos1, pos2, ... ), ...)
+	 * term2Id => (docId => array( pos1, pos2, ... ), ...)
+	 *
+	 * @var array
+	 */
+	private $_termsPositions = array();
+
+	/**
+	 * Class constructor.  Create a new prase query.
+	 *
+	 * @param string $field    Field to search.
+	 * @param array  $terms    Terms to search Array of strings.
+	 * @param array  $offsets  Relative term positions. Array of integers.
+	 * @throws Zend_Search_Lucene_Exception
+	 */
+	public function __construct($terms = null, $offsets = null, $field = null)
+	{
+		$this->_slop = 0;
+
+		if (is_array($terms)) {
+			$this->_terms = array();
+			foreach ($terms as $termId => $termText) {
+				$this->_terms[$termId] = ($field !== null)? new Zend_Search_Lucene_Index_Term($termText, $field):
+															new Zend_Search_Lucene_Index_Term($termText);
+			}
+		} else if ($terms === null) {
+			$this->_terms = array();
+		} else {
+			throw new Zend_Search_Lucene_Exception('terms argument must be array of strings or null');
+		}
+
+		if (is_array($offsets)) {
+			if (count($this->_terms) != count($offsets)) {
+				throw new Zend_Search_Lucene_Exception('terms and offsets arguments must have the same size.');
+			}
+			$this->_offsets = $offsets;
+		} else if ($offsets === null) {
+			$this->_offsets = array();
+			foreach ($this->_terms as $termId => $term) {
+				$position = count($this->_offsets);
+				$this->_offsets[$termId] = $position;
+			}
+		} else {
+			throw new Zend_Search_Lucene_Exception('offsets argument must be array of strings or null');
+		}
+	}
+
+	/**
+	 * Set slop
+	 *
+	 * @param integer $slop
+	 */
+	public function setSlop($slop)
+	{
+		$this->_slop = $slop;
+	}
+
+
+	/**
+	 * Get slop
+	 *
+	 * @return integer
+	 */
+	public function getSlop()
+	{
+		return $this->_slop;
+	}
+
+
+	/**
+	 * Adds a term to the end of the query phrase.
+	 * The relative position of the term is specified explicitly or the one immediately
+	 * after the last term added.
+	 *
+	 * @param Zend_Search_Lucene_Index_Term $term
+	 * @param integer $position
+	 */
+	public function addTerm(Zend_Search_Lucene_Index_Term $term, $position = null) {
+		if ((count($this->_terms) != 0)&&(end($this->_terms)->field != $term->field)) {
+			throw new Zend_Search_Lucene_Exception('All phrase terms must be in the same field: ' .
+												   $term->field . ':' . $term->text);
+		}
+
+		$this->_terms[] = $term;
+		if ($position !== null) {
+			$this->_offsets[] = $position;
+		} else if (count($this->_offsets) != 0) {
+			$this->_offsets[] = end($this->_offsets) + 1;
+		} else {
+			$this->_offsets[] = 0;
+		}
+	}
+
+
+	/**
+	 * Returns query term
+	 *
+	 * @return array
+	 */
+	public function getTerms()
+	{
+		return $this->_terms;
+	}
+
+
+	/**
+	 * Set weight for specified term
+	 *
+	 * @param integer $num
+	 * @param Zend_Search_Lucene_Search_Weight_Term $weight
+	 */
+	public function setWeight($num, $weight)
+	{
+		$this->_weights[$num] = $weight;
+	}
+
+
+	/**
+	 * Constructs an appropriate Weight implementation for this query.
+	 *
+	 * @param Zend_Search_Lucene $reader
+	 * @return Zend_Search_Lucene_Search_Weight
+	 */
+	protected function _createWeight($reader)
+	{
+		return new Zend_Search_Lucene_Search_Weight_Phrase($this, $reader);
+	}
+
+
+	/**
+	 * Calculate result vector
+	 *
+	 * @param Zend_Search_Lucene $reader
+	 */
+	private function _calculateResult($reader)
+	{
+		if (extension_loaded('bitset')) {
+			foreach( $this->_terms as $termId=>$term ) {
+				if($this->_resVector === null) {
+					$this->_resVector = bitset_from_array($reader->termDocs($term));
+				} else {
+					$this->_resVector = bitset_intersection(
+								$this->_resVector,
+								bitset_from_array($reader->termDocs($term)) );
+				}
+
+				$this->_termsPositions[$termId] = $reader->termPositions($term);
+			}
+		} else {
+			foreach( $this->_terms as $termId=>$term ) {
+				if($this->_resVector === null) {
+					$this->_resVector = array_flip($reader->termDocs($term));
+				} else {
+					$termDocs = array_flip($reader->termDocs($term));
+					foreach($this->_resVector as $key=>$value) {
+						if (!isset( $termDocs[$key] )) {
+							unset( $this->_resVector[$key] );
+						}
+					}
+				}
+
+				$this->_termsPositions[$termId] = $reader->termPositions($term);
+			}
+		}
+	}
+
+
+	/**
+	 * Score calculator for exact phrase queries (terms sequence is fixed)
+	 *
+	 * @param integer $docId
+	 * @return float
+	 */
+	public function _exactPhraseFreq($docId)
+	{
+		$freq = 0;
+
+		// Term Id with lowest cardinality
+		$lowCardTermId = null;
+
+		// Calculate $lowCardTermId
+		foreach ($this->_terms as $termId => $term) {
+			if ($lowCardTermId === null ||
+				count($this->_termsPositions[$termId][$docId]) <
+				count($this->_termsPositions[$lowCardTermId][$docId]) ) {
+					$lowCardTermId = $termId;
+				}
+		}
+
+		// Walk through positions of the term with lowest cardinality
+		foreach ($this->_termsPositions[$lowCardTermId][$docId] as $lowCardPos) {
+			// We expect phrase to be found
+			$freq++;
+
+			// Walk through other terms
+			foreach ($this->_terms as $termId => $term) {
+				if ($termId != $lowCardTermId) {
+					$expectedPosition = $lowCardPos +
+											($this->_offsets[$termId] -
+											 $this->_offsets[$lowCardTermId]);
+
+					if (!in_array($expectedPosition, $this->_termsPositions[$termId][$docId])) {
+						$freq--;  // Phrase wasn't found.
+						break;
+					}
+				}
+			}
+		}
+
+		return $freq;
+	}
+
+	/**
+	 * Score calculator for sloppy phrase queries (terms sequence is fixed)
+	 *
+	 * @param integer $docId
+	 * @param Zend_Search_Lucene $reader
+	 * @return float
+	 */
+	public function _sloppyPhraseFreq($docId, Zend_Search_Lucene $reader)
+	{
+		$freq = 0;
+
+		$phraseQueue = array();
+		$phraseQueue[0] = array(); // empty phrase
+		$lastTerm = null;
+
+		// Walk through the terms to create phrases.
+		foreach ($this->_terms as $termId => $term) {
+			$queueSize = count($phraseQueue);
+			$firstPass = true;
+
+			// Walk through the term positions.
+			// Each term position produces a set of phrases.
+			foreach ($this->_termsPositions[$termId][$docId] as $termPosition ) {
+				if ($firstPass) {
+					for ($count = 0; $count < $queueSize; $count++) {
+						$phraseQueue[$count][$termId] = $termPosition;
+					}
+				} else {
+					for ($count = 0; $count < $queueSize; $count++) {
+						if ($lastTerm !== null &&
+							abs( $termPosition - $phraseQueue[$count][$lastTerm] -
+								 ($this->_offsets[$termId] - $this->_offsets[$lastTerm])) > $this->_slop) {
+							continue;
+						}
+
+						$newPhraseId = count($phraseQueue);
+						$phraseQueue[$newPhraseId]          = $phraseQueue[$count];
+						$phraseQueue[$newPhraseId][$termId] = $termPosition;
+					}
+
+				}
+
+				$firstPass = false;
+			}
+			$lastTerm = $termId;
+		}
+
+
+		foreach ($phraseQueue as $phrasePos) {
+			$minDistance = null;
+
+			for ($shift = -$this->_slop; $shift <= $this->_slop; $shift++) {
+				$distance = 0;
+				$start = reset($phrasePos) - reset($this->_offsets) + $shift;
+
+				foreach ($this->_terms as $termId => $term) {
+					$distance += abs($phrasePos[$termId] - $this->_offsets[$termId] - $start);
+
+					if($distance > $this->_slop) {
+						break;
+					}
+				}
+
+				if ($minDistance === null || $distance < $minDistance) {
+					$minDistance = $distance;
+				}
+			}
+
+			if ($minDistance <= $this->_slop) {
+				$freq += $reader->getSimilarity()->sloppyFreq($minDistance);
+			}
+		}
+
+		return $freq;
+	}
+
+
+	/**
+	 * Score specified document
+	 *
+	 * @param integer $docId
+	 * @param Zend_Search_Lucene $reader
+	 * @return float
+	 */
+	public function score($docId, $reader)
+	{
+		// optimize zero-term case
+		if (count($this->_terms) == 0) {
+			return 0;
+		}
+
+		if($this->_resVector === null) {
+			$this->_calculateResult($reader);
+			$this->_initWeight($reader);
+		}
+
+		if ( (extension_loaded('bitset')) ?
+				bitset_in($this->_resVector, $docId) :
+				isset($this->_resVector[$docId])  ) {
+			if ($this->_slop == 0) {
+				$freq = $this->_exactPhraseFreq($docId);
+			} else {
+				$freq = $this->_sloppyPhraseFreq($docId, $reader);
+			}
 
 /*
             return $reader->getSimilarity()->tf($freq) *
                    $this->_weight->getValue() *
                    $reader->norm($docId, reset($this->_terms)->field);
 */
-            if ($freq != 0) {
-                $tf = $reader->getSimilarity()->tf($freq);
-                $weight = $this->_weight->getValue();
-                $norm = $reader->norm($docId, reset($this->_terms)->field);
-
-                return $tf*$weight*$norm;
-            }
-        } else {
-            return 0;
-        }
-    }
+			if ($freq != 0) {
+				$tf = $reader->getSimilarity()->tf($freq);
+				$weight = $this->_weight->getValue();
+				$norm = $reader->norm($docId, reset($this->_terms)->field);
+
+				return $tf*$weight*$norm;
+			}
+		} else {
+			return 0;
+		}
+	}
 }
 

Spacing +18 added lines, -20 removed lines

@@ -109,8 +109,7 @@ 
         if (is_array($terms)) {
             $this->_terms = array();
             foreach ($terms as $termId => $termText) {
-                $this->_terms[$termId] = ($field !== null)? new Zend_Search_Lucene_Index_Term($termText, $field):
-                                                            new Zend_Search_Lucene_Index_Term($termText);
+                $this->_terms[$termId] = ($field !== null) ? new Zend_Search_Lucene_Index_Term($termText, $field) : new Zend_Search_Lucene_Index_Term($termText);
             }
         } else if ($terms === null) {
             $this->_terms = array();
@@ -165,7 +164,7 @@ 
      * @param integer $position
      */
     public function addTerm(Zend_Search_Lucene_Index_Term $term, $position = null) {
-        if ((count($this->_terms) != 0)&&(end($this->_terms)->field != $term->field)) {
+        if ((count($this->_terms) != 0) && (end($this->_terms)->field != $term->field)) {
             throw new Zend_Search_Lucene_Exception('All phrase terms must be in the same field: ' .
                                                    $term->field . ':' . $term->text);
         }
@@ -224,8 +223,8 @@ 
     private function _calculateResult($reader)
     {
         if (extension_loaded('bitset')) {
-            foreach( $this->_terms as $termId=>$term ) {
-                if($this->_resVector === null) {
+            foreach ($this->_terms as $termId=>$term) {
+                if ($this->_resVector === null) {
                     $this->_resVector = bitset_from_array($reader->termDocs($term));
                 } else {
                     $this->_resVector = bitset_intersection(
@@ -236,14 +235,14 @@ 
                 $this->_termsPositions[$termId] = $reader->termPositions($term);
             }
         } else {
-            foreach( $this->_terms as $termId=>$term ) {
-                if($this->_resVector === null) {
+            foreach ($this->_terms as $termId=>$term) {
+                if ($this->_resVector === null) {
                     $this->_resVector = array_flip($reader->termDocs($term));
                 } else {
                     $termDocs = array_flip($reader->termDocs($term));
-                    foreach($this->_resVector as $key=>$value) {
-                        if (!isset( $termDocs[$key] )) {
-                            unset( $this->_resVector[$key] );
+                    foreach ($this->_resVector as $key=>$value) {
+                        if (!isset($termDocs[$key])) {
+                            unset($this->_resVector[$key]);
                         }
                     }
                 }
@@ -271,7 +270,7 @@ 
         foreach ($this->_terms as $termId => $term) {
             if ($lowCardTermId === null ||
                 count($this->_termsPositions[$termId][$docId]) <
-                count($this->_termsPositions[$lowCardTermId][$docId]) ) {
+                count($this->_termsPositions[$lowCardTermId][$docId])) {
                     $lowCardTermId = $termId;
                 }
         }
@@ -289,7 +288,7 @@ 
                                              $this->_offsets[$lowCardTermId]);
 
                     if (!in_array($expectedPosition, $this->_termsPositions[$termId][$docId])) {
-                        $freq--;  // Phrase wasn't found.
+                        $freq--; // Phrase wasn't found.
                         break;
                     }
                 }
@@ -321,7 +320,7 @@ 
 
             // Walk through the term positions.
             // Each term position produces a set of phrases.
-            foreach ($this->_termsPositions[$termId][$docId] as $termPosition ) {
+            foreach ($this->_termsPositions[$termId][$docId] as $termPosition) {
                 if ($firstPass) {
                     for ($count = 0; $count < $queueSize; $count++) {
                         $phraseQueue[$count][$termId] = $termPosition;
@@ -329,7 +328,7 @@ 
                 } else {
                     for ($count = 0; $count < $queueSize; $count++) {
                         if ($lastTerm !== null &&
-                            abs( $termPosition - $phraseQueue[$count][$lastTerm] -
+                            abs($termPosition - $phraseQueue[$count][$lastTerm] -
                                  ($this->_offsets[$termId] - $this->_offsets[$lastTerm])) > $this->_slop) {
                             continue;
                         }
@@ -357,7 +356,7 @@ 
                 foreach ($this->_terms as $termId => $term) {
                     $distance += abs($phrasePos[$termId] - $this->_offsets[$termId] - $start);
 
-                    if($distance > $this->_slop) {
+                    if ($distance > $this->_slop) {
                         break;
                     }
                 }
@@ -390,14 +389,13 @@ 
             return 0;
         }
 
-        if($this->_resVector === null) {
+        if ($this->_resVector === null) {
             $this->_calculateResult($reader);
             $this->_initWeight($reader);
         }
 
-        if ( (extension_loaded('bitset')) ?
-                bitset_in($this->_resVector, $docId) :
-                isset($this->_resVector[$docId])  ) {
+        if ((extension_loaded('bitset')) ?
+                bitset_in($this->_resVector, $docId) : isset($this->_resVector[$docId])) {
             if ($this->_slop == 0) {
                 $freq = $this->_exactPhraseFreq($docId);
             } else {
@@ -414,7 +412,7 @@ 
                 $weight = $this->_weight->getValue();
                 $norm = $reader->norm($docId, reset($this->_terms)->field);
 
-                return $tf*$weight*$norm;
+                return $tf * $weight * $norm;
             }
         } else {
             return 0;

demos/quickstart/protected/index/Zend/Search/Lucene/Search/Similarity.php

Doc Comments +3 added lines, -3 removed lines

@@ -407,8 +407,8 @@ 
     /**
      * Float to byte conversion
      *
-     * @param integer $b
-     * @return float
+     * @param double $f
+     * @return integer
      */
     static private function _floatToByte($f)
     {
@@ -494,7 +494,7 @@ 
      *
      * @param mixed $input
      * @param Zend_Search_Lucene $reader
-     * @return a score factor for the term
+     * @return double score factor for the term
      */
     public function idf($input, $reader)
     {

Indentation +492 added lines, -492 removed lines

@@ -31,521 +31,521 @@
  */
 abstract class Zend_Search_Lucene_Search_Similarity
 {
-    /**
-     * The Similarity implementation used by default.
-     *
-     * @var Zend_Search_Lucene_Search_Similarity
-     */
-    static private $_defaultImpl;
+	/**
+	 * The Similarity implementation used by default.
+	 *
+	 * @var Zend_Search_Lucene_Search_Similarity
+	 */
+	static private $_defaultImpl;
 
-    /**
-     * Cache of decoded bytes.
-     * Array of floats
-     *
-     * @var array
-     */
-    static private $_normTable = array( 0   => 0.0,
-                                        1   => 5.820766E-10,
-                                        2   => 6.9849193E-10,
-                                        3   => 8.1490725E-10,
-                                        4   => 9.313226E-10,
-                                        5   => 1.1641532E-9,
-                                        6   => 1.3969839E-9,
-                                        7   => 1.6298145E-9,
-                                        8   => 1.8626451E-9,
-                                        9   => 2.3283064E-9,
-                                        10  => 2.7939677E-9,
-                                        11  => 3.259629E-9,
-                                        12  => 3.7252903E-9,
-                                        13  => 4.656613E-9,
-                                        14  => 5.5879354E-9,
-                                        15  => 6.519258E-9,
-                                        16  => 7.4505806E-9,
-                                        17  => 9.313226E-9,
-                                        18  => 1.1175871E-8,
-                                        19  => 1.3038516E-8,
-                                        20  => 1.4901161E-8,
-                                        21  => 1.8626451E-8,
-                                        22  => 2.2351742E-8,
-                                        23  => 2.6077032E-8,
-                                        24  => 2.9802322E-8,
-                                        25  => 3.7252903E-8,
-                                        26  => 4.4703484E-8,
-                                        27  => 5.2154064E-8,
-                                        28  => 5.9604645E-8,
-                                        29  => 7.4505806E-8,
-                                        30  => 8.940697E-8,
-                                        31  => 1.0430813E-7,
-                                        32  => 1.1920929E-7,
-                                        33  => 1.4901161E-7,
-                                        34  => 1.7881393E-7,
-                                        35  => 2.0861626E-7,
-                                        36  => 2.3841858E-7,
-                                        37  => 2.9802322E-7,
-                                        38  => 3.5762787E-7,
-                                        39  => 4.172325E-7,
-                                        40  => 4.7683716E-7,
-                                        41  => 5.9604645E-7,
-                                        42  => 7.1525574E-7,
-                                        43  => 8.34465E-7,
-                                        44  => 9.536743E-7,
-                                        45  => 1.1920929E-6,
-                                        46  => 1.4305115E-6,
-                                        47  => 1.66893E-6,
-                                        48  => 1.9073486E-6,
-                                        49  => 2.3841858E-6,
-                                        50  => 2.861023E-6,
-                                        51  => 3.33786E-6,
-                                        52  => 3.8146973E-6,
-                                        53  => 4.7683716E-6,
-                                        54  => 5.722046E-6,
-                                        55  => 6.67572E-6,
-                                        56  => 7.6293945E-6,
-                                        57  => 9.536743E-6,
-                                        58  => 1.1444092E-5,
-                                        59  => 1.335144E-5,
-                                        60  => 1.5258789E-5,
-                                        61  => 1.9073486E-5,
-                                        62  => 2.2888184E-5,
-                                        63  => 2.670288E-5,
-                                        64  => 3.0517578E-5,
-                                        65  => 3.8146973E-5,
-                                        66  => 4.5776367E-5,
-                                        67  => 5.340576E-5,
-                                        68  => 6.1035156E-5,
-                                        69  => 7.6293945E-5,
-                                        70  => 9.1552734E-5,
-                                        71  => 1.0681152E-4,
-                                        72  => 1.2207031E-4,
-                                        73  => 1.5258789E-4,
-                                        74  => 1.8310547E-4,
-                                        75  => 2.1362305E-4,
-                                        76  => 2.4414062E-4,
-                                        77  => 3.0517578E-4,
-                                        78  => 3.6621094E-4,
-                                        79  => 4.272461E-4,
-                                        80  => 4.8828125E-4,
-                                        81  => 6.1035156E-4,
-                                        82  => 7.324219E-4,
-                                        83  => 8.544922E-4,
-                                        84  => 9.765625E-4,
-                                        85  => 0.0012207031,
-                                        86  => 0.0014648438,
-                                        87  => 0.0017089844,
-                                        88  => 0.001953125,
-                                        89  => 0.0024414062,
-                                        90  => 0.0029296875,
-                                        91  => 0.0034179688,
-                                        92  => 0.00390625,
-                                        93  => 0.0048828125,
-                                        94  => 0.005859375,
-                                        95  => 0.0068359375,
-                                        96  => 0.0078125,
-                                        97  => 0.009765625,
-                                        98  => 0.01171875,
-                                        99  => 0.013671875,
-                                        100 => 0.015625,
-                                        101 => 0.01953125,
-                                        102 => 0.0234375,
-                                        103 => 0.02734375,
-                                        104 => 0.03125,
-                                        105 => 0.0390625,
-                                        106 => 0.046875,
-                                        107 => 0.0546875,
-                                        108 => 0.0625,
-                                        109 => 0.078125,
-                                        110 => 0.09375,
-                                        111 => 0.109375,
-                                        112 => 0.125,
-                                        113 => 0.15625,
-                                        114 => 0.1875,
-                                        115 => 0.21875,
-                                        116 => 0.25,
-                                        117 => 0.3125,
-                                        118 => 0.375,
-                                        119 => 0.4375,
-                                        120 => 0.5,
-                                        121 => 0.625,
-                                        122 => 0.75,
-                                        123 => 0.875,
-                                        124 => 1.0,
-                                        125 => 1.25,
-                                        126 => 1.5,
-                                        127 => 1.75,
-                                        128 => 2.0,
-                                        129 => 2.5,
-                                        130 => 3.0,
-                                        131 => 3.5,
-                                        132 => 4.0,
-                                        133 => 5.0,
-                                        134 => 6.0,
-                                        135 => 7.0,
-                                        136 => 8.0,
-                                        137 => 10.0,
-                                        138 => 12.0,
-                                        139 => 14.0,
-                                        140 => 16.0,
-                                        141 => 20.0,
-                                        142 => 24.0,
-                                        143 => 28.0,
-                                        144 => 32.0,
-                                        145 => 40.0,
-                                        146 => 48.0,
-                                        147 => 56.0,
-                                        148 => 64.0,
-                                        149 => 80.0,
-                                        150 => 96.0,
-                                        151 => 112.0,
-                                        152 => 128.0,
-                                        153 => 160.0,
-                                        154 => 192.0,
-                                        155 => 224.0,
-                                        156 => 256.0,
-                                        157 => 320.0,
-                                        158 => 384.0,
-                                        159 => 448.0,
-                                        160 => 512.0,
-                                        161 => 640.0,
-                                        162 => 768.0,
-                                        163 => 896.0,
-                                        164 => 1024.0,
-                                        165 => 1280.0,
-                                        166 => 1536.0,
-                                        167 => 1792.0,
-                                        168 => 2048.0,
-                                        169 => 2560.0,
-                                        170 => 3072.0,
-                                        171 => 3584.0,
-                                        172 => 4096.0,
-                                        173 => 5120.0,
-                                        174 => 6144.0,
-                                        175 => 7168.0,
-                                        176 => 8192.0,
-                                        177 => 10240.0,
-                                        178 => 12288.0,
-                                        179 => 14336.0,
-                                        180 => 16384.0,
-                                        181 => 20480.0,
-                                        182 => 24576.0,
-                                        183 => 28672.0,
-                                        184 => 32768.0,
-                                        185 => 40960.0,
-                                        186 => 49152.0,
-                                        187 => 57344.0,
-                                        188 => 65536.0,
-                                        189 => 81920.0,
-                                        190 => 98304.0,
-                                        191 => 114688.0,
-                                        192 => 131072.0,
-                                        193 => 163840.0,
-                                        194 => 196608.0,
-                                        195 => 229376.0,
-                                        196 => 262144.0,
-                                        197 => 327680.0,
-                                        198 => 393216.0,
-                                        199 => 458752.0,
-                                        200 => 524288.0,
-                                        201 => 655360.0,
-                                        202 => 786432.0,
-                                        203 => 917504.0,
-                                        204 => 1048576.0,
-                                        205 => 1310720.0,
-                                        206 => 1572864.0,
-                                        207 => 1835008.0,
-                                        208 => 2097152.0,
-                                        209 => 2621440.0,
-                                        210 => 3145728.0,
-                                        211 => 3670016.0,
-                                        212 => 4194304.0,
-                                        213 => 5242880.0,
-                                        214 => 6291456.0,
-                                        215 => 7340032.0,
-                                        216 => 8388608.0,
-                                        217 => 1.048576E7,
-                                        218 => 1.2582912E7,
-                                        219 => 1.4680064E7,
-                                        220 => 1.6777216E7,
-                                        221 => 2.097152E7,
-                                        222 => 2.5165824E7,
-                                        223 => 2.9360128E7,
-                                        224 => 3.3554432E7,
-                                        225 => 4.194304E7,
-                                        226 => 5.0331648E7,
-                                        227 => 5.8720256E7,
-                                        228 => 6.7108864E7,
-                                        229 => 8.388608E7,
-                                        230 => 1.00663296E8,
-                                        231 => 1.17440512E8,
-                                        232 => 1.34217728E8,
-                                        233 => 1.6777216E8,
-                                        234 => 2.01326592E8,
-                                        235 => 2.34881024E8,
-                                        236 => 2.68435456E8,
-                                        237 => 3.3554432E8,
-                                        238 => 4.02653184E8,
-                                        239 => 4.69762048E8,
-                                        240 => 5.3687091E8,
-                                        241 => 6.7108864E8,
-                                        242 => 8.0530637E8,
-                                        243 => 9.395241E8,
-                                        244 => 1.07374182E9,
-                                        245 => 1.34217728E9,
-                                        246 => 1.61061274E9,
-                                        247 => 1.87904819E9,
-                                        248 => 2.14748365E9,
-                                        249 => 2.68435456E9,
-                                        250 => 3.22122547E9,
-                                        251 => 3.75809638E9,
-                                        252 => 4.2949673E9,
-                                        253 => 5.3687091E9,
-                                        254 => 6.4424509E9,
-                                        255 => 7.5161928E9 );
+	/**
+	 * Cache of decoded bytes.
+	 * Array of floats
+	 *
+	 * @var array
+	 */
+	static private $_normTable = array( 0   => 0.0,
+										1   => 5.820766E-10,
+										2   => 6.9849193E-10,
+										3   => 8.1490725E-10,
+										4   => 9.313226E-10,
+										5   => 1.1641532E-9,
+										6   => 1.3969839E-9,
+										7   => 1.6298145E-9,
+										8   => 1.8626451E-9,
+										9   => 2.3283064E-9,
+										10  => 2.7939677E-9,
+										11  => 3.259629E-9,
+										12  => 3.7252903E-9,
+										13  => 4.656613E-9,
+										14  => 5.5879354E-9,
+										15  => 6.519258E-9,
+										16  => 7.4505806E-9,
+										17  => 9.313226E-9,
+										18  => 1.1175871E-8,
+										19  => 1.3038516E-8,
+										20  => 1.4901161E-8,
+										21  => 1.8626451E-8,
+										22  => 2.2351742E-8,
+										23  => 2.6077032E-8,
+										24  => 2.9802322E-8,
+										25  => 3.7252903E-8,
+										26  => 4.4703484E-8,
+										27  => 5.2154064E-8,
+										28  => 5.9604645E-8,
+										29  => 7.4505806E-8,
+										30  => 8.940697E-8,
+										31  => 1.0430813E-7,
+										32  => 1.1920929E-7,
+										33  => 1.4901161E-7,
+										34  => 1.7881393E-7,
+										35  => 2.0861626E-7,
+										36  => 2.3841858E-7,
+										37  => 2.9802322E-7,
+										38  => 3.5762787E-7,
+										39  => 4.172325E-7,
+										40  => 4.7683716E-7,
+										41  => 5.9604645E-7,
+										42  => 7.1525574E-7,
+										43  => 8.34465E-7,
+										44  => 9.536743E-7,
+										45  => 1.1920929E-6,
+										46  => 1.4305115E-6,
+										47  => 1.66893E-6,
+										48  => 1.9073486E-6,
+										49  => 2.3841858E-6,
+										50  => 2.861023E-6,
+										51  => 3.33786E-6,
+										52  => 3.8146973E-6,
+										53  => 4.7683716E-6,
+										54  => 5.722046E-6,
+										55  => 6.67572E-6,
+										56  => 7.6293945E-6,
+										57  => 9.536743E-6,
+										58  => 1.1444092E-5,
+										59  => 1.335144E-5,
+										60  => 1.5258789E-5,
+										61  => 1.9073486E-5,
+										62  => 2.2888184E-5,
+										63  => 2.670288E-5,
+										64  => 3.0517578E-5,
+										65  => 3.8146973E-5,
+										66  => 4.5776367E-5,
+										67  => 5.340576E-5,
+										68  => 6.1035156E-5,
+										69  => 7.6293945E-5,
+										70  => 9.1552734E-5,
+										71  => 1.0681152E-4,
+										72  => 1.2207031E-4,
+										73  => 1.5258789E-4,
+										74  => 1.8310547E-4,
+										75  => 2.1362305E-4,
+										76  => 2.4414062E-4,
+										77  => 3.0517578E-4,
+										78  => 3.6621094E-4,
+										79  => 4.272461E-4,
+										80  => 4.8828125E-4,
+										81  => 6.1035156E-4,
+										82  => 7.324219E-4,
+										83  => 8.544922E-4,
+										84  => 9.765625E-4,
+										85  => 0.0012207031,
+										86  => 0.0014648438,
+										87  => 0.0017089844,
+										88  => 0.001953125,
+										89  => 0.0024414062,
+										90  => 0.0029296875,
+										91  => 0.0034179688,
+										92  => 0.00390625,
+										93  => 0.0048828125,
+										94  => 0.005859375,
+										95  => 0.0068359375,
+										96  => 0.0078125,
+										97  => 0.009765625,
+										98  => 0.01171875,
+										99  => 0.013671875,
+										100 => 0.015625,
+										101 => 0.01953125,
+										102 => 0.0234375,
+										103 => 0.02734375,
+										104 => 0.03125,
+										105 => 0.0390625,
+										106 => 0.046875,
+										107 => 0.0546875,
+										108 => 0.0625,
+										109 => 0.078125,
+										110 => 0.09375,
+										111 => 0.109375,
+										112 => 0.125,
+										113 => 0.15625,
+										114 => 0.1875,
+										115 => 0.21875,
+										116 => 0.25,
+										117 => 0.3125,
+										118 => 0.375,
+										119 => 0.4375,
+										120 => 0.5,
+										121 => 0.625,
+										122 => 0.75,
+										123 => 0.875,
+										124 => 1.0,
+										125 => 1.25,
+										126 => 1.5,
+										127 => 1.75,
+										128 => 2.0,
+										129 => 2.5,
+										130 => 3.0,
+										131 => 3.5,
+										132 => 4.0,
+										133 => 5.0,
+										134 => 6.0,
+										135 => 7.0,
+										136 => 8.0,
+										137 => 10.0,
+										138 => 12.0,
+										139 => 14.0,
+										140 => 16.0,
+										141 => 20.0,
+										142 => 24.0,
+										143 => 28.0,
+										144 => 32.0,
+										145 => 40.0,
+										146 => 48.0,
+										147 => 56.0,
+										148 => 64.0,
+										149 => 80.0,
+										150 => 96.0,
+										151 => 112.0,
+										152 => 128.0,
+										153 => 160.0,
+										154 => 192.0,
+										155 => 224.0,
+										156 => 256.0,
+										157 => 320.0,
+										158 => 384.0,
+										159 => 448.0,
+										160 => 512.0,
+										161 => 640.0,
+										162 => 768.0,
+										163 => 896.0,
+										164 => 1024.0,
+										165 => 1280.0,
+										166 => 1536.0,
+										167 => 1792.0,
+										168 => 2048.0,
+										169 => 2560.0,
+										170 => 3072.0,
+										171 => 3584.0,
+										172 => 4096.0,
+										173 => 5120.0,
+										174 => 6144.0,
+										175 => 7168.0,
+										176 => 8192.0,
+										177 => 10240.0,
+										178 => 12288.0,
+										179 => 14336.0,
+										180 => 16384.0,
+										181 => 20480.0,
+										182 => 24576.0,
+										183 => 28672.0,
+										184 => 32768.0,
+										185 => 40960.0,
+										186 => 49152.0,
+										187 => 57344.0,
+										188 => 65536.0,
+										189 => 81920.0,
+										190 => 98304.0,
+										191 => 114688.0,
+										192 => 131072.0,
+										193 => 163840.0,
+										194 => 196608.0,
+										195 => 229376.0,
+										196 => 262144.0,
+										197 => 327680.0,
+										198 => 393216.0,
+										199 => 458752.0,
+										200 => 524288.0,
+										201 => 655360.0,
+										202 => 786432.0,
+										203 => 917504.0,
+										204 => 1048576.0,
+										205 => 1310720.0,
+										206 => 1572864.0,
+										207 => 1835008.0,
+										208 => 2097152.0,
+										209 => 2621440.0,
+										210 => 3145728.0,
+										211 => 3670016.0,
+										212 => 4194304.0,
+										213 => 5242880.0,
+										214 => 6291456.0,
+										215 => 7340032.0,
+										216 => 8388608.0,
+										217 => 1.048576E7,
+										218 => 1.2582912E7,
+										219 => 1.4680064E7,
+										220 => 1.6777216E7,
+										221 => 2.097152E7,
+										222 => 2.5165824E7,
+										223 => 2.9360128E7,
+										224 => 3.3554432E7,
+										225 => 4.194304E7,
+										226 => 5.0331648E7,
+										227 => 5.8720256E7,
+										228 => 6.7108864E7,
+										229 => 8.388608E7,
+										230 => 1.00663296E8,
+										231 => 1.17440512E8,
+										232 => 1.34217728E8,
+										233 => 1.6777216E8,
+										234 => 2.01326592E8,
+										235 => 2.34881024E8,
+										236 => 2.68435456E8,
+										237 => 3.3554432E8,
+										238 => 4.02653184E8,
+										239 => 4.69762048E8,
+										240 => 5.3687091E8,
+										241 => 6.7108864E8,
+										242 => 8.0530637E8,
+										243 => 9.395241E8,
+										244 => 1.07374182E9,
+										245 => 1.34217728E9,
+										246 => 1.61061274E9,
+										247 => 1.87904819E9,
+										248 => 2.14748365E9,
+										249 => 2.68435456E9,
+										250 => 3.22122547E9,
+										251 => 3.75809638E9,
+										252 => 4.2949673E9,
+										253 => 5.3687091E9,
+										254 => 6.4424509E9,
+										255 => 7.5161928E9 );
 
 
-    /**
-     * Set the default Similarity implementation used by indexing and search
-     * code.
-     *
-     * @param Zend_Search_Lucene_Search_Similarity $similarity
-     */
-    static public function setDefault(Zend_Search_Lucene_Search_Similarity $similarity)
-    {
-        self::$_defaultImpl = $similarity;
-    }
+	/**
+	 * Set the default Similarity implementation used by indexing and search
+	 * code.
+	 *
+	 * @param Zend_Search_Lucene_Search_Similarity $similarity
+	 */
+	static public function setDefault(Zend_Search_Lucene_Search_Similarity $similarity)
+	{
+		self::$_defaultImpl = $similarity;
+	}
 
 
-    /**
-     * Return the default Similarity implementation used by indexing and search
-     * code.
-     *
-     * @return Zend_Search_Lucene_Search_Similarity
-     */
-    static public function getDefault()
-    {
-        if (!self::$_defaultImpl instanceof Zend_Search_Lucene_Search_Similarity) {
-            self::$_defaultImpl = new Zend_Search_Lucene_Search_Similarity_Default();
-        }
+	/**
+	 * Return the default Similarity implementation used by indexing and search
+	 * code.
+	 *
+	 * @return Zend_Search_Lucene_Search_Similarity
+	 */
+	static public function getDefault()
+	{
+		if (!self::$_defaultImpl instanceof Zend_Search_Lucene_Search_Similarity) {
+			self::$_defaultImpl = new Zend_Search_Lucene_Search_Similarity_Default();
+		}
 
-        return self::$_defaultImpl;
-    }
+		return self::$_defaultImpl;
+	}
 
 
-    /**
-     * Computes the normalization value for a field given the total number of
-     * terms contained in a field.  These values, together with field boosts, are
-     * stored in an index and multipled into scores for hits on each field by the
-     * search code.
-     *
-     * Matches in longer fields are less precise, so implemenations of this
-     * method usually return smaller values when 'numTokens' is large,
-     * and larger values when 'numTokens' is small.
-     *
-     * That these values are computed under
-     * IndexWriter::addDocument(Document) and stored then using
-     * encodeNorm(float).  Thus they have limited precision, and documents
-     * must be re-indexed if this method is altered.
-     *
-     * fieldName - name of field
-     * numTokens - the total number of tokens contained in fields named
-     *             'fieldName' of 'doc'.
-     * Returns a normalization factor for hits on this field of this document
-     *
-     * @param string $fieldName
-     * @param integer $numTokens
-     * @return float
-     */
-    abstract public function lengthNorm($fieldName, $numTokens);
+	/**
+	 * Computes the normalization value for a field given the total number of
+	 * terms contained in a field.  These values, together with field boosts, are
+	 * stored in an index and multipled into scores for hits on each field by the
+	 * search code.
+	 *
+	 * Matches in longer fields are less precise, so implemenations of this
+	 * method usually return smaller values when 'numTokens' is large,
+	 * and larger values when 'numTokens' is small.
+	 *
+	 * That these values are computed under
+	 * IndexWriter::addDocument(Document) and stored then using
+	 * encodeNorm(float).  Thus they have limited precision, and documents
+	 * must be re-indexed if this method is altered.
+	 *
+	 * fieldName - name of field
+	 * numTokens - the total number of tokens contained in fields named
+	 *             'fieldName' of 'doc'.
+	 * Returns a normalization factor for hits on this field of this document
+	 *
+	 * @param string $fieldName
+	 * @param integer $numTokens
+	 * @return float
+	 */
+	abstract public function lengthNorm($fieldName, $numTokens);
 
-    /**
-     * Computes the normalization value for a query given the sum of the squared
-     * weights of each of the query terms.  This value is then multipled into the
-     * weight of each query term.
-     *
-     * This does not affect ranking, but rather just attempts to make scores
-     * from different queries comparable.
-     *
-     * sumOfSquaredWeights - the sum of the squares of query term weights
-     * Returns a normalization factor for query weights
-     *
-     * @param float $sumOfSquaredWeights
-     * @return float
-     */
-    abstract public function queryNorm($sumOfSquaredWeights);
+	/**
+	 * Computes the normalization value for a query given the sum of the squared
+	 * weights of each of the query terms.  This value is then multipled into the
+	 * weight of each query term.
+	 *
+	 * This does not affect ranking, but rather just attempts to make scores
+	 * from different queries comparable.
+	 *
+	 * sumOfSquaredWeights - the sum of the squares of query term weights
+	 * Returns a normalization factor for query weights
+	 *
+	 * @param float $sumOfSquaredWeights
+	 * @return float
+	 */
+	abstract public function queryNorm($sumOfSquaredWeights);
 
 
-    /**
-     *  Decodes a normalization factor stored in an index.
-     *
-     * @param integer $byte
-     * @return float
-     */
-    static public function decodeNorm($byte)
-    {
-        return self::$_normTable[$byte & 0xFF];
-    }
+	/**
+	 *  Decodes a normalization factor stored in an index.
+	 *
+	 * @param integer $byte
+	 * @return float
+	 */
+	static public function decodeNorm($byte)
+	{
+		return self::$_normTable[$byte & 0xFF];
+	}
 
 
-    /**
-     * Encodes a normalization factor for storage in an index.
-     *
-     * The encoding uses a five-bit exponent and three-bit mantissa, thus
-     * representing values from around 7x10^9 to 2x10^-9 with about one
-     * significant decimal digit of accuracy.  Zero is also represented.
-     * Negative numbers are rounded up to zero.  Values too large to represent
-     * are rounded down to the largest representable value.  Positive values too
-     * small to represent are rounded up to the smallest positive representable
-     * value.
-     *
-     * @param float $f
-     * @return integer
-     */
-    static function encodeNorm($f)
-    {
-      return self::_floatToByte($f);
-    }
+	/**
+	 * Encodes a normalization factor for storage in an index.
+	 *
+	 * The encoding uses a five-bit exponent and three-bit mantissa, thus
+	 * representing values from around 7x10^9 to 2x10^-9 with about one
+	 * significant decimal digit of accuracy.  Zero is also represented.
+	 * Negative numbers are rounded up to zero.  Values too large to represent
+	 * are rounded down to the largest representable value.  Positive values too
+	 * small to represent are rounded up to the smallest positive representable
+	 * value.
+	 *
+	 * @param float $f
+	 * @return integer
+	 */
+	static function encodeNorm($f)
+	{
+	  return self::_floatToByte($f);
+	}
 
-    /**
-     * Float to byte conversion
-     *
-     * @param integer $b
-     * @return float
-     */
-    static private function _floatToByte($f)
-    {
-        // round negatives up to zero
-        if ($f <= 0.0) {
-            return 0;
-        }
+	/**
+	 * Float to byte conversion
+	 *
+	 * @param integer $b
+	 * @return float
+	 */
+	static private function _floatToByte($f)
+	{
+		// round negatives up to zero
+		if ($f <= 0.0) {
+			return 0;
+		}
 
-        // search for appropriate value
-        $lowIndex = 0;
-        $highIndex = 255;
-        while ($highIndex >= $lowIndex) {
-            // $mid = ($highIndex - $lowIndex)/2;
-            $mid = ($highIndex + $lowIndex) >> 1;
-            $delta = $f - self::$_normTable[$mid];
+		// search for appropriate value
+		$lowIndex = 0;
+		$highIndex = 255;
+		while ($highIndex >= $lowIndex) {
+			// $mid = ($highIndex - $lowIndex)/2;
+			$mid = ($highIndex + $lowIndex) >> 1;
+			$delta = $f - self::$_normTable[$mid];
 
-            if ($delta < 0) {
-                $highIndex = $mid-1;
-            } elseif ($delta > 0) {
-                $lowIndex  = $mid+1;
-            } else {
-                return $mid; // We got it!
-            }
-        }
+			if ($delta < 0) {
+				$highIndex = $mid-1;
+			} elseif ($delta > 0) {
+				$lowIndex  = $mid+1;
+			} else {
+				return $mid; // We got it!
+			}
+		}
 
-        // round to closest value
-        if ($highIndex != 255 &&
-            $f - self::$_normTable[$highIndex] > self::$_normTable[$highIndex+1] - $f ) {
-            return $highIndex + 1;
-        } else {
-            return $highIndex;
-        }
-    }
+		// round to closest value
+		if ($highIndex != 255 &&
+			$f - self::$_normTable[$highIndex] > self::$_normTable[$highIndex+1] - $f ) {
+			return $highIndex + 1;
+		} else {
+			return $highIndex;
+		}
+	}
 
 
-    /**
-     * Computes a score factor based on a term or phrase's frequency in a
-     * document.  This value is multiplied by the idf(Term, Searcher)
-     * factor for each term in the query and these products are then summed to
-     * form the initial score for a document.
-     *
-     * Terms and phrases repeated in a document indicate the topic of the
-     * document, so implementations of this method usually return larger values
-     * when 'freq' is large, and smaller values when 'freq'
-     * is small.
-     *
-     * freq - the frequency of a term within a document
-     * Returns a score factor based on a term's within-document frequency
-     *
-     * @param float $freq
-     * @return float
-     */
-    abstract public function tf($freq);
+	/**
+	 * Computes a score factor based on a term or phrase's frequency in a
+	 * document.  This value is multiplied by the idf(Term, Searcher)
+	 * factor for each term in the query and these products are then summed to
+	 * form the initial score for a document.
+	 *
+	 * Terms and phrases repeated in a document indicate the topic of the
+	 * document, so implementations of this method usually return larger values
+	 * when 'freq' is large, and smaller values when 'freq'
+	 * is small.
+	 *
+	 * freq - the frequency of a term within a document
+	 * Returns a score factor based on a term's within-document frequency
+	 *
+	 * @param float $freq
+	 * @return float
+	 */
+	abstract public function tf($freq);
 
-    /**
-     * Computes the amount of a sloppy phrase match, based on an edit distance.
-     * This value is summed for each sloppy phrase match in a document to form
-     * the frequency that is passed to tf(float).
-     *
-     * A phrase match with a small edit distance to a document passage more
-     * closely matches the document, so implementations of this method usually
-     * return larger values when the edit distance is small and smaller values
-     * when it is large.
-     *
-     * distance - the edit distance of this sloppy phrase match
-     * Returns the frequency increment for this match
-     *
-     * @param integer $distance
-     * @return float
-     */
-    abstract public function sloppyFreq($distance);
+	/**
+	 * Computes the amount of a sloppy phrase match, based on an edit distance.
+	 * This value is summed for each sloppy phrase match in a document to form
+	 * the frequency that is passed to tf(float).
+	 *
+	 * A phrase match with a small edit distance to a document passage more
+	 * closely matches the document, so implementations of this method usually
+	 * return larger values when the edit distance is small and smaller values
+	 * when it is large.
+	 *
+	 * distance - the edit distance of this sloppy phrase match
+	 * Returns the frequency increment for this match
+	 *
+	 * @param integer $distance
+	 * @return float
+	 */
+	abstract public function sloppyFreq($distance);
 
 
-    /**
-     * Computes a score factor for a simple term or a phrase.
-     *
-     * The default implementation is:
-     *   return idfFreq(searcher.docFreq(term), searcher.maxDoc());
-     *
-     * input - the term in question or array of terms
-     * reader - reader the document collection being searched
-     * Returns a score factor for the term
-     *
-     * @param mixed $input
-     * @param Zend_Search_Lucene $reader
-     * @return a score factor for the term
-     */
-    public function idf($input, $reader)
-    {
-        if (!is_array($input)) {
-            return $this->idfFreq($reader->docFreq($input), $reader->count());
-        } else {
-            $idf = 0.0;
-            foreach ($input as $term) {
-                $idf += $this->idfFreq($reader->docFreq($term), $reader->count());
-            }
-            return $idf;
-        }
-    }
+	/**
+	 * Computes a score factor for a simple term or a phrase.
+	 *
+	 * The default implementation is:
+	 *   return idfFreq(searcher.docFreq(term), searcher.maxDoc());
+	 *
+	 * input - the term in question or array of terms
+	 * reader - reader the document collection being searched
+	 * Returns a score factor for the term
+	 *
+	 * @param mixed $input
+	 * @param Zend_Search_Lucene $reader
+	 * @return a score factor for the term
+	 */
+	public function idf($input, $reader)
+	{
+		if (!is_array($input)) {
+			return $this->idfFreq($reader->docFreq($input), $reader->count());
+		} else {
+			$idf = 0.0;
+			foreach ($input as $term) {
+				$idf += $this->idfFreq($reader->docFreq($term), $reader->count());
+			}
+			return $idf;
+		}
+	}
 
-    /**
-     * Computes a score factor based on a term's document frequency (the number
-     * of documents which contain the term).  This value is multiplied by the
-     * tf(int) factor for each term in the query and these products are
-     * then summed to form the initial score for a document.
-     *
-     * Terms that occur in fewer documents are better indicators of topic, so
-     * implemenations of this method usually return larger values for rare terms,
-     * and smaller values for common terms.
-     *
-     * docFreq - the number of documents which contain the term
-     * numDocs - the total number of documents in the collection
-     * Returns a score factor based on the term's document frequency
-     *
-     * @param integer $docFreq
-     * @param integer $numDocs
-     * @return float
-     */
-    abstract public function idfFreq($docFreq, $numDocs);
+	/**
+	 * Computes a score factor based on a term's document frequency (the number
+	 * of documents which contain the term).  This value is multiplied by the
+	 * tf(int) factor for each term in the query and these products are
+	 * then summed to form the initial score for a document.
+	 *
+	 * Terms that occur in fewer documents are better indicators of topic, so
+	 * implemenations of this method usually return larger values for rare terms,
+	 * and smaller values for common terms.
+	 *
+	 * docFreq - the number of documents which contain the term
+	 * numDocs - the total number of documents in the collection
+	 * Returns a score factor based on the term's document frequency
+	 *
+	 * @param integer $docFreq
+	 * @param integer $numDocs
+	 * @return float
+	 */
+	abstract public function idfFreq($docFreq, $numDocs);
 
-    /**
-     * Computes a score factor based on the fraction of all query terms that a
-     * document contains.  This value is multiplied into scores.
-     *
-     * The presence of a large portion of the query terms indicates a better
-     * match with the query, so implemenations of this method usually return
-     * larger values when the ratio between these parameters is large and smaller
-     * values when the ratio between them is small.
-     *
-     * overlap - the number of query terms matched in the document
-     * maxOverlap - the total number of terms in the query
-     * Returns a score factor based on term overlap with the query
-     *
-     * @param integer $overlap
-     * @param integer $maxOverlap
-     * @return float
-     */
-    abstract public function coord($overlap, $maxOverlap);
+	/**
+	 * Computes a score factor based on the fraction of all query terms that a
+	 * document contains.  This value is multiplied into scores.
+	 *
+	 * The presence of a large portion of the query terms indicates a better
+	 * match with the query, so implemenations of this method usually return
+	 * larger values when the ratio between these parameters is large and smaller
+	 * values when the ratio between them is small.
+	 *
+	 * overlap - the number of query terms matched in the document
+	 * maxOverlap - the total number of terms in the query
+	 * Returns a score factor based on term overlap with the query
+	 *
+	 * @param integer $overlap
+	 * @param integer $maxOverlap
+	 * @return float
+	 */
+	abstract public function coord($overlap, $maxOverlap);
 }
 

Spacing +5 added lines, -5 removed lines

@@ -44,7 +44,7 @@ 
      *
      * @var array
      */
-    static private $_normTable = array( 0   => 0.0,
+    static private $_normTable = array(0   => 0.0,
                                         1   => 5.820766E-10,
                                         2   => 6.9849193E-10,
                                         3   => 8.1490725E-10,
@@ -299,7 +299,7 @@ 
                                         252 => 4.2949673E9,
                                         253 => 5.3687091E9,
                                         254 => 6.4424509E9,
-                                        255 => 7.5161928E9 );
+                                        255 => 7.5161928E9);
 
 
     /**
@@ -426,9 +426,9 @@ 
             $delta = $f - self::$_normTable[$mid];
 
             if ($delta < 0) {
-                $highIndex = $mid-1;
+                $highIndex = $mid - 1;
             } elseif ($delta > 0) {
-                $lowIndex  = $mid+1;
+                $lowIndex  = $mid + 1;
             } else {
                 return $mid; // We got it!
             }
@@ -436,7 +436,7 @@ 
 
         // round to closest value
         if ($highIndex != 255 &&
-            $f - self::$_normTable[$highIndex] > self::$_normTable[$highIndex+1] - $f ) {
+            $f - self::$_normTable[$highIndex] > self::$_normTable[$highIndex + 1] - $f) {
             return $highIndex + 1;
         } else {
             return $highIndex;

demos/quickstart/protected/index/Zend/Search/Lucene/Storage/Directory/Filesystem.php

Doc Comments +1 added lines, -1 removed lines

@@ -241,7 +241,7 @@
      * Sets the modified time of $filename to now.
      *
      * @param string $filename
-     * @return void
+     * @return boolean
      */
     public function touchFile($filename)
     {

Indentation +229 added lines, -229 removed lines

@@ -36,234 +36,234 @@
  */
 class Zend_Search_Lucene_Storage_Directory_Filesystem extends Zend_Search_Lucene_Storage_Directory
 {
-    /**
-     * Filesystem path to the directory
-     *
-     * @var string
-     */
-    private $_dirPath = null;
-
-    /**
-     * Cache for Zend_Search_Lucene_Storage_File_Filesystem objects
-     * Array: filename => Zend_Search_Lucene_Storage_File object
-     *
-     * @var array
-     * @throws Zend_Search_Lucene_Exception
-     */
-    private $_fileHandlers;
-
-
-    /**
-     * Utility function to recursive directory creation
-     *
-     * @param string $dir
-     * @param integer $mode
-     * @param boolean $recursive
-     * @return boolean
-     */
-
-    static public function mkdirs($dir, $mode = 0777, $recursive = true)
-    {
-        if (is_null($dir) || $dir === '') {
-            return false;
-        }
-        if (is_dir($dir) || $dir === '/') {
-            return true;
-        }
-        if (self::mkdirs(dirname($dir), $mode, $recursive)) {
-            return mkdir($dir, $mode);
-        }
-        return false;
-    }
-
-
-    /**
-     * Object constructor
-     * Checks if $path is a directory or tries to create it.
-     *
-     * @param string $path
-     * @throws Zend_Search_Lucene_Exception
-     */
-    public function __construct($path)
-    {
-        if (!is_dir($path)) {
-            if (file_exists($path)) {
-                throw new Zend_Search_Lucene_Exception('Path exists, but it\'s not a directory');
-            } else {
-                if (!self::mkdirs($path)) {
-                    throw new Zend_Search_Lucene_Exception("Can't create directory '$path'.");
-                }
-            }
-        }
-        $this->_dirPath = $path;
-        $this->_fileHandlers = array();
-    }
-
-
-    /**
-     * Closes the store.
-     *
-     * @return void
-     */
-    public function close()
-    {
-        foreach ($this->_fileHandlers as $fileObject) {
-            $fileObject->close();
-        }
-
-        unset($this->_fileHandlers);
-    }
-
-
-    /**
-     * Returns an array of strings, one for each file in the directory.
-     *
-     * @return array
-     */
-    public function fileList()
-    {
-        $result = array();
-
-        $dirContent = opendir( $this->_dirPath );
-        while ($file = readdir($dirContent)) {
-            if (($file == '..')||($file == '.'))   continue;
-
-            $fullName = $this->_dirPath . '/' . $file;
-
-            if( !is_dir($this->_dirPath . '/' . $file) ) {
-                $result[] = $file;
-            }
-        }
-
-        return $result;
-    }
-
-    /**
-     * Creates a new, empty file in the directory with the given $filename.
-     *
-     * @param string $filename
-     * @return Zend_Search_Lucene_Storage_File
-     */
-    public function createFile($filename)
-    {
-        if (isset($this->_fileHandlers[$filename])) {
-            $this->_fileHandlers[$filename]->close();
-        }
-        unset($this->_fileHandlers[$filename]);
-        $this->_fileHandlers[$filename] = new Zend_Search_Lucene_Storage_File_Filesystem($this->_dirPath . '/' . $filename, 'w+b');
-        return $this->_fileHandlers[$filename];
-    }
-
-
-    /**
-     * Removes an existing $filename in the directory.
-     *
-     * @param string $filename
-     * @return void
-     */
-    public function deleteFile($filename)
-    {
-        if (isset($this->_fileHandlers[$filename])) {
-            $this->_fileHandlers[$filename]->close();
-        }
-        unset($this->_fileHandlers[$filename]);
-        unlink($this->_dirPath .'/'. $filename);
-    }
-
-
-    /**
-     * Returns true if a file with the given $filename exists.
-     *
-     * @param string $filename
-     * @return boolean
-     */
-    public function fileExists($filename)
-    {
-        return file_exists($this->_dirPath .'/'. $filename);
-    }
-
-
-    /**
-     * Returns the length of a $filename in the directory.
-     *
-     * @param string $filename
-     * @return integer
-     */
-    public function fileLength($filename)
-    {
-        if (isset( $this->_fileHandlers[$filename] )) {
-            return $this->_fileHandlers[$filename]->size();
-        }
-        return filesize($this->_dirPath .'/'. $filename);
-    }
-
-
-    /**
-     * Returns the UNIX timestamp $filename was last modified.
-     *
-     * @param string $filename
-     * @return integer
-     */
-    public function fileModified($filename)
-    {
-        return filemtime($this->_dirPath .'/'. $filename);
-    }
-
-
-    /**
-     * Renames an existing file in the directory.
-     *
-     * @param string $from
-     * @param string $to
-     * @return void
-     */
-    public function renameFile($from, $to)
-    {
-        if ($this->_fileHandlers[$from] !== null) {
-            $this->_fileHandlers[$from]->close();
-        }
-        unset($this->_fileHandlers[$from]);
-
-        if ($this->_fileHandlers[$to] !== null) {
-            $this->_fileHandlers[$to]->close();
-        }
-        unset($this->_fileHandlers[$to]);
-
-        if (file_exists($this->_dirPath . '/' . $to)) {
-            unlink($this->_dirPath . '/' . $to);
-        }
-
-        return @rename($this->_dirPath . '/' . $from, $this->_dirPath . '/' . $to);
-    }
-
-
-    /**
-     * Sets the modified time of $filename to now.
-     *
-     * @param string $filename
-     * @return void
-     */
-    public function touchFile($filename)
-    {
-        return touch($this->_dirPath .'/'. $filename);
-    }
-
-
-    /**
-     * Returns a Zend_Search_Lucene_Storage_File object for a given $filename in the directory.
-     *
-     * @param string $filename
-     * @return Zend_Search_Lucene_Storage_File
-     */
-    public function getFileObject($filename)
-    {
-        if (isset( $this->_fileHandlers[$filename] )) {
-            $this->_fileHandlers[$filename]->seek(0);
-            return $this->_fileHandlers[$filename];
-        }
-
-        $this->_fileHandlers[$filename] = new Zend_Search_Lucene_Storage_File_Filesystem($this->_dirPath . '/' . $filename, 'rb');
-        return $this->_fileHandlers[$filename];
-    }
+	/**
+	 * Filesystem path to the directory
+	 *
+	 * @var string
+	 */
+	private $_dirPath = null;
+
+	/**
+	 * Cache for Zend_Search_Lucene_Storage_File_Filesystem objects
+	 * Array: filename => Zend_Search_Lucene_Storage_File object
+	 *
+	 * @var array
+	 * @throws Zend_Search_Lucene_Exception
+	 */
+	private $_fileHandlers;
+
+
+	/**
+	 * Utility function to recursive directory creation
+	 *
+	 * @param string $dir
+	 * @param integer $mode
+	 * @param boolean $recursive
+	 * @return boolean
+	 */
+
+	static public function mkdirs($dir, $mode = 0777, $recursive = true)
+	{
+		if (is_null($dir) || $dir === '') {
+			return false;
+		}
+		if (is_dir($dir) || $dir === '/') {
+			return true;
+		}
+		if (self::mkdirs(dirname($dir), $mode, $recursive)) {
+			return mkdir($dir, $mode);
+		}
+		return false;
+	}
+
+
+	/**
+	 * Object constructor
+	 * Checks if $path is a directory or tries to create it.
+	 *
+	 * @param string $path
+	 * @throws Zend_Search_Lucene_Exception
+	 */
+	public function __construct($path)
+	{
+		if (!is_dir($path)) {
+			if (file_exists($path)) {
+				throw new Zend_Search_Lucene_Exception('Path exists, but it\'s not a directory');
+			} else {
+				if (!self::mkdirs($path)) {
+					throw new Zend_Search_Lucene_Exception("Can't create directory '$path'.");
+				}
+			}
+		}
+		$this->_dirPath = $path;
+		$this->_fileHandlers = array();
+	}
+
+
+	/**
+	 * Closes the store.
+	 *
+	 * @return void
+	 */
+	public function close()
+	{
+		foreach ($this->_fileHandlers as $fileObject) {
+			$fileObject->close();
+		}
+
+		unset($this->_fileHandlers);
+	}
+
+
+	/**
+	 * Returns an array of strings, one for each file in the directory.
+	 *
+	 * @return array
+	 */
+	public function fileList()
+	{
+		$result = array();
+
+		$dirContent = opendir( $this->_dirPath );
+		while ($file = readdir($dirContent)) {
+			if (($file == '..')||($file == '.'))   continue;
+
+			$fullName = $this->_dirPath . '/' . $file;
+
+			if( !is_dir($this->_dirPath . '/' . $file) ) {
+				$result[] = $file;
+			}
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Creates a new, empty file in the directory with the given $filename.
+	 *
+	 * @param string $filename
+	 * @return Zend_Search_Lucene_Storage_File
+	 */
+	public function createFile($filename)
+	{
+		if (isset($this->_fileHandlers[$filename])) {
+			$this->_fileHandlers[$filename]->close();
+		}
+		unset($this->_fileHandlers[$filename]);
+		$this->_fileHandlers[$filename] = new Zend_Search_Lucene_Storage_File_Filesystem($this->_dirPath . '/' . $filename, 'w+b');
+		return $this->_fileHandlers[$filename];
+	}
+
+
+	/**
+	 * Removes an existing $filename in the directory.
+	 *
+	 * @param string $filename
+	 * @return void
+	 */
+	public function deleteFile($filename)
+	{
+		if (isset($this->_fileHandlers[$filename])) {
+			$this->_fileHandlers[$filename]->close();
+		}
+		unset($this->_fileHandlers[$filename]);
+		unlink($this->_dirPath .'/'. $filename);
+	}
+
+
+	/**
+	 * Returns true if a file with the given $filename exists.
+	 *
+	 * @param string $filename
+	 * @return boolean
+	 */
+	public function fileExists($filename)
+	{
+		return file_exists($this->_dirPath .'/'. $filename);
+	}
+
+
+	/**
+	 * Returns the length of a $filename in the directory.
+	 *
+	 * @param string $filename
+	 * @return integer
+	 */
+	public function fileLength($filename)
+	{
+		if (isset( $this->_fileHandlers[$filename] )) {
+			return $this->_fileHandlers[$filename]->size();
+		}
+		return filesize($this->_dirPath .'/'. $filename);
+	}
+
+
+	/**
+	 * Returns the UNIX timestamp $filename was last modified.
+	 *
+	 * @param string $filename
+	 * @return integer
+	 */
+	public function fileModified($filename)
+	{
+		return filemtime($this->_dirPath .'/'. $filename);
+	}
+
+
+	/**
+	 * Renames an existing file in the directory.
+	 *
+	 * @param string $from
+	 * @param string $to
+	 * @return void
+	 */
+	public function renameFile($from, $to)
+	{
+		if ($this->_fileHandlers[$from] !== null) {
+			$this->_fileHandlers[$from]->close();
+		}
+		unset($this->_fileHandlers[$from]);
+
+		if ($this->_fileHandlers[$to] !== null) {
+			$this->_fileHandlers[$to]->close();
+		}
+		unset($this->_fileHandlers[$to]);
+
+		if (file_exists($this->_dirPath . '/' . $to)) {
+			unlink($this->_dirPath . '/' . $to);
+		}
+
+		return @rename($this->_dirPath . '/' . $from, $this->_dirPath . '/' . $to);
+	}
+
+
+	/**
+	 * Sets the modified time of $filename to now.
+	 *
+	 * @param string $filename
+	 * @return void
+	 */
+	public function touchFile($filename)
+	{
+		return touch($this->_dirPath .'/'. $filename);
+	}
+
+
+	/**
+	 * Returns a Zend_Search_Lucene_Storage_File object for a given $filename in the directory.
+	 *
+	 * @param string $filename
+	 * @return Zend_Search_Lucene_Storage_File
+	 */
+	public function getFileObject($filename)
+	{
+		if (isset( $this->_fileHandlers[$filename] )) {
+			$this->_fileHandlers[$filename]->seek(0);
+			return $this->_fileHandlers[$filename];
+		}
+
+		$this->_fileHandlers[$filename] = new Zend_Search_Lucene_Storage_File_Filesystem($this->_dirPath . '/' . $filename, 'rb');
+		return $this->_fileHandlers[$filename];
+	}
 }
 

Spacing +10 added lines, -10 removed lines

@@ -124,13 +124,13 @@ 
     {
         $result = array();
 
-        $dirContent = opendir( $this->_dirPath );
+        $dirContent = opendir($this->_dirPath);
         while ($file = readdir($dirContent)) {
-            if (($file == '..')||($file == '.'))   continue;
+            if (($file == '..') || ($file == '.'))   continue;
 
             $fullName = $this->_dirPath . '/' . $file;
 
-            if( !is_dir($this->_dirPath . '/' . $file) ) {
+            if (!is_dir($this->_dirPath . '/' . $file)) {
                 $result[] = $file;
             }
         }
@@ -167,7 +167,7 @@ 
             $this->_fileHandlers[$filename]->close();
         }
         unset($this->_fileHandlers[$filename]);
-        unlink($this->_dirPath .'/'. $filename);
+        unlink($this->_dirPath . '/' . $filename);
     }
 
 
@@ -179,7 +179,7 @@ 
      */
     public function fileExists($filename)
     {
-        return file_exists($this->_dirPath .'/'. $filename);
+        return file_exists($this->_dirPath . '/' . $filename);
     }
 
 
@@ -191,10 +191,10 @@ 
      */
     public function fileLength($filename)
     {
-        if (isset( $this->_fileHandlers[$filename] )) {
+        if (isset($this->_fileHandlers[$filename])) {
             return $this->_fileHandlers[$filename]->size();
         }
-        return filesize($this->_dirPath .'/'. $filename);
+        return filesize($this->_dirPath . '/' . $filename);
     }
 
 
@@ -206,7 +206,7 @@ 
      */
     public function fileModified($filename)
     {
-        return filemtime($this->_dirPath .'/'. $filename);
+        return filemtime($this->_dirPath . '/' . $filename);
     }
 
 
@@ -245,7 +245,7 @@ 
      */
     public function touchFile($filename)
     {
-        return touch($this->_dirPath .'/'. $filename);
+        return touch($this->_dirPath . '/' . $filename);
     }
 
 
@@ -257,7 +257,7 @@ 
      */
     public function getFileObject($filename)
     {
-        if (isset( $this->_fileHandlers[$filename] )) {
+        if (isset($this->_fileHandlers[$filename])) {
             $this->_fileHandlers[$filename]->seek(0);
             return $this->_fileHandlers[$filename];
         }

demos/quickstart/protected/pages/Search.php

Doc Comments +3 added lines

@@ -42,6 +42,9 @@
 		return $prefix.implode(' ', $subtext).$suffix;
 	}
 
+	/**
+	 * @param string $word
+	 */
 	protected function containsKeys($word, $keys)
 	{
 		foreach($keys as $key)

Spacing +12 added lines, -12 removed lines

@@ -7,10 +7,10 @@ 
 {
 	public function onLoad($param)
 	{
-		if(!$this->IsPostBack && strlen($text = $this->search->getText()) > 0)
+		if (!$this->IsPostBack && strlen($text = $this->search->getText()) > 0)
 		{
 			$quickstart = $this->getApplication()->getModule("quickstart_search");
-			$hits_1 =  $quickstart->find($text);
+			$hits_1 = $quickstart->find($text);
 			$this->quickstart_results->setDataSource($hits_1);
 			$this->quickstart_results->dataBind();
 
@@ -21,32 +21,32 @@ 
 	public function highlightSearch($text)
 	{
 		$words = str_word_count($text, 1);
-		$keys = str_word_count(strtolower($this->search->getText()),1);
+		$keys = str_word_count(strtolower($this->search->getText()), 1);
 		$where = 0;
 		$t = count($words);
-		for($i = 0; $i<$t; $i++)
+		for ($i = 0; $i < $t; $i++)
 		{
-			if($this->containsKeys(strtolower($words[$i]), $keys))
+			if ($this->containsKeys(strtolower($words[$i]), $keys))
 			{
-				$words[$i] = '<span class="searchterm">'.$words[$i].'</span>';
+				$words[$i] = '<span class="searchterm">' . $words[$i] . '</span>';
 				$where = $i;
 				break;
 			}
 		}
 
-		$min = 	$where - 15 < 0 ? 0 : $where - 15;
-		$max = 	$where + 15 > $t ? $t : $where + 15;
-		$subtext = array_splice($words, $min, $max-$min);
+		$min = $where - 15 < 0 ? 0 : $where - 15;
+		$max = $where + 15 > $t ? $t : $where + 15;
+		$subtext = array_splice($words, $min, $max - $min);
 		$prefix = $min == 0 ? '' : '...';
 		$suffix = $max == $t ? '' : '...';
-		return $prefix.implode(' ', $subtext).$suffix;
+		return $prefix . implode(' ', $subtext) . $suffix;
 	}
 
 	protected function containsKeys($word, $keys)
 	{
-		foreach($keys as $key)
+		foreach ($keys as $key)
 		{
-			if(is_int(strpos($word, $key)))
+			if (is_int(strpos($word, $key)))
 				return true;
 		}
 		return false;

demos/quickstart/protected/pages/ViewSource.php

Doc Comments +12 added lines

@@ -69,11 +69,17 @@ 
 		return $list;
 	}
 
+	/**
+	 * @param string $extension
+	 */
 	protected function isFileTypeAllowed($extension)
 	{
 		return in_array($extension,array('tpl','page','php','html'));
 	}
 
+	/**
+	 * @param string $fileName
+	 */
 	protected function getFileExtension($fileName)
 	{
 		if(($pos=strrpos($fileName,'.'))===false)
@@ -82,6 +88,9 @@ 
 			return substr($fileName,$pos+1);
 	}
 
+	/**
+	 * @param string $extension
+	 */
 	protected function getFileType($extension)
 	{
 		if($extension==='tpl' || $extension==='page')
@@ -90,6 +99,9 @@ 
 			return 'Class file';
 	}
 
+	/**
+	 * @param string $extension
+	 */
 	protected function getFileLanguage($extension)
 	{
 		switch($extension)

Spacing +35 added lines, -35 removed lines

@@ -2,34 +2,34 @@ 
 
 class ViewSource extends TPage
 {
-	private $_path=null;
-	private $_fullPath=null;
-	private $_fileType=null;
+	private $_path = null;
+	private $_fullPath = null;
+	private $_fileType = null;
 
 	public function onLoad($param)
 	{
 		parent::onLoad($param);
-		$path=$this->Request['path'];
-		$fullPath=realpath($this->Service->BasePath.'/'.$path);
-		$fileExt=$this->getFileExtension($fullPath);
-		if($fullPath!==false && is_file($fullPath) && strpos($fullPath,$this->Service->BasePath)!==false)
+		$path = $this->Request['path'];
+		$fullPath = realpath($this->Service->BasePath . '/' . $path);
+		$fileExt = $this->getFileExtension($fullPath);
+		if ($fullPath !== false && is_file($fullPath) && strpos($fullPath, $this->Service->BasePath) !== false)
 		{
- 			if($this->isFileTypeAllowed($fileExt))
+ 			if ($this->isFileTypeAllowed($fileExt))
  			{
-				$this->_fullPath=strtr($fullPath,'\\','/');
-				$this->_path=strtr(substr($fullPath,strlen($this->Service->BasePath)),'\\','/');
+				$this->_fullPath = strtr($fullPath, '\\', '/');
+				$this->_path = strtr(substr($fullPath, strlen($this->Service->BasePath)), '\\', '/');
  			}
 		}
-		if($this->_fullPath===null)
-			throw new THttpException(500,'File Not Found: %s',$path);
+		if ($this->_fullPath === null)
+			throw new THttpException(500, 'File Not Found: %s', $path);
 
-		$this->SourceList->DataSource=$this->SourceFiles;
+		$this->SourceList->DataSource = $this->SourceFiles;
 		$this->SourceList->dataBind();
 
-		$this->Highlighter->Language=$this->getFileLanguage($fileExt);
-		if($this->Request['lines']==='false')
-			$this->Highlighter->ShowLineNumbers=false;
-		$this->SourceView->Text=file_get_contents($this->_fullPath);
+		$this->Highlighter->Language = $this->getFileLanguage($fileExt);
+		if ($this->Request['lines'] === 'false')
+			$this->Highlighter->ShowLineNumbers = false;
+		$this->SourceView->Text = file_get_contents($this->_fullPath);
 	}
 
 	public function getFilePath()
@@ -39,23 +39,23 @@ 
 
 	protected function getSourceFiles()
 	{
-		$list=array();
-		$basePath=dirname($this->_fullPath);
-		if($dh=opendir($basePath))
+		$list = array();
+		$basePath = dirname($this->_fullPath);
+		if ($dh = opendir($basePath))
 		{
-			while(($file=readdir($dh))!==false)
+			while (($file = readdir($dh)) !== false)
 			{
-				if(is_file($basePath.'/'.$file))
+				if (is_file($basePath . '/' . $file))
 				{
-					$extension=$this->getFileExtension($basePath.'/'.$file);
-					if($this->isFileTypeAllowed($extension))
+					$extension = $this->getFileExtension($basePath . '/' . $file);
+					if ($this->isFileTypeAllowed($extension))
 					{
-						$fileType=$this->getFileType($extension);
-						$list[]=array(
+						$fileType = $this->getFileType($extension);
+						$list[] = array(
 							'name'=>$file,
 							'type'=>$fileType,
-							'active'=>basename($this->_fullPath)===$file,
-							'url'=>'?page=ViewSource&path=/'.ltrim(strtr(dirname($this->_path),'\\','/').'/'.$file,'/')
+							'active'=>basename($this->_fullPath) === $file,
+							'url'=>'?page=ViewSource&path=/' . ltrim(strtr(dirname($this->_path), '\\', '/') . '/' . $file, '/')
 						);
 					}
 				}
@@ -63,28 +63,28 @@ 
 			}
 			closedir($dh);
 		}
-		foreach($list as $item)
-			$aux[]=$item['name'];
+		foreach ($list as $item)
+			$aux[] = $item['name'];
 		array_multisort($aux, SORT_ASC, $list);
 		return $list;
 	}
 
 	protected function isFileTypeAllowed($extension)
 	{
-		return in_array($extension,array('tpl','page','php','html'));
+		return in_array($extension, array('tpl', 'page', 'php', 'html'));
 	}
 
 	protected function getFileExtension($fileName)
 	{
-		if(($pos=strrpos($fileName,'.'))===false)
+		if (($pos = strrpos($fileName, '.')) === false)
 			return '';
 		else
-			return substr($fileName,$pos+1);
+			return substr($fileName, $pos + 1);
 	}
 
 	protected function getFileType($extension)
 	{
-		if($extension==='tpl' || $extension==='page')
+		if ($extension === 'tpl' || $extension === 'page')
 			return 'Template file';
 		else
 			return 'Class file';
@@ -92,7 +92,7 @@ 
 
 	protected function getFileLanguage($extension)
 	{
-		switch($extension)
+		switch ($extension)
 		{
 			case 'page' :
 			case 'tpl' :

Braces +3 added lines, -2 removed lines

@@ -63,8 +63,9 @@
 			}
 			closedir($dh);
 		}
-		foreach($list as $item)
-			$aux[]=$item['name'];
+		foreach($list as $item) {
+					$aux[]=$item['name'];
+		}
 		array_multisort($aux, SORT_ASC, $list);
 		return $list;
 	}