Yii: Делаем поиск по сайту, используя Zend Lucene

Ожнажды мы делали поиск по сайту, используя только средства самого Yii (делая выборку данных из базы данных запросом со сравнением like). Этот способ прекрасно работает на сайте loco.ru, можно тут и опробовать его. Почитайте нашу статью о поиске по сайту на Yii, чтобы сейчас было проще. Идея та же, только теперь мы задействуем мощности библиотека Zend_Search_Lucene из фреймворка Zend.

(Для версии Yii2 смотрите Поиск по сайту с Zend Lucene для Yii2)

1. Скачиваем на официальном сайте архив фреймворка Zend.

2. Берём оттуда library/Zend/Search и копируем в vendors/Zend, также копируем library/Zend/Exception.php туда же. Если у вас ещё нет папки vendors, создайте. Мы завели её, чтобы отличать сторонние решения от самого Yii. Zend - сторонний "поставщик" библиотеки Zend_Search_Lucene в нашем случае. Посмотрите что получилось:

Структура папок в Yii с Zend Lucene.

3. Создайте в папке protected/runtime директорию search с правами на запись. Zend будет туда сохранять индекс страниц для результатов поиска. Ему можно.

4. В components создаём SearchBlock.php, который дальше поместим где захотим.

<?php

Yii::import('zii.widgets.CPortlet');

class SearchBlock extends CPortlet
{
public $title='Поиск';

protected function renderContent()
  {
echo CHtml::beginForm(array('search/search'), 'get', array('style'=> 'inline')) .
      CHtml::textField('q', '', array('placeholder'=> 'search...','style'=>'width:140px;')) .
      CHtml::submitButton('Go!',array('style'=>'width:30px;')) .
      CHtml::endForm('');
  }
}

5. Вызовем этот виджет в шаблоне (например в правой колонке на главной в самом верху),  вставляя код:

<?php
      $this->widget('SearchBlock', array(
      )); 
?>

Вот что получилось на вид:

6. Теперь самое главное, мозг "поиска...", создаём контроллер protected/controllers/SearchController.php:

<?php

class SearchController extends Controller
{
    /**
     * @var string index dir as alias path from <b>application.</b>  , default to <b>runtime.search</b>
     */
    private $_indexFiles = 'runtime.search';
    /**
     * (non-PHPdoc)
     * @see CController::init()
     */
    public function init(){
        Yii::import('application.vendors.*');
        require_once('Zend/Search/Lucene.php');
        parent::init(); 
    }

    /**
     * Search index creation
     */
    public function actionCreate()
    {
        setlocale(LC_CTYPE, 'ru_RU.UTF-8');
        Zend_Search_Lucene_Analysis_Analyzer::setDefault(
     new Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8());       

        $index = new Zend_Search_Lucene(Yii::getPathOfAlias('application.' . $this->_indexFiles), true);

        $posts = Place::model()->findAll();
        foreach($posts as $post){
            $doc = new Zend_Search_Lucene_Document();
            $doc->addField(Zend_Search_Lucene_Field::Text('title',
                                          CHtml::encode($post->name), 'UTF-8')
            );

            $doc->addField(Zend_Search_Lucene_Field::Text('link',
                                            "/place/".$post->id."-".CHtml::encode($post->alias)
                                                , 'UTF-8')
            );   

  $content = $this->clean_content($post->description);
            $doc->addField(Zend_Search_Lucene_Field::Text('content',
                                          $content
                                         , 'UTF-8')
            );

            $index->addDocument($doc);
        }
        $index->optimize();
        $index->commit();
        echo 'Lucene index создан успешно';
    }

    public function actionSearch()
    {
         setlocale(LC_CTYPE, 'ru_RU.UTF-8');
         Zend_Search_Lucene_Analysis_Analyzer::setDefault(
          new Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8());

        $this->layout='column2';
         if (($term = Yii::app()->getRequest()->getParam('q', null)) !== null) {
            $index = new Zend_Search_Lucene(Yii::getPathOfAlias('application.' . $this->_indexFiles));
            $results = $index->find($term);
            $query = Zend_Search_Lucene_Search_QueryParser::parse($term);      


            $this->render('search', compact('results', 'term', 'query'));
        }
    }
    
    // Function for returning a preview of the content:
// The preview is the first XXX characters.
private function preview_content($data, $limit = 400) {
   return substr($data, 0, $limit) . '...';
} // End of preview_content() function.
// Function for stripping junk out of content:
private function clean_content($data) {
   return strip_tags($data);
}
}

7. Создаём представление views/search/search.php

<?php
	$this->pageTitle='Результаты поиска -' .Yii::app()->name;
	$this->breadcrumbs=array(
	    'Результаты поиска по запросу: '. CHtml::encode($term),
	);
	?>
	 
	<h3>Результаты поиска по запросу: "<?php echo CHtml::encode($term); ?>"</h3>
	<?php if (!empty($results)): ?>
	                <?php foreach($results as $result): 
	?>                  
	                    <h2><?php echo CHtml::link($result->title, CHtml::encode($result->link)); ?></h2>
	                    <p><?php echo $query->highlightMatches($result->content); ?></p>
	                    <hr/>
	                <?php endforeach; ?>
	 
	            <?php else: ?>
	                <p class="error">Поиск не дал результатов.</p>
	            <?php endif; ?>

8. Дальше по идее всё. Надо сначала набрать в строке браузера: http://домен/search/create, чтобы Lucene создал индекс для поиска в папку runtime. Дальше это можно иногда снова выполнять, когда новые материалы добаляются, то есть обновляйте индекс время от времени, либо в КРОН поместите по расписанию. Может возникать ошибка с iconv() из за русской кодировки, но когда мы добавили в контроллерах строки

setlocale(LC_CTYPE, 'ru_RU.UTF-8');
         Zend_Search_Lucene_Analysis_Analyzer::setDefault(
          new Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8());

проблема ушла. Почитайте о проблеме с русским языком и iconv в  Zend Lucene.

В работе поиск можно посмотреть на whytravel.ru:

Также полезно почитать:

• Adding search to Yii blog example (using Zend Lucene) - на эту статью мы ориентировались, там подробности, которые мы опускали;
• Integrating Zend_Lucene with Yii - статья Ларри Уллмана;
• Creating a Search Index with Zend_Search_Lucene - другая стаья от Ларри Уллмана;
• Документация Zend Lucene;

А для версии Yii2 смотрите Поиск по сайту с Zend Lucene для Yii2