MediaSearch_Filter_KeyWords
[ class tree: MediaSearch_Filter_KeyWords ] [ index: MediaSearch_Filter_KeyWords ] [ all elements ]
Packages:
MediaSearch
Console_Application
MediaSearch_Config
MediaSearch_Config_ParseOptions
MediaSearch_File
MediaSearch_Filter
MediaSearch_Filter_File
MediaSearch_Filter_KeyWords
MediaSearch_Id3
MediaSearch_Index
MediaSearch_Interface
MediaSearch_Log
MediaSearch_Model
MediaSearch_Model_DbTable
MediaSearch_Scan
MediaSearch_Search
Zend_Application
Zend_Application_Bootstrap
Zend_Controller
Zend_Controller_Action

Source for file BlackList.php

Documentation is available at BlackList.php

  1. <?php
  2. /**
  3.  * MediaSearch
  4.  *
  5.  * LICENSE
  6.  *
  7.  * "THE BEER-WARE LICENSE" (Revision 42):
  8.  * "Sven Strittmatter" <ausserirdisch@sven-space.de> wrote this file.
  9.  * As long as you retain this notice you can do whatever you want with
  10.  * this stuff. If we meet some day, and you think this stuff is worth it,
  11.  * you can buy me a beer in return.
  12.  *
  13.  * $Author$
  14.  * $Revision$
  15.  *
  16.  * @category    MediaSearch
  17.  * @package     MediaSearch_Filter_KeyWords
  18.  * @copyright   Copyright (c) 2009 Sven Strittmatter
  19.  */
  20.  
  21. /**
  22.  * @see MediaSearch_Filter_KeyWords_Interface
  23.  */
  24. require_once('MediaSearch/Filter/KeyWords/Interface.php');
  25. /**
  26.  * @see MediaSearch_ConfigLoader
  27.  */
  28. require_once('MediaSearch/ConfigLoader.php');
  29. /**
  30.  * @see MediaSearch_Config_ParseOptions_SplitTextByLineBreak
  31.  */
  32. require_once('MediaSearch/Config/ParseOptions/SplitTextByLineBreak.php');
  33.  
  34. /**
  35.  * Removes black listed key words loaded from a config.
  36.  *
  37.  * @category   MediaSearch
  38.  * @package    MediaSearch_Filter_KeyWords
  39.  * @copyright  Copyright (c) 2009 Sven Strittmatter
  40.  */
  41. class MediaSearch_Filter_KeyWords_BlackList 
  42.     implements MediaSearch_Filter_KeyWords_Interface {
  43.  
  44.     const TRACE_LELVEL = 31;
  45.  
  46.     /**
  47.      * Instance for singleton.
  48.      *
  49.      * @static
  50.      * @access private
  51.      * @var MediaSearch_Filter_KeyWords_BlackList 
  52.      */
  53.     private static $instance;
  54.     /**
  55.      * Holds the config with the black listed key words.
  56.      *
  57.      * @access private
  58.      * @var MediaSearch_Config_Text 
  59.      */
  60.     private $config;
  61.  
  62.     /**
  63.      * Loads the blcklist config.
  64.      *
  65.      * @access public
  66.      */
  67.     private function __construct() {
  68.         $this->config = MediaSearch_ConfigLoader::get('keywordfilter',
  69.             array(new MediaSearch_Config_ParseOptions_SplitTextByLineBreak()));
  70.     }
  71.  
  72.     /**
  73.      * Returns th einstance of this class.
  74.      *
  75.      * @static
  76.      * @access public
  77.      * @return MediaSearch_Filter_KeyWords_BlackList 
  78.      */
  79.     public static function get() {
  80.         if (null === self::$instance) {
  81.             self::$instance = new MediaSearch_Filter_KeyWords_BlackList();
  82.         }
  83.  
  84.         return self::$instance;
  85.     }
  86.  
  87.     /**
  88.      * Removes all blacklisted key words (from the loaded config)
  89.      * from the passed input array.
  90.      *
  91.      * @access public
  92.      * @param array $input 
  93.      * @return array 
  94.      */
  95.     public function process(array $input) {
  96.         $filtered  = array();
  97.         $blackList = $this->config->get();
  98.  
  99.         foreach ($input as $keyword) {
  100.             if (in_array($keyword, $blackList)) {
  101.                 continue;
  102.             }
  103.  
  104.             $filtered[] = $keyword;
  105.         }
  106.  
  107.         return $filtered;
  108.     }
  109. }
Documentation generated on Mon, 17 Aug 2009 14:51:40 +0200 by phpDocumentor 1.4.2