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>

Braces +6 added lines, -4 removed lines

@@ -37,8 +37,9 @@ 
 			$data = $this->getCommentData();
 			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";
@@ -55,8 +56,9 @@ 
 
 	function add_comment($sender, $param)
 	{
-		if(!$this->Page->IsValid)
-			return;
+		if(!$this->Page->IsValid) {
+					return;
+		}
 		$record = new CommentRecord;
 		$record->username = $this->username->Text;
 		$record->date_added = date('Y-m-d h:i:s');

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);
     }
 
 

Braces +3 added lines, -2 removed lines

@@ -465,8 +465,9 @@
      */
     public function norm( $id, $fieldName )
     {
-        if( $id >= $this->_docCount )
-            return null;
+        if( $id >= $this->_docCount ) {
+                    return null;
+        }
 
         $segCount = 0;
         $nextSegmentStartId = $this->_segmentInfos[ 0 ]->count();

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/Field.php

Doc Comments +3 added lines

@@ -47,6 +47,9 @@
 
     public $boost = 1.0;
 
+    /**
+     * @param boolean $isStored
+     */
     public function __construct($name, $stringValue, $isStored, $isIndexed, $isTokenized, $isBinary = false)
     {
         $this->name        = $name;

Indentation +95 added lines, -95 removed lines

@@ -34,101 +34,101 @@
  */
 class Zend_Search_Lucene_Field
 {
-    public $kind;
-
-    public $name        = 'body';
-    public $stringValue = null;
-    public $isStored    = false;
-    public $isIndexed   = true;
-    public $isTokenized = true;
-    public $isBinary    = false;
-
-    public $storeTermVector = false;
-
-    public $boost = 1.0;
-
-    public function __construct($name, $stringValue, $isStored, $isIndexed, $isTokenized, $isBinary = false)
-    {
-        $this->name        = $name;
-        $this->stringValue = $stringValue;
-        $this->isStored    = $isStored;
-        $this->isIndexed   = $isIndexed;
-        $this->isTokenized = $isTokenized;
-        $this->isBinary    = $isBinary;
-
-        $this->storeTermVector = false;
-        $this->boost           = 1.0;
-    }
-
-
-    /**
-     * Constructs a String-valued Field that is not tokenized, but is indexed
-     * and stored.  Useful for non-text fields, e.g. date or url.
-     *
-     * @param string $name
-     * @param string $value
-     * @return Zend_Search_Lucene_Field
-     */
-    static public function Keyword($name, $value)
-    {
-        return new self($name, $value, true, true, false);
-    }
-
-
-    /**
-     * Constructs a String-valued Field that is not tokenized nor indexed,
-     * but is stored in the index, for return with hits.
-     *
-     * @param string $name
-     * @param string $value
-     * @return Zend_Search_Lucene_Field
-     */
-    static public function UnIndexed($name, $value)
-    {
-        return new self($name, $value, true, false, false);
-    }
-
-
-    /**
-     * Constructs a Binary String valued Field that is not tokenized nor indexed,
-     * but is stored in the index, for return with hits.
-     *
-     * @param string $name
-     * @param string $value
-     * @return Zend_Search_Lucene_Field
-     */
-    static public function Binary($name, $value)
-    {
-        return new self($name, $value, true, false, false, true);
-    }
-
-    /**
-     * Constructs a String-valued Field that is tokenized and indexed,
-     * and is stored in the index, for return with hits.  Useful for short text
-     * fields, like "title" or "subject". Term vector will not be stored for this field.
-     *
-     * @param string $name
-     * @param string $value
-     * @return Zend_Search_Lucene_Field
-     */
-    static public function Text($name, $value)
-    {
-        return new self($name, $value, true, true, true);
-    }
-
-
-    /**
-     * Constructs a String-valued Field that is tokenized and indexed,
-     * but that is not stored in the index.
-     *
-     * @param string $name
-     * @param string $value
-     * @return Zend_Search_Lucene_Field
-     */
-    static public function UnStored($name, $value)
-    {
-        return new self($name, $value, false, true, true);
-    }
+	public $kind;
+
+	public $name        = 'body';
+	public $stringValue = null;
+	public $isStored    = false;
+	public $isIndexed   = true;
+	public $isTokenized = true;
+	public $isBinary    = false;
+
+	public $storeTermVector = false;
+
+	public $boost = 1.0;
+
+	public function __construct($name, $stringValue, $isStored, $isIndexed, $isTokenized, $isBinary = false)
+	{
+		$this->name        = $name;
+		$this->stringValue = $stringValue;
+		$this->isStored    = $isStored;
+		$this->isIndexed   = $isIndexed;
+		$this->isTokenized = $isTokenized;
+		$this->isBinary    = $isBinary;
+
+		$this->storeTermVector = false;
+		$this->boost           = 1.0;
+	}
+
+
+	/**
+	 * Constructs a String-valued Field that is not tokenized, but is indexed
+	 * and stored.  Useful for non-text fields, e.g. date or url.
+	 *
+	 * @param string $name
+	 * @param string $value
+	 * @return Zend_Search_Lucene_Field
+	 */
+	static public function Keyword($name, $value)
+	{
+		return new self($name, $value, true, true, false);
+	}
+
+
+	/**
+	 * Constructs a String-valued Field that is not tokenized nor indexed,
+	 * but is stored in the index, for return with hits.
+	 *
+	 * @param string $name
+	 * @param string $value
+	 * @return Zend_Search_Lucene_Field
+	 */
+	static public function UnIndexed($name, $value)
+	{
+		return new self($name, $value, true, false, false);
+	}
+
+
+	/**
+	 * Constructs a Binary String valued Field that is not tokenized nor indexed,
+	 * but is stored in the index, for return with hits.
+	 *
+	 * @param string $name
+	 * @param string $value
+	 * @return Zend_Search_Lucene_Field
+	 */
+	static public function Binary($name, $value)
+	{
+		return new self($name, $value, true, false, false, true);
+	}
+
+	/**
+	 * Constructs a String-valued Field that is tokenized and indexed,
+	 * and is stored in the index, for return with hits.  Useful for short text
+	 * fields, like "title" or "subject". Term vector will not be stored for this field.
+	 *
+	 * @param string $name
+	 * @param string $value
+	 * @return Zend_Search_Lucene_Field
+	 */
+	static public function Text($name, $value)
+	{
+		return new self($name, $value, true, true, true);
+	}
+
+
+	/**
+	 * Constructs a String-valued Field that is tokenized and indexed,
+	 * but that is not stored in the index.
+	 *
+	 * @param string $name
+	 * @param string $value
+	 * @return Zend_Search_Lucene_Field
+	 */
+	static public function UnStored($name, $value)
+	{
+		return new self($name, $value, false, true, true);
+	}
 
 }
 

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

Doc Comments +4 added lines

@@ -32,6 +32,10 @@
     public $number;
     public $storeTermVector;
 
+    /**
+     * @param string $name
+     * @param integer $number
+     */
     public function __construct( $name, $isIndexed, $number, $storeTermVector )
     {
         $this->name            = $name;

Indentation +11 added lines, -11 removed lines

@@ -27,17 +27,17 @@
  */
 class Zend_Search_Lucene_Index_FieldInfo
 {
-    public $name;
-    public $isIndexed;
-    public $number;
-    public $storeTermVector;
+	public $name;
+	public $isIndexed;
+	public $number;
+	public $storeTermVector;
 
-    public function __construct( $name, $isIndexed, $number, $storeTermVector )
-    {
-        $this->name            = $name;
-        $this->isIndexed       = $isIndexed;
-        $this->number          = $number;
-        $this->storeTermVector = $storeTermVector;
-    }
+	public function __construct( $name, $isIndexed, $number, $storeTermVector )
+	{
+		$this->name            = $name;
+		$this->isIndexed       = $isIndexed;
+		$this->number          = $number;
+		$this->storeTermVector = $storeTermVector;
+	}
 }
 

Spacing +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
     public $number;
     public $storeTermVector;
 
-    public function __construct( $name, $isIndexed, $number, $storeTermVector )
+    public function __construct($name, $isIndexed, $number, $storeTermVector)
     {
         $this->name            = $name;
         $this->isIndexed       = $isIndexed;

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/Index/TermInfo.php

Doc Comments +5 added lines

@@ -65,6 +65,11 @@
      */
     public $indexPointer;
 
+    /**
+     * @param integer $docFreq
+     * @param integer $skipOffset
+     * @param integer $indexPointer
+     */
     public function __construct($docFreq, $freqPointer, $proxPointer, $skipOffset, $indexPointer = null)
     {
         $this->docFreq      = $docFreq;

Indentation +39 added lines, -39 removed lines

@@ -29,49 +29,49 @@
  */
 class Zend_Search_Lucene_Index_TermInfo
 {
-    /**
-     * The number of documents which contain the term.
-     *
-     * @var integer
-     */
-    public $docFreq;
+	/**
+	 * The number of documents which contain the term.
+	 *
+	 * @var integer
+	 */
+	public $docFreq;
 
-    /**
-     * Data offset in a Frequencies file.
-     *
-     * @var integer
-     */
-    public $freqPointer;
+	/**
+	 * Data offset in a Frequencies file.
+	 *
+	 * @var integer
+	 */
+	public $freqPointer;
 
-    /**
-     * Data offset in a Positions file.
-     *
-     * @var integer
-     */
-    public $proxPointer;
+	/**
+	 * Data offset in a Positions file.
+	 *
+	 * @var integer
+	 */
+	public $proxPointer;
 
-    /**
-     * ScipData offset in a Frequencies file.
-     *
-     * @var integer
-     */
-    public $skipOffset;
+	/**
+	 * ScipData offset in a Frequencies file.
+	 *
+	 * @var integer
+	 */
+	public $skipOffset;
 
-    /**
-     * Term offset of the _next_ term in a TermDictionary file.
-     * Used only for Term Index
-     *
-     * @var integer
-     */
-    public $indexPointer;
+	/**
+	 * Term offset of the _next_ term in a TermDictionary file.
+	 * Used only for Term Index
+	 *
+	 * @var integer
+	 */
+	public $indexPointer;
 
-    public function __construct($docFreq, $freqPointer, $proxPointer, $skipOffset, $indexPointer = null)
-    {
-        $this->docFreq      = $docFreq;
-        $this->freqPointer  = $freqPointer;
-        $this->proxPointer  = $proxPointer;
-        $this->skipOffset   = $skipOffset;
-        $this->indexPointer = $indexPointer;
-    }
+	public function __construct($docFreq, $freqPointer, $proxPointer, $skipOffset, $indexPointer = null)
+	{
+		$this->docFreq      = $docFreq;
+		$this->freqPointer  = $freqPointer;
+		$this->proxPointer  = $proxPointer;
+		$this->skipOffset   = $skipOffset;
+		$this->indexPointer = $indexPointer;
+	}
 }
 

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/QueryToken.php

Doc Comments +1 added lines, -1 removed lines

@@ -74,7 +74,7 @@
      * IndexReader constructor needs token type and token text as a parameters.
      *
      * @param $tokType integer
-     * @param $tokText string
+     * @param string $tokText string
      */
     public function __construct($tokType, $tokText)
     {

Indentation +57 added lines, -57 removed lines

@@ -31,72 +31,72 @@
  */
 class Zend_Search_Lucene_Search_QueryToken
 {
-    /**
-     * Token type Word.
-     */
-    const TOKTYPE_WORD = 0;
+	/**
+	 * Token type Word.
+	 */
+	const TOKTYPE_WORD = 0;
 
-    /**
-     * Token type Field.
-     * Field indicator in 'field:word' pair
-     */
-    const TOKTYPE_FIELD = 1;
+	/**
+	 * Token type Field.
+	 * Field indicator in 'field:word' pair
+	 */
+	const TOKTYPE_FIELD = 1;
 
-    /**
-     * Token type Sign.
-     * '+' (required) or '-' (absentee) sign
-     */
-    const TOKTYPE_SIGN = 2;
+	/**
+	 * Token type Sign.
+	 * '+' (required) or '-' (absentee) sign
+	 */
+	const TOKTYPE_SIGN = 2;
 
-    /**
-     * Token type Bracket.
-     * '(' or ')'
-     */
-    const TOKTYPE_BRACKET = 3;
+	/**
+	 * Token type Bracket.
+	 * '(' or ')'
+	 */
+	const TOKTYPE_BRACKET = 3;
 
 
-    /**
-     * Token type.
-     *
-     * @var integer
-     */
-    public $type;
+	/**
+	 * Token type.
+	 *
+	 * @var integer
+	 */
+	public $type;
 
-    /**
-     * Token text.
-     *
-     * @var integer
-     */
-    public $text;
+	/**
+	 * Token text.
+	 *
+	 * @var integer
+	 */
+	public $text;
 
 
-    /**
-     * IndexReader constructor needs token type and token text as a parameters.
-     *
-     * @param $tokType integer
-     * @param $tokText string
-     */
-    public function __construct($tokType, $tokText)
-    {
-        switch ($tokType) {
-            case self::TOKTYPE_BRACKET:
-                // fall through to the next case
-            case self::TOKTYPE_FIELD:
-                // fall through to the next case
-            case self::TOKTYPE_SIGN:
-                // fall through to the next case
-            case self::TOKTYPE_WORD:
-                break;
-            default:
-                throw new Zend_Search_Lucene_Exception("Unrecognized token type \"$tokType\".");
-        }
+	/**
+	 * IndexReader constructor needs token type and token text as a parameters.
+	 *
+	 * @param $tokType integer
+	 * @param $tokText string
+	 */
+	public function __construct($tokType, $tokText)
+	{
+		switch ($tokType) {
+			case self::TOKTYPE_BRACKET:
+				// fall through to the next case
+			case self::TOKTYPE_FIELD:
+				// fall through to the next case
+			case self::TOKTYPE_SIGN:
+				// fall through to the next case
+			case self::TOKTYPE_WORD:
+				break;
+			default:
+				throw new Zend_Search_Lucene_Exception("Unrecognized token type \"$tokType\".");
+		}
 
-        if (!strlen($tokText)) {
-            throw new Zend_Search_Lucene_Exception('Token text must be supplied.');
-        }
+		if (!strlen($tokText)) {
+			throw new Zend_Search_Lucene_Exception('Token text must be supplied.');
+		}
 
-        $this->type = $tokType;
-        $this->text = $tokText;
-    }
+		$this->type = $tokType;
+		$this->text = $tokText;
+	}
 }