Search/Lucene/Analysis/TokenFilter/StopWords.php
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Search_Lucene
- Subpackage
- Analysis
- Version
- $Id: StopWords.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Search_Lucene_Analysis_TokenFilter_StopWords
These words must be provided as array (set), example: $stopwords = array('the' => 1, 'an' => '1');
We do recommend to provide all words in lowercase and concatenate this class after the lowercase filter.
- Parent(s)
- \Zend_Search_Lucene_Analysis_TokenFilter
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods


__construct(array $stopwords = array()) : void
Constructs new instance of this filter.
Name | Type | Description |
---|---|---|
$stopwords | array | array (set) of words that will be filtered out |


loadFromFile(string $filepath = null) : void
Fills stopwords set from a text file.
Each line contains one stopword, lines with '#' in the first column are ignored (as comments).
You can call this method one or more times. New stopwords are always added to current set.
Name | Type | Description |
---|---|---|
$filepath | string | full path for text file with stopwords |
Exception | Description |
---|---|
\Zend_Search_Exception | When the file doesn`t exists or is not readable. |


normalize(\Zend_Search_Lucene_Analysis_Token $srcToken) : \Zend_Search_Lucene_Analysis_Token
Normalize Token or remove it (if null is returned)
Name | Type | Description |
---|---|---|
$srcToken | \Zend_Search_Lucene_Analysis_Token |
Type | Description |
---|---|
\Zend_Search_Lucene_Analysis_Token |