├── .editorconfig
├── README.md
├── _config.php
├── _config
    ├── docsviewer.yml
    └── routes.yml
├── code-of-conduct.md
├── code
    ├── DocumentationHelper.php
    ├── DocumentationManifest.php
    ├── DocumentationManifestFileFinder.php
    ├── DocumentationParser.php
    ├── DocumentationPermalinks.php
    ├── DocumentationSearch.php
    ├── controllers
    │   ├── DocumentationOpenSearchController.php
    │   └── DocumentationViewer.php
    ├── extensions
    │   ├── DocumentationSearchExtension.php
    │   ├── DocumentationStaticPublisherExtension.php
    │   └── DocumentationViewerVersionWarning.php
    ├── forms
    │   ├── DocumentationAdvancedSearchForm.php
    │   └── DocumentationSearchForm.php
    ├── models
    │   ├── DocumentationEntity.php
    │   ├── DocumentationFolder.php
    │   └── DocumentationPage.php
    └── tasks
    │   ├── CheckDocsSourcesTask.php
    │   ├── DocumentationBuild.php
    │   └── RebuildLuceneDocsIndex.php
├── composer.json
├── css
    ├── forms.css
    ├── highlight.css
    ├── layout.css
    ├── normalize.css
    ├── shSilverStripeDocs.css
    ├── small.css
    ├── typography.css
    └── utilities.css
├── images
    ├── bullet.gif
    ├── error_button.png
    ├── external_link.png
    ├── ico_close_off.png
    ├── icons
    │   ├── application.png
    │   ├── page_excel.png
    │   ├── page_white_acrobat.png
    │   ├── page_white_zip.png
    │   └── page_word.png
    ├── info_button.png
    ├── lightbulb.png
    ├── logo.jpg
    ├── menu.png
    ├── note.gif
    ├── notification.png
    ├── quote.gif
    ├── readme.png
    ├── search.png
    └── warning.png
├── javascript
    └── DocumentationViewer.js
├── lang
    ├── _manifest_exclude
    ├── en.yml
    ├── en_US.php
    ├── hr.yml
    └── hr_HR.yml
├── license.md
├── templates
    ├── DocumentationPages.ss
    ├── DocumentationViewer.ss
    ├── DocumentationViewer_all.ss
    ├── DocumentationViewer_results.ss
    ├── Includes
    │   ├── DocumentationBreadcrumbs.ss
    │   ├── DocumentationComments.ss
    │   ├── DocumentationEditLink.ss
    │   ├── DocumentationEnd.ss
    │   ├── DocumentationFooter.ss
    │   ├── DocumentationGA.ss
    │   ├── DocumentationHead.ss
    │   ├── DocumentationNextPrevious.ss
    │   ├── DocumentationPages.ss
    │   ├── DocumentationSidebar.ss
    │   ├── DocumentationTableContents.ss
    │   ├── DocumentationVersion_warning.ss
    │   └── DocumentationVersions.ss
    ├── Layout
    │   ├── DocumentationViewer_DocumentationFolder.ss
    │   ├── DocumentationViewer_DocumentationPage.ss
    │   ├── DocumentationViewer_all.ss
    │   ├── DocumentationViewer_error.ss
    │   ├── DocumentationViewer_results.ss
    │   └── DocumentationViewer_search.ss
    ├── OpenSearchDescription.ss
    └── OpenSearchResults.ss
└── thirdparty
    ├── Zend
        └── Search
        │   ├── Exception.php
        │   ├── Lucene.php
        │   └── Lucene
        │       ├── Analysis
        │           ├── Analyzer.php
        │           ├── Analyzer
        │           │   ├── Common.php
        │           │   └── Common
        │           │   │   ├── Text.php
        │           │   │   ├── Text
        │           │   │       └── CaseInsensitive.php
        │           │   │   ├── TextNum.php
        │           │   │   ├── TextNum
        │           │   │       └── CaseInsensitive.php
        │           │   │   ├── Utf8.php
        │           │   │   ├── Utf8
        │           │   │       └── CaseInsensitive.php
        │           │   │   ├── Utf8Num.php
        │           │   │   └── Utf8Num
        │           │   │       └── CaseInsensitive.php
        │           ├── Token.php
        │           ├── TokenFilter.php
        │           └── TokenFilter
        │           │   ├── LowerCase.php
        │           │   ├── LowerCaseUtf8.php
        │           │   ├── ShortWords.php
        │           │   └── StopWords.php
        │       ├── Document.php
        │       ├── Document
        │           ├── Docx.php
        │           ├── Exception.php
        │           ├── Html.php
        │           ├── OpenXml.php
        │           ├── Pptx.php
        │           └── Xlsx.php
        │       ├── Exception.php
        │       ├── FSM.php
        │       ├── FSMAction.php
        │       ├── Field.php
        │       ├── Index
        │           ├── DictionaryLoader.php
        │           ├── DocsFilter.php
        │           ├── FieldInfo.php
        │           ├── SegmentInfo.php
        │           ├── SegmentMerger.php
        │           ├── SegmentWriter.php
        │           ├── SegmentWriter
        │           │   ├── DocumentWriter.php
        │           │   └── StreamWriter.php
        │           ├── Term.php
        │           ├── TermInfo.php
        │           ├── TermsPriorityQueue.php
        │           ├── TermsStream
        │           │   └── Interface.php
        │           └── Writer.php
        │       ├── Interface.php
        │       ├── LockManager.php
        │       ├── MultiSearcher.php
        │       ├── PriorityQueue.php
        │       ├── Proxy.php
        │       ├── Search
        │           ├── BooleanExpressionRecognizer.php
        │           ├── Highlighter
        │           │   ├── Default.php
        │           │   └── Interface.php
        │           ├── Query.php
        │           ├── Query
        │           │   ├── Boolean.php
        │           │   ├── Empty.php
        │           │   ├── Fuzzy.php
        │           │   ├── Insignificant.php
        │           │   ├── MultiTerm.php
        │           │   ├── Phrase.php
        │           │   ├── Preprocessing.php
        │           │   ├── Preprocessing
        │           │   │   ├── Fuzzy.php
        │           │   │   ├── Phrase.php
        │           │   │   └── Term.php
        │           │   ├── Range.php
        │           │   ├── Term.php
        │           │   └── Wildcard.php
        │           ├── QueryEntry.php
        │           ├── QueryEntry
        │           │   ├── Phrase.php
        │           │   ├── Subquery.php
        │           │   └── Term.php
        │           ├── QueryHit.php
        │           ├── QueryLexer.php
        │           ├── QueryParser.php
        │           ├── QueryParserContext.php
        │           ├── QueryParserException.php
        │           ├── QueryToken.php
        │           ├── Similarity.php
        │           ├── Similarity
        │           │   └── Default.php
        │           ├── Weight.php
        │           └── Weight
        │           │   ├── Boolean.php
        │           │   ├── Empty.php
        │           │   ├── MultiTerm.php
        │           │   ├── Phrase.php
        │           │   └── Term.php
        │       ├── Storage
        │           ├── Directory.php
        │           ├── Directory
        │           │   └── Filesystem.php
        │           ├── File.php
        │           └── File
        │           │   ├── Filesystem.php
        │           │   └── Memory.php
        │       └── TermStreamsPriorityQueue.php
    ├── _manifest_exclude
    └── highlight
        ├── CHANGES.md
        ├── LICENSE
        ├── README.md
        ├── README.ru.md
        └── highlight.pack.js


/.editorconfig:
--------------------------------------------------------------------------------
 1 | # For more information about the properties used in this file,
 2 | # please see the EditorConfig documentation:
 3 | # http://editorconfig.org
 4 | 
 5 | [*]
 6 | charset = utf-8
 7 | end_of_line = lf
 8 | indent_size = 4
 9 | indent_style = space
10 | insert_final_newline = true
11 | trim_trailing_whitespace = true
12 | 
13 | [{*.yml,package.json}]
14 | indent_size = 2
15 | 
16 | # The indent size used in the package.json file cannot be changed:
17 | # https://github.com/npm/npm/pull/3180#issuecomment-16336516
18 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Documentation Viewer Module
 2 | 
 3 | ## ABANDONED
 4 | 
 5 | This package is abandoned. See [silverstripe/doc.silverstripe.org](https://github.com/silverstripe/doc.silverstripe.org) instead.
 6 | 
 7 | [![Build Status](https://secure.travis-ci.org/silverstripe/silverstripe-docsviewer.png?branch=master)](http://travis-ci.org/silverstripe/silverstripe-docsviewer)
 8 | 
 9 | ## Maintainer Contact
10 | 
11 | * Will Rossiter (Nickname: willr, wrossiter)
12 |  <will@fullscreen.io>
13 | 
14 | ## Requirements
15 | 
16 | These are pulled in via Composer.
17 | 
18 | * SilverStripe 3.1
19 | * [Parsedown](http://parsedown.org/) and Parsedown Extra.
20 | 
21 | ## Summary
22 | 
23 | Reads markdown files from a given list of folders from your installation and
24 | provides a web interface for viewing the documentation. Ideal for providing
25 | documentation alongside your module or project code.
26 | 
27 | A variation of this module powers the main SilverStripe developer documentation
28 | and the user help websites.
29 | 
30 | For more documentation on how to use the module please read /docs/Writing-Documentation.md
31 | (or via this in /dev/docs/docsviewer/Writing-Documentation in your webbrowser)
32 | 
33 | ## Installation
34 | 
35 | 	composer require "silverstripe/docsviewer" "dev-master"
36 | 
37 | ## Usage
38 | 
39 | After installing the files via composer, rebuild the SilverStripe database..
40 | 
41 | 	sake dev/build
42 | 
43 | Then start by viewing the documentation at `yoursite.com/dev/docs`.
44 | 
45 | If something isn't working, you can run the dev task at `yoursite.com/dev/tasks/CheckDocsSourcesTask`
46 | to automatically check for configuration or source file errors.
47 | 
48 | Out of the box the module will display the documentation files that have been
49 | bundled into any of your installed modules. To configure what is shown in the
50 | documentation viewer see the detailed [documentation](docs/en/configuration.md).
51 | 
52 | For more information about how to use the module see each of the documentation
53 | 
54 | 	* [Configuration](docs/en/configuration.md)
55 | 	* [Markdown Syntax](docs/en/markdown.md)
56 | 	* [Syntax Highlighting](docs/en/syntax-highlighting.md)
57 | 	* [Publishing Static Files](docs/en/statichtml.md)
58 | 
59 | ## License
60 | 
61 | See LICENSE
62 | 


--------------------------------------------------------------------------------
/_config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Documentation Configuration
 4 |  *
 5 |  * Please override any of these options in your own projects _config.php file.
 6 |  * For more information and documentation see docsviewer/docs/en
 7 |  */
 8 | 
 9 | if(!defined('DOCSVIEWER_PATH')) {
10 |     define('DOCSVIEWER_PATH', dirname(__FILE__));
11 | }
12 | 
13 | if(!defined('DOCSVIEWER_DIR')) {
14 |     $dir = explode(DIRECTORY_SEPARATOR, DOCSVIEWER_PATH);
15 | 
16 |     define('DOCSVIEWER_DIR', array_pop($dir));
17 | }
18 | 


--------------------------------------------------------------------------------
/_config/docsviewer.yml:
--------------------------------------------------------------------------------
1 | ---
2 | name: docsviewer
3 | ---
4 | DocumentationViewer:
5 |   google_analytics_code: ''
6 | DocumentationManifest:
7 |   automatic_registration: true
8 | 
9 | 


--------------------------------------------------------------------------------
/_config/routes.yml:
--------------------------------------------------------------------------------
1 | ---
2 | Name: docs
3 | After: framework/routes#coreroutes
4 | ---
5 | Director:
6 |   rules:
7 |     'dev/docs//$Action/$ID/$OtherID': 'DocumentationViewer'
8 |     'DocumentationOpenSearchController//$Action': 'DocumentationOpenSearchController'
9 | 


--------------------------------------------------------------------------------
/code-of-conduct.md:
--------------------------------------------------------------------------------
1 | When having discussions about this module in issues or pull request please adhere to the [SilverStripe Community Code of Conduct](https://docs.silverstripe.org/en/contributing/code_of_conduct).
2 | 


--------------------------------------------------------------------------------
/code/DocumentationHelper.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * Collection of static helper methods for managing the documentation
  5 |  *
  6 |  * @package docsviewer
  7 |  */
  8 | class DocumentationHelper
  9 | {
 10 |     /**
 11 |      * String helper for cleaning a file name to a readable version.
 12 |      *
 13 |      * @param string $name to convert
 14 |      *
 15 |      * @return string $name output
 16 |      */
 17 |     public static function clean_page_name($name)
 18 |     {
 19 |         $name = self::trim_extension_off($name);
 20 |         $name = self::trim_sort_number($name);
 21 | 
 22 |         $name = str_replace(array('-', '_'), ' ', $name);
 23 | 
 24 |         return ucfirst(trim($name));
 25 |     }
 26 | 
 27 |     /**
 28 |      * String helper for cleaning a file name to a URL safe version.
 29 |      *
 30 |      * @param string $name to convert
 31 |      *
 32 |      * @return string $name output
 33 |      */
 34 |     public static function clean_page_url($name)
 35 |     {
 36 |         $name = str_replace(array(' '), '_', $name);
 37 | 
 38 |         $name = self::trim_extension_off($name);
 39 |         $name = self::trim_sort_number($name);
 40 | 
 41 |         if (preg_match('/^[\/]?index[\/]?/', $name)) {
 42 |             return '';
 43 |         }
 44 | 
 45 |         return strtolower($name);
 46 |     }
 47 | 
 48 |     /**
 49 |      * Removes leading numbers from pages (used to control sort order).
 50 |      *
 51 |      * @param string
 52 |      *
 53 |      * @return string
 54 |      */
 55 |     public static function trim_sort_number($name)
 56 |     {
 57 |         $name = preg_replace("/^[0-9]*[_-]+/", '', $name);
 58 | 
 59 |         return $name;
 60 |     }
 61 |         
 62 | 
 63 |     /**
 64 |      * Helper function to strip the extension off and return the name without
 65 |      * the extension.
 66 |      *
 67 |      * @param string
 68 |      *
 69 |      * @return string
 70 |      */
 71 |     public static function trim_extension_off($name)
 72 |     {
 73 |         if (strrpos($name, '.') !== false) {
 74 |             return substr($name, 0, strrpos($name, '.'));
 75 |         }
 76 |         
 77 |         return $name;
 78 |     }
 79 | 
 80 |     /**
 81 |      * Helper function to get the extension of the filename.
 82 |      *
 83 |      * @param string
 84 |      *
 85 |      * @return string
 86 |      */
 87 |     public static function get_extension($name)
 88 |     {
 89 |         if (preg_match('/\.[a-z]+$/', $name)) {
 90 |             return substr($name, strrpos($name, '.') + 1);
 91 |         }
 92 | 
 93 |         return null;
 94 |     }
 95 | 
 96 |     /**
 97 |      * Helper function to normalize paths to unix style directory separators
 98 |      *
 99 |      * @param string
100 |      *
101 |      * @return string
102 |      */
103 |     public static function normalizePath($path)
104 |     {
105 |         if (DIRECTORY_SEPARATOR != '/') {
106 |             return str_replace(DIRECTORY_SEPARATOR, '/', $path);
107 |         }
108 |         
109 |         return $path;
110 |     }
111 | 
112 |     /**
113 |      * Helper function to make normalized paths relative
114 |      *
115 |      * @param string
116 |      *
117 |      * @return string
118 |      */
119 |     public static function relativePath($path)
120 |     {
121 |         $base = self::normalizePath(Director::baseFolder());
122 |         
123 |         return substr($path, strlen($base));
124 |     }
125 | }
126 | 


--------------------------------------------------------------------------------
/code/DocumentationManifestFileFinder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | class DocumentationManifestFileFinder extends SS_FileFinder
 4 | {
 5 |     /**
 6 |      * @var array
 7 |      */
 8 |     private static $ignored_files = array(
 9 |         '.', '..', '.ds_store',
10 |         '.svn', '.git', 'assets', 'themes', '_images'
11 |     );
12 | 
13 |     /**
14 |      * @var array
15 |      */
16 |     protected static $default_options = array(
17 |         'name_regex'           => '/\.(md|markdown)$/i',
18 |         'file_callback'        => null,
19 |         'dir_callback'         => null,
20 |         'ignore_vcs'           => true
21 |     );
22 | 
23 |     /**
24 |      *
25 |      */
26 |     public function acceptDir($basename, $pathname, $depth)
27 |     {
28 |         $ignored =  Config::inst()->get('DocumentationManifestFileFinder', 'ignored_files');
29 | 
30 |         if ($ignored) {
31 |             if (in_array(strtolower($basename), $ignored)) {
32 |                 return false;
33 |             }
34 |         }
35 | 
36 |         return true;
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/code/DocumentationPermalinks.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * A mapping store of given permalinks to the full documentation path or useful
 5 |  * for customizing the shortcut URLs used in the viewer.
 6 |  *
 7 |  * Redirects the user from example.com/foo to example.com/en/module/foo
 8 |  *
 9 |  * @package docsviewer
10 |  */
11 | 
12 | class DocumentationPermalinks
13 | {
14 |     /**
15 |      * @var array
16 |      */
17 |     private static $mapping = array();
18 |     
19 |     /**
20 |      * Add a mapping of nice short permalinks to a full long path
21 |      *
22 |      * <code>
23 |      * DocumentationPermalinks::add(array(
24 |      *     'debugging' => 'current/en/sapphire/topics/debugging'
25 |      * ));
26 |      * </code>
27 |      *
28 |      * Do not need to include the language or the version current as it
29 |      * will add it based off the language or version in the session
30 |      *
31 |      * @param array
32 |      */
33 |     public static function add($map = array())
34 |     {
35 |         if (ArrayLib::is_associative($map)) {
36 |             self::$mapping = array_merge(self::$mapping, $map);
37 |         } else {
38 |             user_error("DocumentationPermalinks::add() requires an associative array", E_USER_ERROR);
39 |         }
40 |     }
41 |     
42 |     /**
43 |      * Return the location for a given short value.
44 |      *
45 |      * @return string|false
46 |      */
47 |     public static function map($url)
48 |     {
49 |         return (isset(self::$mapping[$url])) ? self::$mapping[$url] : false;
50 |     }
51 | }
52 | 


--------------------------------------------------------------------------------
/code/controllers/DocumentationOpenSearchController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Public facing controller for handling an opensearch interface based on
 5 |  * the standard search form.
 6 |  *
 7 |  * @package docsviewer
 8 |  */
 9 | 
10 | class DocumentationOpenSearchController extends Controller
11 | {
12 |     private static $allowed_actions = array(
13 |         'description'
14 |     );
15 |     
16 |     public function index()
17 |     {
18 |         return $this->httpError(404);
19 |     }
20 |     
21 |     public function description()
22 |     {
23 |         $viewer = new DocumentationViewer();
24 |         
25 |         if (!$viewer->canView()) {
26 |             return Security::permissionFailure($this);
27 |         }
28 | 
29 |         if (!Config::inst()->get('DocumentationSearch', 'enabled')) {
30 |             return $this->httpError('404');
31 |         }
32 |         
33 |         $data = DocumentationSearch::get_meta_data();
34 |         $link = Director::absoluteBaseUrl() .
35 |         $data['SearchPageLink'] = Controller::join_links(
36 |             $viewer->Link(),
37 |             'results/?Search={searchTerms}&start={startIndex}&length={count}&action_results=1'
38 |         );
39 |         
40 |         $data['SearchPageAtom'] = $data['SearchPageLink'] . '&format=atom';
41 |         
42 |         return $this->customise(
43 |             new ArrayData($data)
44 |         )->renderWith(
45 |             array(
46 |             'OpenSearchDescription'
47 |             )
48 |         );
49 |     }
50 | }
51 | 


--------------------------------------------------------------------------------
/code/extensions/DocumentationSearchExtension.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | class DocumentationSearchExtension extends Extension
 4 | {
 5 |     /**
 6 |      * Return an array of folders and titles
 7 |      *
 8 |      * @return array
 9 |      */
10 |     public function getSearchedEntities()
11 |     {
12 |         $entities = array();
13 | 
14 |         if (!empty($_REQUEST['Entities'])) {
15 |             if (is_array($_REQUEST['Entities'])) {
16 |                 $entities = Convert::raw2att($_REQUEST['Entities']);
17 |             } else {
18 |                 $entities = explode(',', Convert::raw2att($_REQUEST['Entities']));
19 |                 $entities = array_combine($entities, $entities);
20 |             }
21 |         }
22 |         
23 |         return $entities;
24 |     }
25 |     
26 |     /**
27 |      * Return an array of versions that we're allowed to return
28 |      *
29 |      * @return array
30 |      */
31 |     public function getSearchedVersions()
32 |     {
33 |         $versions = array();
34 |         
35 |         if (!empty($_REQUEST['Versions'])) {
36 |             if (is_array($_REQUEST['Versions'])) {
37 |                 $versions = Convert::raw2att($_REQUEST['Versions']);
38 |                 $versions = array_combine($versions, $versions);
39 |             } else {
40 |                 $version = Convert::raw2att($_REQUEST['Versions']);
41 |                 $versions[$version] = $version;
42 |             }
43 |         }
44 | 
45 |         return $versions;
46 |     }
47 |     
48 |     /**
49 |      * Return the current search query.
50 |      *
51 |      * @return HTMLText|null
52 |      */
53 |     public function getSearchQuery()
54 |     {
55 |         if (isset($_REQUEST['Search'])) {
56 |             return DBField::create_field('HTMLText', $_REQUEST['Search']);
57 |         } elseif (isset($_REQUEST['q'])) {
58 |             return DBField::create_field('HTMLText', $_REQUEST['q']);
59 |         }
60 |     }
61 | 
62 |     /**
63 |      * Past straight to results, display and encode the query.
64 |      */
65 |     public function getSearchResults()
66 |     {
67 |         $query = $this->getSearchQuery();
68 | 
69 |         $search = new DocumentationSearch();
70 |         $search->setQuery($query);
71 |         $search->setVersions($this->getSearchedVersions());
72 |         $search->setModules($this->getSearchedEntities());
73 |         $search->setOutputController($this->owner);
74 |         
75 |         return $search->renderResults();
76 |     }
77 |     
78 |     /**
79 |      * Returns an search form which allows people to express more complex rules
80 |      * and options than the plain search form.
81 |      *
82 |      * @return Form
83 |      */
84 |     public function AdvancedSearchForm()
85 |     {
86 |         return new DocumentationAdvancedSearchForm($this->owner);
87 |     }
88 | 
89 |     /**
90 |      * @return bool
91 |      */
92 |     public function getAdvancedSearchEnabled()
93 |     {
94 |         return Config::inst()->get("DocumentationSearch", 'advanced_search_enabled');
95 |     }
96 | }
97 | 


--------------------------------------------------------------------------------
/code/extensions/DocumentationStaticPublisherExtension.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * An extension to StaticPublisher to enable exporting the documentation pages
 5 |  * as HTML files to the server.
 6 |  *
 7 |  * If you want to add exporting functionality then install the static publisher
 8 |  * module and set the following configuration in your applications config.yml:
 9 |  *
10 |  * <code>
11 |  * StaticExporter:
12 |  *   extensions:
13 |  *     - DocumentationStaticPublisherExtension
14 |  * </code>
15 |  *
16 |  * If you don't plan on using static publisher for anything else and you have
17 |  * the cms module installed, make sure you disable that from being published.
18 |  *
19 |  * Again, in your applications config.yml file
20 |  *
21 |  * <code>
22 |  * StaticExporter:
23 |  *   disable_sitetree_export: true
24 |  * </code>
25 |  *
26 |  * @package docsviewer
27 |  */
28 | class DocumentationStaticPublisherExtension extends Extension
29 | {
30 |     public function alterExportUrls(&$urls)
31 |     {
32 |         $manifest = new DocumentationManifest(true);
33 | 
34 |         foreach ($manifest->getPages() as $url => $page) {
35 |             $urls[$url] = $url;
36 |         }
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/code/extensions/DocumentationViewerVersionWarning.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package docsviewer
 4 |  */
 5 | class DocumentationViewerVersionWarning extends Extension
 6 | {
 7 |     /**
 8 |      * Check to see if the currently accessed version is out of date or perhaps a
 9 |      * future version rather than the stable edition.
10 |      *
11 |      * @return false|ArrayData
12 |      */
13 |     public function VersionWarning()
14 |     {
15 |         $page = $this->owner->getPage();
16 | 
17 |         if (!$page) {
18 |             return false;
19 |         }
20 | 
21 |         $entity = $page->getEntity();
22 | 
23 |         if (!$entity) {
24 |             return false;
25 |         }
26 | 
27 |         $versions = $this->owner->getManifest()->getAllVersionsOfEntity($entity);
28 | 
29 |         if ($entity->getIsStable()) {
30 |             return false;
31 |         }
32 | 
33 |         $stable = $this->owner->getManifest()->getStableVersion($entity);
34 |         $compare = $entity->compare($stable);
35 | 
36 |         if ($entity->getVersion() == 'master' || $compare > 0) {
37 |             return $this->owner->customise(
38 |                 new ArrayData(
39 |                     array(
40 |                         'FutureRelease' => true,
41 |                         'StableVersion' => DBField::create_field('HTMLText', $stable->getVersion())
42 |                     )
43 |                 )
44 |             );
45 |         } else {
46 |             return $this->owner->customise(
47 |                 new ArrayData(
48 |                     array(
49 |                         'OutdatedRelease' => true,
50 |                         'StableVersion'   => DBField::create_field('HTMLText', $stable->getVersion())
51 |                     )
52 |                 )
53 |             );
54 |         }
55 | 
56 |         return false;
57 |     }
58 | }
59 | 


--------------------------------------------------------------------------------
/code/forms/DocumentationAdvancedSearchForm.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * @package docsviewer
 5 |  */
 6 | class DocumentationAdvancedSearchForm extends Form
 7 | {
 8 |     public function __construct($controller)
 9 |     {
10 |         $versions = $controller->getManifest()->getAllVersions();
11 |         $entities = $controller->getManifest()->getEntities();
12 | 
13 |         $q = ($q = $controller->getSearchQuery()) ? $q->NoHTML() : "";
14 | 
15 |         // klude to take an array of objects down to a simple map
16 |         $entities = $entities->map('Key', 'Title');
17 | 
18 |         // if we haven't gone any search limit then we're searching everything
19 |         $searchedEntities = $controller->getSearchedEntities();
20 | 
21 |         if (count($searchedEntities) < 1) {
22 |             $searchedEntities = $entities;
23 |         }
24 |         
25 |         $searchedVersions = $controller->getSearchedVersions();
26 |         
27 |         if (count($searchedVersions) < 1) {
28 |             $searchedVersions = $versions;
29 |         }
30 | 
31 |         $fields = FieldList::create(
32 |             TextField::create('q', _t('DocumentationViewer.KEYWORDS', 'Keywords'), $q),
33 |             //CheckboxSetField::create('Entities', _t('DocumentationViewer.MODULES', 'Modules'), $entities, $searchedEntities),
34 |             CheckboxSetField::create(
35 |                 'Versions',
36 |                 _t('DocumentationViewer.VERSIONS', 'Versions'),
37 |                 $versions,
38 |                 $searchedVersions
39 |             )
40 |         );
41 | 
42 |         $actions = FieldList::create(
43 |             FormAction::create('results', _t('DocumentationViewer.SEARCH', 'Search'))
44 |         );
45 |         
46 |         $required = RequiredFields::create(array('Search'));
47 |         
48 |         parent::__construct(
49 |             $controller,
50 |             'AdvancedSearchForm',
51 |             $fields,
52 |             $actions,
53 |             $required
54 |         );
55 |         
56 |         $this->disableSecurityToken();
57 |         $this->setFormMethod('GET');
58 |         $this->setFormAction($controller->Link('results'));
59 |     }
60 | }
61 | 


--------------------------------------------------------------------------------
/code/forms/DocumentationSearchForm.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | class DocumentationSearchForm extends Form
 4 | {
 5 |     public function __construct($controller)
 6 |     {
 7 |         $fields = new FieldList(
 8 |             TextField::create('q', _t('DocumentationViewer.SEARCH', 'Search'), '')
 9 |                 ->setAttribute('placeholder', _t('DocumentationViewer.SEARCH', 'Search'))
10 |         );
11 | 
12 |         $page = $controller->getPage();
13 | 
14 |         if ($page) {
15 |             $versions = HiddenField::create(
16 |                 'Versions',
17 |                 _t('DocumentationViewer.VERSIONS', 'Versions'),
18 |                 $page->getEntity()->getVersion()
19 |             );
20 | 
21 |             $fields->push($versions);
22 |         }
23 | 
24 |         $actions = new FieldList(
25 |             new FormAction('results', _t('DocumentationViewer.SEARCH', 'Search'))
26 |         );
27 | 
28 |         parent::__construct($controller, 'DocumentationSearchForm', $fields, $actions);
29 | 
30 |         $this->disableSecurityToken();
31 |         $this->setFormMethod('GET');
32 |         $this->setFormAction($controller->Link('results'));
33 | 
34 |         $this->addExtraClass('search');
35 |     }
36 | }
37 | 


--------------------------------------------------------------------------------
/code/models/DocumentationFolder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * A specific documentation folder within a {@link DocumentationEntity}.
 5 |  *
 6 |  * Maps to a folder on the file system.
 7 |  *
 8 |  * @package    docsviewer
 9 |  * @subpackage model
10 |  */
11 | class DocumentationFolder extends DocumentationPage
12 | {
13 |     /**
14 |      * @return string
15 |      */
16 |     public function getTitle()
17 |     {
18 |         return $this->getTitleFromFolder();
19 |     }
20 | }
21 | 


--------------------------------------------------------------------------------
/code/tasks/CheckDocsSourcesTask.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Check status of sources dirs
 5 |  */
 6 | class CheckDocsSourcesTask extends BuildTask
 7 | {
 8 | 
 9 |     protected $errors = 0;
10 | 
11 |     protected $description = "Check validity of all docs source files registered";
12 | 
13 |     public function start()
14 |     {
15 |         if (!Director::is_cli()) {
16 |             echo "<ul>";
17 |         }
18 |     }
19 | 
20 |     public function end()
21 |     {
22 |         if (Director::is_cli()) {
23 |             echo "\nTotal errors: {$this->errors}\n";
24 |         } else {
25 |             echo "</ul>";
26 |             echo "<p>Total errors: {$this->errors}</p>";
27 |         }
28 |     }
29 | 
30 |     public function showError($error)
31 |     {
32 |         $this->errors++;
33 |         if (Director::is_cli()) {
34 |             echo "\n$error";
35 |         } else {
36 |             echo "<li>" . Convert::raw2xml($error) . "</li>";
37 |         }
38 |     }
39 | 
40 |     /**
41 |      * Validate all source files
42 |      *
43 |      * @param  SS_HTTPRequest $request
44 |      * @throws Exception
45 |      */
46 |     public function run($request)
47 |     {
48 |         $this->start();
49 |         $registered = Config::inst()->get('DocumentationManifest', 'register_entities');
50 |         foreach ($registered as $details) {
51 |             // validate the details provided through the YAML configuration
52 |             $required = array('Path', 'Title');
53 | 
54 |             // Check required configs
55 |             foreach ($required as $require) {
56 |                 if (!isset($details[$require])) {
57 |                     $this->showError("$require is a required key in DocumentationManifest.register_entities");
58 |                 }
59 |             }
60 | 
61 |             // Check path is loaded
62 |             $path = $this->getRealPath($details['Path']);
63 |             if (!$path || !is_dir($path)) {
64 |                 $this->showError($details['Path'] . ' is not a valid documentation directory');
65 |             }
66 |         }
67 |         $this->end();
68 |     }
69 | 
70 |     public function getRealPath($path)
71 |     {
72 |         if (!Director::is_absolute($path)) {
73 |             $path = Controller::join_links(BASE_PATH, $path);
74 |         }
75 | 
76 |         return $path;
77 |     }
78 | }
79 | 


--------------------------------------------------------------------------------
/code/tasks/DocumentationBuild.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | class DocumentationBuild extends BuildTask
 4 | {
 5 |     public function run($request)
 6 |     {
 7 |         $manifest = new DocumentationManifest(true);
 8 |         echo "<pre>";
 9 |         print_r($manifest->getPages());
10 |         echo "</pre>";
11 |         die();
12 |         ;
13 |     }
14 | }
15 | 


--------------------------------------------------------------------------------
/code/tasks/RebuildLuceneDocsIndex.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * Rebuilds the search indexes for the documentation pages.
  5 |  *
  6 |  * For the hourly cron rebuild use RebuildLuceneDocusIndex_Hourly
  7 |  *
  8 |  * @package    docsviewer
  9 |  * @subpackage tasks
 10 |  */
 11 | 
 12 | class RebuildLuceneDocsIndex extends BuildTask
 13 | {
 14 |     protected $title = "Rebuild Documentation Search Indexes";
 15 |     
 16 |     protected $description = "
 17 | 		Rebuilds the indexes used for the search engine in the docsviewer.";
 18 |     
 19 |     public function run($request)
 20 |     {
 21 |         $this->rebuildIndexes();
 22 |     }
 23 |     
 24 |     public function rebuildIndexes($quiet = false)
 25 |     {
 26 |         include_once 'Zend/Search/Lucene.php';
 27 | 
 28 |         ini_set("memory_limit", -1);
 29 |         ini_set('max_execution_time', 0);
 30 | 
 31 |         Filesystem::makeFolder(DocumentationSearch::get_index_location());
 32 |     
 33 |         // only rebuild the index if we have to. Check for either flush or the time write.lock.file
 34 |         // was last altered
 35 |         $lock = DocumentationSearch::get_index_location() .'/write.lock.file';
 36 |         $lockFileFresh = (file_exists($lock) && filemtime($lock) > (time() - (60 * 60 * 24)));
 37 | 
 38 |         echo "Building index in ". DocumentationSearch::get_index_location() . PHP_EOL;
 39 | 
 40 |         if ($lockFileFresh && !isset($_REQUEST['flush'])) {
 41 |             if (!$quiet) {
 42 |                 echo "Index recently rebuilt. If you want to force reindex use ?flush=1";
 43 |             }
 44 |             
 45 |             return true;
 46 |         }
 47 | 
 48 |         try {
 49 |             $index = Zend_Search_Lucene::open(DocumentationSearch::get_index_location());
 50 |             $index->removeReference();
 51 |         } catch (Zend_Search_Lucene_Exception $e) {
 52 |             user_error($e);
 53 |         }
 54 | 
 55 |         try {
 56 |             $index = Zend_Search_Lucene::create(DocumentationSearch::get_index_location());
 57 |         } catch (Zend_Search_Lucene_Exception $c) {
 58 |             user_error($c);
 59 |         }
 60 | 
 61 |         // includes registration
 62 |         $manifest = new DocumentationManifest(true);
 63 |         $pages = $manifest->getPages();
 64 | 
 65 |         if ($pages) {
 66 |             $count = 0;
 67 |             
 68 |             // iconv complains about all the markdown formatting
 69 |             // turn off notices while we parse
 70 | 
 71 |             if (!Director::is_cli()) {
 72 |                 echo "<ul>";
 73 |             }
 74 |             foreach ($pages as $url => $record) {
 75 |                 $count++;
 76 |                 $page = $manifest->getPage($url);
 77 | 
 78 |                 $doc = new Zend_Search_Lucene_Document();
 79 |                 $error = error_reporting();
 80 |                 error_reporting(E_ALL ^ E_NOTICE);
 81 |                 $content = $page->getHTML();
 82 |                 error_reporting($error);
 83 | 
 84 |                 $doc->addField(Zend_Search_Lucene_Field::Text('content', $content));
 85 |                 $doc->addField($titleField = Zend_Search_Lucene_Field::Text('Title', $page->getTitle()));
 86 |                 $doc->addField($breadcrumbField = Zend_Search_Lucene_Field::Text('BreadcrumbTitle', $page->getBreadcrumbTitle()));
 87 | 
 88 |                 $doc->addField(
 89 |                     Zend_Search_Lucene_Field::Keyword(
 90 |                         'Version',
 91 |                         $page->getEntity()->getVersion()
 92 |                     )
 93 |                 );
 94 | 
 95 |                 $doc->addField(
 96 |                     Zend_Search_Lucene_Field::Keyword(
 97 |                         'Language',
 98 |                         $page->getEntity()->getLanguage()
 99 |                     )
100 |                 );
101 | 
102 |                 $doc->addField(
103 |                     Zend_Search_Lucene_Field::Keyword(
104 |                         'Entity',
105 |                         $page->getEntity()
106 |                     )
107 |                 );
108 | 
109 |                 $doc->addField(
110 |                     Zend_Search_Lucene_Field::Keyword(
111 |                         'Link',
112 |                         $page->Link()
113 |                     )
114 |                 );
115 |     
116 |                 // custom boosts
117 |                 $titleField->boost = 3;
118 |                 $breadcrumbField->boost = 1.5;
119 | 
120 |                 $boost = Config::inst()->get('DocumentationSearch', 'boost_by_path');
121 | 
122 |                 foreach ($boost as $pathExpr => $boost) {
123 |                     if (preg_match($pathExpr, $page->getRelativePath())) {
124 |                         $doc->boost = $boost;
125 |                     }
126 |                 }
127 |                 
128 |                 error_reporting(E_ALL ^ E_NOTICE);
129 |                 $index->addDocument($doc);
130 | 
131 |                 if (!$quiet) {
132 |                     if (Director::is_cli()) {
133 |                         echo " * adding ". $page->getPath() ."\n";
134 |                     } else {
135 |                         echo "<li>adding ". $page->getPath() ."</li>\n";
136 |                     }
137 |                 }
138 |             }
139 |         }
140 | 
141 |         $index->commit();
142 |         
143 |         if (!$quiet) {
144 |             echo "complete.";
145 |         }
146 |     }
147 | }
148 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "silverstripe/docsviewer",
 3 |     "description": "Documentation viewer module for SilverStripe",
 4 |     "type": "silverstripe-module",
 5 |     "keywords": ["silverstripe", "documentation"],
 6 |     "license": "BSD-3-Clause",
 7 |     "authors": [{
 8 |         "name": "Will Rossiter",
 9 |         "homepage": "http://wilr.github.io",
10 |         "email": "will@fullscreen.io"
11 |     }],
12 |     "support": {
13 |         "email": "will@fullscreen.io",
14 |         "irc": "irc://irc.freenode.org/silverstripe"
15 |     },
16 | 	"require": {
17 |         "silverstripe/framework": "~3.1",
18 |         "erusev/parsedown-extra": "~0.2",
19 |         "erusev/parsedown": "~1.1",
20 |         "mnapoli/front-yaml": "^1.5"
21 |     },
22 |     "suggest": {
23 |         "silverstripe/staticpublisher": "Allows publishing documentation as HTML"
24 |     },
25 |     "extra": {
26 |         "branch-alias": {
27 |             "dev-master": "3.x-dev"
28 |         }
29 |     },
30 |     "abandoned": true
31 | }
32 | 


--------------------------------------------------------------------------------
/css/forms.css:
--------------------------------------------------------------------------------
 1 | fieldset {
 2 |     border: none;
 3 |     margin: 0;
 4 |     padding: 0 0 5px 0;
 5 | }
 6 | 
 7 | #DocumentationAdvancedSearchForm_AdvancedSearchForm_q {
 8 |     width: 100%;
 9 |     font-size: 15px;
10 |     padding: 10px 10px;
11 | }
12 | 
13 | #DocumentationAdvancedSearchForm_AdvancedSearchForm #q {
14 |     width: 55%;
15 |     padding-right: 2%;
16 |     float: left;
17 | }
18 | 
19 | #DocumentationAdvancedSearchForm_AdvancedSearchForm #Entities {
20 |     width: 25%;
21 |     padding-right: 2%;
22 |     float: left;
23 | }
24 | 
25 | #DocumentationAdvancedSearchForm_AdvancedSearchForm #Versions {
26 |     width: auto;
27 |     float: left;
28 |     margin-top: 12px;
29 | }
30 | 
31 | .optionset ul {
32 |     margin: 0;
33 | }
34 | .optionset li {
35 |     list-style: none;
36 |     float: left;
37 |     padding-right: 12px; 
38 | }
39 | 


--------------------------------------------------------------------------------
/css/highlight.css:
--------------------------------------------------------------------------------
  1 | /*
  2 | 
  3 | github.com style (c) Vasily Polovnyov <vast@whiteants.net>
  4 | Customised for doc.silverstripe.org, see CUSTOM markers.
  5 | 
  6 | */
  7 | 
  8 | .hljs {
  9 |   display: block;
 10 |   overflow-x: auto;
 11 |   padding: 1.5em 1em;
 12 |   color: #444;
 13 |   background: #f3f6f6; /* CUSTOM */
 14 |   border-radius: 3px; /* CUSTOM */
 15 |   box-shadow: 0 1px 3px rgba(0,0,0,.15); /* CUSTOM */
 16 | }
 17 | 
 18 | .hljs-comment,
 19 | .hljs-quote {
 20 |   color: #717171;
 21 |   font-style: italic;
 22 | }
 23 | 
 24 | .hljs-keyword,
 25 | .hljs-selector-tag,
 26 | .hljs-subst {
 27 |   color: #444;
 28 |   font-weight: bold;
 29 | }
 30 | 
 31 | .hljs-number,
 32 | .hljs-literal,
 33 | .hljs-variable,
 34 | .hljs-template-variable,
 35 | .hljs-tag .hljs-attr {
 36 |   color: #007e7e;
 37 | }
 38 | 
 39 | .hljs-string,
 40 | .hljs-doctag {
 41 |   color: #ed135a;
 42 | }
 43 | 
 44 | .hljs-title,
 45 | .hljs-section,
 46 | .hljs-selector-id {
 47 |   color: #900;
 48 |   font-weight: bold;
 49 | }
 50 | 
 51 | .hljs-subst {
 52 |   font-weight: normal;
 53 | }
 54 | 
 55 | .hljs-type,
 56 | .hljs-class .hljs-title {
 57 |   color: #458;
 58 |   font-weight: bold;
 59 | }
 60 | 
 61 | .hljs-tag,
 62 | .hljs-name,
 63 | .hljs-attribute {
 64 |   color: #000080;
 65 |   font-weight: normal;
 66 | }
 67 | 
 68 | .hljs-regexp,
 69 | .hljs-link {
 70 |   color: #008500;
 71 | }
 72 | 
 73 | .hljs-symbol,
 74 | .hljs-bullet {
 75 |   color: #990073;
 76 | }
 77 | 
 78 | .hljs-built_in,
 79 | .hljs-builtin-name {
 80 |   color: #0086b3;
 81 | }
 82 | 
 83 | .hljs-meta {
 84 |   color: #999;
 85 |   font-weight: bold;
 86 | }
 87 | 
 88 | .hljs-deletion {
 89 |   background: #fdd;
 90 | }
 91 | 
 92 | .hljs-addition {
 93 |   background: #dfd;
 94 | }
 95 | 
 96 | .hljs-emphasis {
 97 |   font-style: italic;
 98 | }
 99 | 
100 | .hljs-strong {
101 |   font-weight: bold;
102 | }
103 | 


--------------------------------------------------------------------------------
/css/small.css:
--------------------------------------------------------------------------------
 1 | @media screen and (max-width: 540px) {
 2 |     #content-column {
 3 |         width: 100%;
 4 |         padding: 0;
 5 |     }
 6 | 
 7 |     #container {
 8 |         padding: 15px;
 9 |     }
10 | 
11 |     #sidebar-column {
12 |         width: 100%;
13 |     }
14 | 
15 |     #sidebar-column .sidebar-box {
16 |         padding: 10px;
17 |     }
18 | 
19 |     #footer {
20 |         padding: 20px;
21 |     }
22 | 
23 |     .pinned { position: absolute; left: 0; top: 0; background: #fff; width: 35%; overflow: hidden; overflow-x: scroll; border-right: 1px solid #ccc; border-left: 1px solid #ccc; }
24 |     .pinned table { border-right: none; border-left: none; width: 100%; }
25 |     .pinned table th, .pinned table td { white-space: nowrap; }
26 |     .pinned td:last-child { border-bottom: 0; }
27 |     
28 |     div.table-wrapper { position: relative; margin-bottom: 20px; overflow: hidden; border-right: 1px solid #ccc; }
29 |     div.table-wrapper div.scrollable table { margin-left: 35%; }
30 |     div.table-wrapper div.scrollable { overflow: scroll; overflow-y: hidden; }    
31 |     
32 |     table td, table th { position: relative; white-space: nowrap; overflow: hidden; }
33 |     table th:first-child, table td:first-child, table td:first-child, .pinned table td { display: none; }
34 |     .pinned table td:first-child,
35 |     .pinned table th:first-child { display: block; }
36 | }


--------------------------------------------------------------------------------
/css/utilities.css:
--------------------------------------------------------------------------------
 1 | .clear { 
 2 |     clear: both;
 3 |     display: block;
 4 |     overflow: hidden;
 5 |     visibility: hidden;
 6 |     width: 0;
 7 |     height: 0;
 8 | }
 9 | 
10 | .clearfix:after {
11 |     clear: both;
12 |     content:' ';
13 |     display: block;
14 |     font-size: 0;
15 |     line-height: 0;
16 |     visibility: hidden;
17 |     width: 0;
18 |     height: 0
19 | }
20 | 
21 | * html .clearfix,
22 | *:first-child+html .clearfix{
23 |     zoom: 1;
24 | }


--------------------------------------------------------------------------------
/images/bullet.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/bullet.gif


--------------------------------------------------------------------------------
/images/error_button.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/error_button.png


--------------------------------------------------------------------------------
/images/external_link.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/external_link.png


--------------------------------------------------------------------------------
/images/ico_close_off.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/ico_close_off.png


--------------------------------------------------------------------------------
/images/icons/application.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/icons/application.png


--------------------------------------------------------------------------------
/images/icons/page_excel.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/icons/page_excel.png


--------------------------------------------------------------------------------
/images/icons/page_white_acrobat.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/icons/page_white_acrobat.png


--------------------------------------------------------------------------------
/images/icons/page_white_zip.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/icons/page_white_zip.png


--------------------------------------------------------------------------------
/images/icons/page_word.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/icons/page_word.png


--------------------------------------------------------------------------------
/images/info_button.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/info_button.png


--------------------------------------------------------------------------------
/images/lightbulb.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/lightbulb.png


--------------------------------------------------------------------------------
/images/logo.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/logo.jpg


--------------------------------------------------------------------------------
/images/menu.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/menu.png


--------------------------------------------------------------------------------
/images/note.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/note.gif


--------------------------------------------------------------------------------
/images/notification.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/notification.png


--------------------------------------------------------------------------------
/images/quote.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/quote.gif


--------------------------------------------------------------------------------
/images/readme.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/readme.png


--------------------------------------------------------------------------------
/images/search.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/search.png


--------------------------------------------------------------------------------
/images/warning.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/images/warning.png


--------------------------------------------------------------------------------
/lang/_manifest_exclude:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/lang/_manifest_exclude


--------------------------------------------------------------------------------
/lang/en.yml:
--------------------------------------------------------------------------------
 1 | en:
 2 |   DocumentationSearch:
 3 |     SEARCH: Search
 4 |     SEARCHRESULTS: 'Search Results'
 5 |   DocumentationViewer:
 6 |     CHANGE: Change
 7 |     KEYWORDS: Keywords
 8 |     LANGUAGE: Language
 9 |     MENU: Menu
10 |     MODULES: Modules
11 |     OPENSEARCHDESC: 'Search the documentation'
12 |     OPENSEARCHNAME: 'Documentation Search'
13 |     OPENSEARCHTAGS: documentation
14 |     SEARCH: Search
15 |     VERSIONS: Versions
16 |   DocumentationViewer_home.ss:
17 |     DOCUMENTEDMODULES: 'Documented Modules'
18 |     NOMODULEDOCUMENTATION: 'No modules with documentation installed could be found.'
19 |   DocumentationViewer_results.ss:
20 |     ADVANCEDSEARCH: 'Advanced Search'
21 | 


--------------------------------------------------------------------------------
/lang/en_US.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | global $lang;
 4 | 
 5 | $lang['en_US']['DocumentationSearch']['SEARCHRESULTS'] = 'Search Results';
 6 | $lang['en_US']['DocumentationViewer']['CHANGE'] = 'Change';
 7 | $lang['en_US']['DocumentationViewer']['LANGUAGE'] = 'Language';
 8 | $lang['en_US']['DocumentationViewer']['SEARCH'] = 'Search';
 9 | 
10 | ?>


--------------------------------------------------------------------------------
/lang/hr.yml:
--------------------------------------------------------------------------------
 1 | hr:
 2 |   DocumentationSearch:
 3 |     SEARCH: Traži
 4 |     SEARCHRESULTS: 'Rezultati pretraživanja'
 5 |   DocumentationViewer:
 6 |     CHANGE: Promjeni
 7 |     KEYWORDS: Ključne riječi
 8 |     LANGUAGE: Jezik
 9 |     MODULES: Moduli
10 |     OPENSEARCHDESC: 'Pretraži dokumentaciju'
11 |     OPENSEARCHNAME: 'Pretraga dokumentacije'
12 |     OPENSEARCHTAGS: dokumentacija
13 |     SEARCH: Traži
14 |     VERSIONS: Verzije
15 |   DocumentationViewer_home.ss:
16 |     DOCUMENTEDMODULES: 'Dokumentirani moduli'
17 |     NOMODULEDOCUMENTATION: 'Moduli s instaliranom dokumentacijom nisu pronađeni.'
18 |   DocumentationViewer_results.ss:
19 |     ADVANCEDSEARCH: 'Napredno pretraživanje'
20 | 


--------------------------------------------------------------------------------
/lang/hr_HR.yml:
--------------------------------------------------------------------------------
 1 | hr_HR:
 2 |   DocumentationSearch:
 3 |     SEARCH: Traži
 4 |     SEARCHRESULTS: 'Rezultati pretraživanja'
 5 |   DocumentationViewer:
 6 |     CHANGE: Promjeni
 7 |     KEYWORDS: Ključne riječi
 8 |     LANGUAGE: Jezik
 9 |     MODULES: Moduli
10 |     OPENSEARCHDESC: 'Pretraži dokumentaciju'
11 |     OPENSEARCHNAME: 'Pretraga dokumentacije'
12 |     OPENSEARCHTAGS: dokumentacija
13 |     SEARCH: Traži
14 |     VERSIONS: Verzije
15 |   DocumentationViewer_home.ss:
16 |     DOCUMENTEDMODULES: 'Dokumentirani moduli'
17 |     NOMODULEDOCUMENTATION: 'Moduli s instaliranom dokumentacijom nisu pronađeni.'
18 |   DocumentationViewer_results.ss:
19 |     ADVANCEDSEARCH: 'Napredno pretraživanje'
20 | 


--------------------------------------------------------------------------------
/license.md:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2016, SilverStripe Limited
 2 | All rights reserved.
 3 | 
 4 | Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 5 | 
 6 | 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 7 | 
 8 | 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 9 | 
10 | 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
11 | 
12 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
13 | 


--------------------------------------------------------------------------------
/templates/DocumentationPages.ss:
--------------------------------------------------------------------------------
 1 | <% if Children %>
 2 | <div class="documentation_children">
 3 | 	<ul>
 4 | 		<% loop Children %>
 5 | 			<li>
 6 | 				<h3><a href="$Link">$Title</a></h3>
 7 | 				<% if Summary %><p>$Summary</p><% end_if %>
 8 | 			</li>
 9 | 		<% end_loop %>
10 | 	</ul>
11 | </div>
12 | <% end_if %>


--------------------------------------------------------------------------------
/templates/DocumentationViewer.ss:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | 
 3 | <html>
 4 | 	<% include DocumentationHead %>
 5 | 
 6 | 	<div id="masthead" <% if Versions %>class="has_versions"<% end_if %>>
 7 | 		<div class="wrapper">
 8 | 			<div class="menu-bar">
 9 | 				<a class="logo" href="https://userhelp.silverstripe.org/"></a>
10 | 				<a class="menu-open">
11 | 					<%t DocumentationViewer.MENU "Menu" %>
12 | 				</a>
13 | 			</div>
14 | 
15 | 			<% if Breadcrumbs.count > 1 %>
16 | 				<% include DocumentationBreadcrumbs %>
17 | 			<% else_if Page.Title %>
18 | 				<h1>$Page.Title</h1>
19 | 			<% end_if %>
20 | 			<% if Page.Introduction %>
21 | 				<div class="introduction">
22 | 					<p>$Page.Introduction</p>
23 | 				</div>
24 | 			<% end_if %>
25 | 
26 | 			<% include DocumentationVersions %>
27 | 		</div>
28 | 	</div>
29 | 
30 | 	<div class="wrapper">
31 | 		<div id="layout" class="clearfix">
32 | 
33 | 			<% include DocumentationSidebar %>
34 | 
35 | 			<div id="content">
36 | 				$Layout
37 | 
38 | 				<% include DocumentationFooter %>
39 | 			</div>
40 | 		</div>
41 | 	</div>
42 | 
43 | 
44 | 	<% include DocumentationGA %>
45 | 	<% include DocumentationEnd %>
46 | </html>
47 | 


--------------------------------------------------------------------------------
/templates/DocumentationViewer_all.ss:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | 
 3 | <html>
 4 | 	<% include DocumentationHead %>
 5 | 
 6 | 	<div id="masthead" <% if Versions %>class="has_versions"<% end_if %>>
 7 | 		<div class="wrapper">
 8 | 
 9 | 			<div class="doc-breadcrumbs">
10 | 				<p>
11 | 					<a class="breadcrumb" href="$BaseHref">Documentation</a>
12 | 					<span>/</span>
13 | 					<a class="breadcrumb current">Index</a>
14 | 				</p>
15 | 			</div>
16 | 
17 | 
18 | 
19 | 		</div>
20 | 	</div>
21 | 
22 | 	<div class="wrapper">
23 | 		<div id="layout" class="clearfix">
24 | 
25 | 				$Layout
26 | 
27 | 				<% include DocumentationFooter %>
28 | 
29 | 		</div>
30 | 	</div>
31 | 
32 | 
33 | 	<% include DocumentationGA %>
34 | 	<% include DocumentationEnd %>
35 | </html>
36 | 


--------------------------------------------------------------------------------
/templates/DocumentationViewer_results.ss:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | 
 3 | <html>
 4 | 	<% include DocumentationHead %>
 5 | 
 6 | 	<div id="masthead" <% if Versions %>class="has_versions"<% end_if %>>
 7 | 		<div class="wrapper">
 8 | 
 9 | 			<div class="doc-breadcrumbs">
10 | 				<p>
11 | 					<a class="breadcrumb" href="$BaseHref">Documentation</a>
12 | 					<span>/</span>
13 | 					<a class="breadcrumb current">Search</a>
14 | 				</p>
15 | 			</div>
16 | 
17 | 
18 | 
19 | 		</div>
20 | 	</div>
21 | 
22 | 	<div class="wrapper">
23 | 		<div id="layout" class="clearfix">
24 | 
25 | 				$Layout
26 | 
27 | 				<% include DocumentationFooter %>
28 | 
29 | 		</div>
30 | 	</div>
31 | 
32 | 
33 | 	<% include DocumentationGA %>
34 | 	<% include DocumentationEnd %>
35 | </html>
36 | 


--------------------------------------------------------------------------------
/templates/Includes/DocumentationBreadcrumbs.ss:
--------------------------------------------------------------------------------
 1 | <div class="doc-breadcrumbs">
 2 | 	<p>
 3 | 		<% loop Breadcrumbs %>	
 4 | 			<% if not First %>
 5 | 				<a class="breadcrumb <% if Last %>current<% end_if %>" href="$Link">$Title</a> <% if Last %><% else %><span>/</span><% end_if %>
 6 | 			<% end_if %>
 7 | 		<% end_loop %>
 8 | 
 9 | 	</p>
10 | </div>
11 | 


--------------------------------------------------------------------------------
/templates/Includes/DocumentationComments.ss:
--------------------------------------------------------------------------------
1 | <!-- include this file in your theme with the Disqus Universal Code -->


--------------------------------------------------------------------------------
/templates/Includes/DocumentationEditLink.ss:
--------------------------------------------------------------------------------
1 | <div id="edit-link">
2 | 	<p>
3 | 		<a target="_blank" href="$EditLink">
4 | 			Edit this page <small>(requires github.com login)</small>
5 | 		</a>
6 | 	</p>
7 | </div>


--------------------------------------------------------------------------------
/templates/Includes/DocumentationEnd.ss:
--------------------------------------------------------------------------------
1 | </body>


--------------------------------------------------------------------------------
/templates/Includes/DocumentationFooter.ss:
--------------------------------------------------------------------------------
1 | <div id="footer">
2 | 	<p>Documentation powered by <a href="http://www.silverstripe.org">SilverStripe</a>.</p>
3 | </div>


--------------------------------------------------------------------------------
/templates/Includes/DocumentationGA.ss:
--------------------------------------------------------------------------------
 1 | 	<% if $GoogleAnalyticsCode %>
 2 | 		<script>
 3 | 			(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
 4 | 			(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
 5 | 			m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
 6 | 			})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
 7 | 
 8 | 			ga('create', '$GoogleAnalyticsCode', 'auto');
 9 | 			ga('send', 'pageview');
10 | 		</script>
11 | 	<% end_if %>
12 | 


--------------------------------------------------------------------------------
/templates/Includes/DocumentationHead.ss:
--------------------------------------------------------------------------------
 1 | <head>
 2 | 	<% base_tag %>
 3 | 	<meta charset="utf-8" />
 4 | 	<meta name="viewport" content="width=device-width, initial-scale=1">
 5 |     <% if $CanonicalUrl %>
 6 |         <link rel="canonical" href="$CanonicalUrl" />
 7 |     <% end_if %>
 8 | 	<title><% if Title %>$Title &#8211; <% end_if %>$DocumentationTitle</title>
 9 | </head>
10 | 
11 | <body>
12 | 


--------------------------------------------------------------------------------
/templates/Includes/DocumentationNextPrevious.ss:
--------------------------------------------------------------------------------
 1 | <% if NextPage || PreviousPage %>
 2 | 	<div class="next-prev clearfix">
 3 | 		<% if PreviousPage %>
 4 | 			<p class="prev-link"><a class="btn" href="$PreviousPage.Link">&laquo; $PreviousPage.Title</a></p>
 5 | 		<% end_if %>
 6 | 
 7 | 		<% if NextPage %>
 8 | 			<p class="next-link"><a class="btn" href="$NextPage.Link">$NextPage.Title &raquo;</a></p>
 9 | 		<% end_if %>
10 | 	</div>
11 | <% end_if %>


--------------------------------------------------------------------------------
/templates/Includes/DocumentationPages.ss:
--------------------------------------------------------------------------------
 1 | <% if Children %>
 2 | <div class="documentation_children">
 3 | 	<ul>
 4 | 		<% loop Children %>
 5 | 			<li>
 6 | 				<h3><a href="$Link">$Title</a></h3>
 7 | 				<% if Summary %><p>$Summary</p><% end_if %>
 8 | 			</li>
 9 | 		<% end_loop %>
10 | 	</ul>
11 | </div>
12 | <% end_if %>


--------------------------------------------------------------------------------
/templates/Includes/DocumentationSidebar.ss:
--------------------------------------------------------------------------------
 1 | <div id="sidebar">
 2 | 	<a class="menu-close" href="#">×</a>
 3 | 	<div class="box">
 4 | 		$DocumentationSearchForm
 5 | 		<ul class="nav">
 6 | 			<% if not HasDefaultEntity %>
 7 | 				<li><a href="$Link" class="top">Home</a></li>
 8 | 			<% end_if %>
 9 | 
10 | 			<% loop Menu %>
11 | 				<% if DefaultEntity %>
12 | 					<li><a href="$Link" class="top">Home</a></li>
13 | 
14 | 					<% loop Children %>
15 | 						<li class="$LinkingMode <% if Last %>last<% end_if %>">
16 | 							<a href="$Link" class="top">$Title</a>
17 | 
18 | 							<% if LinkingMode == section || LinkingMode == current %>
19 | 							<% if Children %>
20 | 							<ul class="$FirstLast">
21 | 								<% loop Children %>
22 | 									<li><a href="$Link" class="$LinkingMode">$Title</a>
23 | 										<% if LinkingMode == section || LinkingMode == current %>
24 | 										<% if Children %>
25 | 											<ul class="$FirstLast">
26 | 												<% loop Children %>
27 | 													<li><a href="$Link" class="$LinkingMode">$Title</a></li>
28 | 												<% end_loop %>
29 | 											</ul>
30 | 										<% end_if %>
31 | 										<% end_if %>
32 | 									</li>
33 | 								<% end_loop %>
34 | 							</ul><% end_if %>
35 | 							<% end_if %>
36 | 						</li>
37 | 					<% end_loop %>
38 | 				<% else %>
39 | 					<li class="$LinkingMode <% if Last %>last<% end_if %>"><a href="$Link" class="top">$Title <% if IsFolder %><span class="is-folder">&#9658;</span><% end_if %></a>
40 | 						<% if LinkingMode == section || LinkingMode == current %>
41 | 							<% if Children %>
42 | 							<ul class="$FirstLast">
43 | 								<% loop Children %>
44 | 									<li><a href="$Link" class="$LinkingMode">$Title</a>
45 | 										<% if LinkingMode == section || LinkingMode == current %>
46 | 										<% if Children %>
47 | 											<ul class="$FirstLast">
48 | 												<% loop Children %>
49 | 													<li><a href="$Link" class="$LinkingMode">$Title</a></li>
50 | 												<% end_loop %>
51 | 											</ul>
52 | 										<% end_if %>
53 | 										<% end_if %>
54 | 									</li>
55 | 								<% end_loop %>
56 | 							</ul><% end_if %>
57 | 						<% end_if %>
58 | 					</li>
59 | 				<% end_if %>
60 | 			<% end_loop %>
61 | 		</ul>
62 | 	</div>
63 | 
64 | 	<div class="no-box">
65 | 		<ul class="minor-nav">
66 | 			<li><a href="$DocumentationIndexLink">Documentation Index</a></li>
67 | 		</ul>
68 | 	</div>
69 | </div>
70 | 


--------------------------------------------------------------------------------
/templates/Includes/DocumentationTableContents.ss:
--------------------------------------------------------------------------------
1 | <div id="table-contents-holder"></div>
2 | 


--------------------------------------------------------------------------------
/templates/Includes/DocumentationVersion_warning.ss:
--------------------------------------------------------------------------------
 1 | <div class="warningBox" id="outdated-release">
 2 | 	<div class="warningBoxTop">
 3 | 		<% loop VersionWarning %>
 4 | 			<% if OutdatedRelease %>
 5 | 				<p>This document contains information for an <strong>outdated</strong> version <% if $Version %>(<strong>$Version</strong>)<% end_if %> and may not be maintained any more. If some of your projects still use this version, consider upgrading as soon as possible.</p>
 6 | 			<% else_if FutureRelease %>
 7 | 				<p>This document contains information about a <strong>future</strong> release <% if $VersionWarning.StableVersion %>and not the current stable version (<strong>$VersionWarning.StableVersion</strong>)<% end_if %>. Be aware that information on this page may change and API's may not be stable for production use.</p>
 8 | 			<% end_if %>
 9 | 		<% end_loop %>
10 | 	</div>
11 | </div>
12 | 


--------------------------------------------------------------------------------
/templates/Includes/DocumentationVersions.ss:
--------------------------------------------------------------------------------
 1 | <% if Versions %>
 2 | 	<div class="versions">
 3 | 		<p>Versions:</p>
 4 | 		
 5 | 		<ul>
 6 | 			<% loop Versions %>
 7 | 				<li><a href="$Link" class="$LinkingMode">$Title</a></li>
 8 | 			<% end_loop %>
 9 | 		</ul>
10 | 	</div>
11 | <% end_if %>


--------------------------------------------------------------------------------
/templates/Layout/DocumentationViewer_DocumentationFolder.ss:
--------------------------------------------------------------------------------
 1 | <div class="box">
 2 | 	<% if Introduction %>
 3 | 		<div class="introduction">
 4 | 			<h1>$Title</h1>
 5 | 
 6 | 			<% if Introduction %>
 7 | 				<p>$Introduction</p>
 8 | 			<% end_if %>
 9 | 		</div>
10 | 
11 | 		<% if Breadcrumbs %>
12 | 			<% include DocumentationBreadcrumbs %>
13 | 		<% end_if %>
14 | 	<% else %>
15 | 		<% if Breadcrumbs %>
16 | 			<% include DocumentationBreadcrumbs %>
17 | 		<% end_if %>
18 | 
19 | 		<h1>$Title</h1>
20 | 	<% end_if %>
21 | 
22 | 	<% if VersionWarning %>
23 | 		<% include DocumentationVersion_warning %>
24 | 	<% end_if %>
25 | 
26 | 	<% include DocumentationTableContents %>
27 | 
28 | 	<% if Children %>
29 | 		<div class="documentation_children">
30 | 			<ul>
31 | 				<% loop Children %>
32 | 					<li>
33 | 						<h3><a href="$Link">$Title</a></h3>
34 | 						<% if Summary %><p>$Summary</p><% end_if %>
35 | 					</li>
36 | 				<% end_loop %>
37 | 			</ul>
38 | 		</div>
39 | 	<% else %>
40 | 		<div class="documentation_children">
41 | 			<ul>
42 | 				<% loop Menu %>
43 | 					<li>
44 | 						<h3><a href="$Link">$Title</a></h3>
45 | 						<% if Summary %><p>$Summary</p><% end_if %>
46 | 					</li>
47 | 				<% end_loop %>
48 | 			</ul>
49 | 		</div>
50 | 	<% end_if %>
51 | 
52 | 	<% include DocumentationNextPrevious %>
53 | </div>


--------------------------------------------------------------------------------
/templates/Layout/DocumentationViewer_DocumentationPage.ss:
--------------------------------------------------------------------------------
 1 | <div id="documentation-page" class="box">
 2 | 	<% if VersionWarning %>
 3 | 		<% include DocumentationVersion_warning Version=$Entity.Version %>
 4 | 	<% end_if %>
 5 | 
 6 | 	<% include DocumentationTableContents %>
 7 | 
 8 | 		
 9 | 	$Content.RAW
10 | 
11 | 	<% include DocumentationNextPrevious %>
12 | 
13 | 	<% if EditLink %>
14 | 		<% include DocumentationEditLink %>
15 | 	<% end_if %>
16 | 
17 | 
18 | 	<% include DocumentationComments %>
19 | </div>


--------------------------------------------------------------------------------
/templates/Layout/DocumentationViewer_all.ss:
--------------------------------------------------------------------------------
 1 | <div id="documentation_index" class="box">
 2 | 	<div id="page-numbers">
 3 | 		<span>
 4 | 			<% loop $AllVersionPages.GroupedBy(FirstLetter) %>
 5 | 				<a href="#$FirstLetter">$FirstLetter</a>
 6 | 			<% end_loop %>
 7 | 		</span>
 8 | 	</div>
 9 | 
10 | 	<% loop $AllVersionPages.GroupedBy(FirstLetter) %>
11 | 		<h2 id="$FirstLetter">$FirstLetter</h2>
12 | 
13 | 		<ul class="third semantic">
14 | 			<% loop $Children %>
15 | 				<li>
16 | 					<a href="$Link">$Title</a>
17 | 				</li>
18 | 			<% end_loop %>
19 | 		</ul>
20 | 	<% end_loop %>
21 | </div>
22 | 


--------------------------------------------------------------------------------
/templates/Layout/DocumentationViewer_error.ss:
--------------------------------------------------------------------------------
 1 | <div id="documentation_error_page" class="box">
 2 | 	<div class="warningBox" id="pageNotFoundWarning">
 3 | 		<div class="warningBoxTop">
 4 | 			<h1>We're sorry&#8230;</h1>
 5 | 			<p>The page you are looking for does not exist, or might have moved.
 6 | 			<h5>Perhaps you could&#8230;</h5>
 7 | 			<ul>
 8 | 				<li>Return to the <a href="$BaseHref">homepage</a></li> 
 9 | 				<li>Try searching for the page (see input box on the top right).</li>
10 | 			</ul>
11 | 		</div>
12 | 	</div>
13 | </div>


--------------------------------------------------------------------------------
/templates/Layout/DocumentationViewer_results.ss:
--------------------------------------------------------------------------------
1 | <div class="box">
2 | 	$SearchResults
3 | </div>


--------------------------------------------------------------------------------
/templates/Layout/DocumentationViewer_search.ss:
--------------------------------------------------------------------------------
 1 | <% if AdvancedSearchEnabled %>
 2 | 	<div class="well">
 3 | 		$AdvancedSearchForm
 4 | 	</div>
 5 | <% end_if %>
 6 | 
 7 | 
 8 | <% if Results %>
 9 | 	<p class="intro">Your search for <strong>&quot;$SearchQuery.XML&quot;</strong> found $TotalResults result<% if TotalResults != 1 %>s<% end_if %>. Showing page $ThisPage of $TotalPages</p>
10 | 
11 | 	<% loop Results %>
12 | 		<div class="result">
13 | 			<h2><a href="$Link">$Title</a></h2>
14 | 			<p><small>$BreadcrumbTitle</small></p>
15 | 			<p>$Content.LimitCharacters(200)</p>
16 | 		</div>
17 | 	<% end_loop %>
18 | 	
19 | 	<% if SearchPages %>
20 | 		<ul class="pagination">
21 | 			<% if PrevUrl = false %><% else %>
22 | 				<li class="prev"><a href="$PrevUrl">Prev</a></li>
23 | 			<% end_if %>               
24 | 			
25 | 			<% loop SearchPages %>
26 | 				<% if IsEllipsis %>
27 | 					<li class="ellipsis">...</li>
28 | 				<% else %>
29 | 					<% if Current %>
30 | 						<li class="active"><strong>$PageNumber</strong></li>
31 | 					<% else %>
32 | 						<li><a href="$Link">$PageNumber</a></li>
33 | 					<% end_if %>
34 | 				<% end_if %>
35 | 			<% end_loop %>
36 | 			
37 | 			<% if NextUrl = false %>
38 | 			<% else %>
39 | 				<li class="next"><a href="$NextUrl">Next</a></li>
40 | 			<% end_if %>               
41 | 		</ul>         
42 | 	<% end_if %>
43 | 	
44 | <% else %>
45 | 	<p>No Results</p>
46 | <% end_if %>


--------------------------------------------------------------------------------
/templates/OpenSearchDescription.ss:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
 3 | 
 4 | 	<% if ShortName %><ShortName>$ShortName</ShortName><% end_if %>
 5 | 	<% if Description %><Description>$Description</Description><% end_if %>
 6 | 	<% if Tags %><Tags>$Tags</Tags><% end_if %>
 7 | 	<% if Contact %><Contact>$Content</Contact><% end_if %>
 8 |   	
 9 | 	<% if SearchPageLink %><Url type="text/html" template="$SearchPageLink.XML"></Url><% end_if %>
10 | 	<% if SearchPageAtom %><Url type="application/atom+xml" template="$SearchPageAtom.XML"></Url><% end_if %>
11 | 	<% if SearchPageJson %><Url type="application/x-suggestions+json" template="$SearchPageJson.XML"></Url><% end_if %>
12 | </OpenSearchDescription>


--------------------------------------------------------------------------------
/templates/OpenSearchResults.ss:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <feed xmlns="http://www.w3.org/2005/Atom" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
 3 | 	<title>$Title</title>
 4 | 	<link>$Link</link>
 5 | 	<author> 
 6 | 		<name>$Author</name>
 7 | 	</author>
 8 | 	
 9 | 	<updated>$Now</updated>
10 | 	<opensearch:totalResults>$TotalResults</opensearch:totalResults>
11 | 	<opensearch:startIndex>$StartResult</opensearch:startIndex>
12 | 	<opensearch:itemsPerPage>$PageLength</opensearch:itemsPerPage>
13 | 	<opensearch:Query role="request" searchTerms="$Query" startIndex="$StartResult" count="$PageLength"></opensearch:Query>
14 | 	<% loop Results %>
15 | 	<entry>
16 | 		<title><% if BreadcrumbTitle %>$BreadcrumbTitle<% else %>$Title<% end_if %></title>
17 | 		<link href="$Link">$Link</link>
18 | 		<id>urn:uuid:$ID</id>
19 | 		<content type="text">$Content.LimitCharacters(200)</content>
20 | 	</entry>
21 | 	<% end_loop %>
22 | </feed>


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Exception.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category  Zend
16 |  * @package   Zend_Search
17 |  * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
18 |  * @license   http://framework.zend.com/license/new-bsd     New BSD License
19 |  * @version   $Id: Exception.php 20096 2010-01-06 02:05:09Z bkarwin $
20 |  */
21 | 
22 | 
23 | /**
24 |  * Framework base exception
25 |  */
26 | require_once 'Zend/Exception.php';
27 | 
28 | 
29 | /**
30 |  * @category   Zend
31 |  * @package    Zend_Search
32 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
33 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
34 |  */
35 | class Zend_Search_Exception extends Zend_Exception
36 | {
37 | 
38 | }
39 | 
40 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Analysis/Analyzer/Common.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Analysis
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: Common.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | 
 24 | /**
 25 |  * Define constant used to provide correct file processing order    
 26 | */
 27 | /**
 28 |  * @todo Section should be removed with ZF 2.0 release as obsolete  
 29 | */
 30 | define('ZEND_SEARCH_LUCENE_COMMON_ANALYZER_PROCESSED', true);
 31 | 
 32 | 
 33 | /**
 34 |  * Zend_Search_Lucene_Analysis_Analyzer 
 35 | */
 36 | require_once 'Zend/Search/Lucene/Analysis/Analyzer.php';
 37 | 
 38 | /**
 39 |  * Zend_Search_Lucene_Analysis_Token 
 40 | */
 41 | require_once 'Zend/Search/Lucene/Analysis/Token.php';
 42 | 
 43 | /**
 44 |  * Zend_Search_Lucene_Analysis_TokenFilter 
 45 | */
 46 | require_once 'Zend/Search/Lucene/Analysis/TokenFilter.php';
 47 | 
 48 | 
 49 | /**
 50 |  * Common implementation of the Zend_Search_Lucene_Analysis_Analyzer interface.
 51 |  * There are several standard standard subclasses provided by Zend_Search_Lucene/Analysis
 52 |  * subpackage: Zend_Search_Lucene_Analysis_Analyzer_Common_Text, ZSearchHTMLAnalyzer, ZSearchXMLAnalyzer.
 53 |  *
 54 |  * @todo ZSearchHTMLAnalyzer and ZSearchXMLAnalyzer implementation
 55 |  *
 56 |  * @category   Zend
 57 |  * @package    Zend_Search_Lucene
 58 |  * @subpackage Analysis
 59 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 60 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 61 |  */
 62 | abstract class Zend_Search_Lucene_Analysis_Analyzer_Common extends Zend_Search_Lucene_Analysis_Analyzer
 63 | {
 64 |     /**
 65 |      * The set of Token filters applied to the Token stream.
 66 |      * Array of Zend_Search_Lucene_Analysis_TokenFilter objects.
 67 |      *
 68 |      * @var array
 69 |      */
 70 |     private $_filters = array();
 71 | 
 72 |     /**
 73 |      * Add Token filter to the Analyzer
 74 |      *
 75 |      * @param Zend_Search_Lucene_Analysis_TokenFilter $filter
 76 |      */
 77 |     public function addFilter(Zend_Search_Lucene_Analysis_TokenFilter $filter)
 78 |     {
 79 |         $this->_filters[] = $filter;
 80 |     }
 81 | 
 82 |     /**
 83 |      * Apply filters to the token. Can return null when the token was removed.
 84 |      *
 85 |      * @param  Zend_Search_Lucene_Analysis_Token $token
 86 |      * @return Zend_Search_Lucene_Analysis_Token
 87 |      */
 88 |     public function normalize(Zend_Search_Lucene_Analysis_Token $token)
 89 |     {
 90 |         foreach ($this->_filters as $filter) {
 91 |             $token = $filter->normalize($token);
 92 | 
 93 |             // resulting token can be null if the filter removes it
 94 |             if ($token === null) {
 95 |                 return null;
 96 |             }
 97 |         }
 98 | 
 99 |         return $token;
100 |     }
101 | }
102 | 
103 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Analysis/Analyzer/Common/Text.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Analysis
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: Text.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | 
24 | /**
25 |  * Zend_Search_Lucene_Analysis_Analyzer_Common 
26 | */
27 | require_once 'Zend/Search/Lucene/Analysis/Analyzer/Common.php';
28 | 
29 | 
30 | /**
31 |  * @category   Zend
32 |  * @package    Zend_Search_Lucene
33 |  * @subpackage Analysis
34 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
35 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
36 |  */
37 | 
38 | class Zend_Search_Lucene_Analysis_Analyzer_Common_Text extends Zend_Search_Lucene_Analysis_Analyzer_Common
39 | {
40 |     /**
41 |      * Current position in a stream
42 |      *
43 |      * @var integer
44 |      */
45 |     private $_position;
46 | 
47 |     /**
48 |      * Reset token stream
49 |      */
50 |     public function reset()
51 |     {
52 |         $this->_position = 0;
53 | 
54 |         if ($this->_input === null) {
55 |             return;
56 |         }
57 | 
58 |         // convert input into ascii
59 |         if (PHP_OS != 'AIX') {
60 |             $this->_input = iconv($this->_encoding, 'ASCII//TRANSLIT', $this->_input);
61 |         }
62 |         $this->_encoding = 'ASCII';
63 |     }
64 | 
65 |     /**
66 |      * Tokenization stream API
67 |      * Get next token
68 |      * Returns null at the end of stream
69 |      *
70 |      * @return Zend_Search_Lucene_Analysis_Token|null
71 |      */
72 |     public function nextToken()
73 |     {
74 |         if ($this->_input === null) {
75 |             return null;
76 |         }
77 | 
78 | 
79 |         do {
80 |             if (! preg_match('/[a-zA-Z]+/', $this->_input, $match, PREG_OFFSET_CAPTURE, $this->_position)) {
81 |                 // It covers both cases a) there are no matches (preg_match(...) === 0)
82 |                 // b) error occured (preg_match(...) === FALSE)
83 |                 return null;
84 |             }
85 | 
86 |             $str = $match[0][0];
87 |             $pos = $match[0][1];
88 |             $endpos = $pos + strlen($str);
89 | 
90 |             $this->_position = $endpos;
91 | 
92 |             $token = $this->normalize(new Zend_Search_Lucene_Analysis_Token($str, $pos, $endpos));
93 |         } while ($token === null); // try again if token is skipped
94 | 
95 |         return $token;
96 |     }
97 | }
98 | 
99 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Analysis/Analyzer/Common/Text/CaseInsensitive.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Analysis
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: CaseInsensitive.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | 
24 | /**
25 |  * Zend_Search_Lucene_Analysis_Analyzer_Common_Text 
26 | */
27 | require_once 'Zend/Search/Lucene/Analysis/Analyzer/Common/Text.php';
28 | 
29 | /**
30 |  * Zend_Search_Lucene_Analysis_TokenFilter_LowerCase 
31 | */
32 | require_once 'Zend/Search/Lucene/Analysis/TokenFilter/LowerCase.php';
33 | 
34 | 
35 | /**
36 |  * @category   Zend
37 |  * @package    Zend_Search_Lucene
38 |  * @subpackage Analysis
39 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
40 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
41 |  */
42 | 
43 | 
44 | class Zend_Search_Lucene_Analysis_Analyzer_Common_Text_CaseInsensitive extends Zend_Search_Lucene_Analysis_Analyzer_Common_Text
45 | {
46 |     public function __construct()
47 |     {
48 |         $this->addFilter(new Zend_Search_Lucene_Analysis_TokenFilter_LowerCase());
49 |     }
50 | }
51 | 
52 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Analysis/Analyzer/Common/TextNum.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Analysis
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: TextNum.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | 
24 | /**
25 |  * Zend_Search_Lucene_Analysis_Analyzer_Common 
26 | */
27 | require_once 'Zend/Search/Lucene/Analysis/Analyzer/Common.php';
28 | 
29 | 
30 | /**
31 |  * @category   Zend
32 |  * @package    Zend_Search_Lucene
33 |  * @subpackage Analysis
34 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
35 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
36 |  */
37 | 
38 | class Zend_Search_Lucene_Analysis_Analyzer_Common_TextNum extends Zend_Search_Lucene_Analysis_Analyzer_Common
39 | {
40 |     /**
41 |      * Current position in a stream
42 |      *
43 |      * @var integer
44 |      */
45 |     private $_position;
46 | 
47 |     /**
48 |      * Reset token stream
49 |      */
50 |     public function reset()
51 |     {
52 |         $this->_position = 0;
53 | 
54 |         if ($this->_input === null) {
55 |             return;
56 |         }
57 | 
58 |         // convert input into ascii
59 |         if (PHP_OS != 'AIX') {
60 |             $this->_input = iconv($this->_encoding, 'ASCII//TRANSLIT', $this->_input);
61 |         }
62 |         $this->_encoding = 'ASCII';
63 |     }
64 | 
65 |     /**
66 |      * Tokenization stream API
67 |      * Get next token
68 |      * Returns null at the end of stream
69 |      *
70 |      * @return Zend_Search_Lucene_Analysis_Token|null
71 |      */
72 |     public function nextToken()
73 |     {
74 |         if ($this->_input === null) {
75 |             return null;
76 |         }
77 | 
78 |         do {
79 |             if (! preg_match('/[a-zA-Z0-9]+/', $this->_input, $match, PREG_OFFSET_CAPTURE, $this->_position)) {
80 |                 // It covers both cases a) there are no matches (preg_match(...) === 0)
81 |                 // b) error occured (preg_match(...) === FALSE)
82 |                 return null;
83 |             }
84 | 
85 |             $str = $match[0][0];
86 |             $pos = $match[0][1];
87 |             $endpos = $pos + strlen($str);
88 | 
89 |             $this->_position = $endpos;
90 | 
91 |             $token = $this->normalize(new Zend_Search_Lucene_Analysis_Token($str, $pos, $endpos));
92 |         } while ($token === null); // try again if token is skipped
93 | 
94 |         return $token;
95 |     }
96 | }
97 | 
98 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Analysis/Analyzer/Common/TextNum/CaseInsensitive.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Analysis
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: CaseInsensitive.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | 
24 | /**
25 |  * Zend_Search_Lucene_Analysis_Analyzer_Common_TextNum 
26 | */
27 | require_once 'Zend/Search/Lucene/Analysis/Analyzer/Common/TextNum.php';
28 | 
29 | /**
30 |  * Zend_Search_Lucene_Analysis_TokenFilter_LowerCase 
31 | */
32 | require_once 'Zend/Search/Lucene/Analysis/TokenFilter/LowerCase.php';
33 | 
34 | 
35 | /**
36 |  * @category   Zend
37 |  * @package    Zend_Search_Lucene
38 |  * @subpackage Analysis
39 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
40 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
41 |  */
42 | 
43 | 
44 | class Zend_Search_Lucene_Analysis_Analyzer_Common_TextNum_CaseInsensitive extends Zend_Search_Lucene_Analysis_Analyzer_Common_TextNum
45 | {
46 |     public function __construct()
47 |     {
48 |         $this->addFilter(new Zend_Search_Lucene_Analysis_TokenFilter_LowerCase());
49 |     }
50 | }
51 | 
52 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Analysis/Analyzer/Common/Utf8.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Analysis
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: Utf8.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | 
 24 | /**
 25 |  * Zend_Search_Lucene_Analysis_Analyzer_Common 
 26 | */
 27 | require_once 'Zend/Search/Lucene/Analysis/Analyzer/Common.php';
 28 | 
 29 | 
 30 | /**
 31 |  * @category   Zend
 32 |  * @package    Zend_Search_Lucene
 33 |  * @subpackage Analysis
 34 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 35 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 36 |  */
 37 | 
 38 | class Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8 extends Zend_Search_Lucene_Analysis_Analyzer_Common
 39 | {
 40 |     /**
 41 |      * Current char position in an UTF-8 stream
 42 |      *
 43 |      * @var integer
 44 |      */
 45 |     private $_position;
 46 | 
 47 |     /**
 48 |      * Current binary position in an UTF-8 stream
 49 |      *
 50 |      * @var integer
 51 |      */
 52 |     private $_bytePosition;
 53 | 
 54 |     /**
 55 |      * Object constructor
 56 |      *
 57 |      * @throws Zend_Search_Lucene_Exception
 58 |      */
 59 |     public function __construct()
 60 |     {
 61 |         if (@preg_match('/\pL/u', 'a') != 1) {
 62 |             // PCRE unicode support is turned off
 63 |             include_once 'Zend/Search/Lucene/Exception.php';
 64 |             throw new Zend_Search_Lucene_Exception('Utf8 analyzer needs PCRE unicode support to be enabled.');
 65 |         }
 66 |     }
 67 | 
 68 |     /**
 69 |      * Reset token stream
 70 |      */
 71 |     public function reset()
 72 |     {
 73 |         $this->_position     = 0;
 74 |         $this->_bytePosition = 0;
 75 | 
 76 |         // convert input into UTF-8
 77 |         if (strcasecmp($this->_encoding, 'utf8') != 0  
 78 |             && strcasecmp($this->_encoding, 'utf-8') != 0 
 79 |         ) {
 80 |                 $this->_input = iconv($this->_encoding, 'UTF-8', $this->_input);
 81 |                 $this->_encoding = 'UTF-8';
 82 |         }
 83 |     }
 84 | 
 85 |     /**
 86 |      * Tokenization stream API
 87 |      * Get next token
 88 |      * Returns null at the end of stream
 89 |      *
 90 |      * @return Zend_Search_Lucene_Analysis_Token|null
 91 |      */
 92 |     public function nextToken()
 93 |     {
 94 |         if ($this->_input === null) {
 95 |             return null;
 96 |         }
 97 | 
 98 |         do {
 99 |             if (! preg_match('/[\p{L}]+/u', $this->_input, $match, PREG_OFFSET_CAPTURE, $this->_bytePosition)) {
100 |                 // It covers both cases a) there are no matches (preg_match(...) === 0)
101 |                 // b) error occured (preg_match(...) === FALSE)
102 |                 return null;
103 |             }
104 | 
105 |             // matched string
106 |             $matchedWord = $match[0][0];
107 | 
108 |             // binary position of the matched word in the input stream
109 |             $binStartPos = $match[0][1];
110 | 
111 |             // character position of the matched word in the input stream
112 |             $startPos = $this->_position +
113 |                         iconv_strlen(
114 |                             substr(
115 |                                 $this->_input,
116 |                                 $this->_bytePosition,
117 |                                 $binStartPos - $this->_bytePosition
118 |                             ),
119 |                             'UTF-8'
120 |                         );
121 |             // character postion of the end of matched word in the input stream
122 |             $endPos = $startPos + iconv_strlen($matchedWord, 'UTF-8');
123 | 
124 |             $this->_bytePosition = $binStartPos + strlen($matchedWord);
125 |             $this->_position     = $endPos;
126 | 
127 |             $token = $this->normalize(new Zend_Search_Lucene_Analysis_Token($matchedWord, $startPos, $endPos));
128 |         } while ($token === null); // try again if token is skipped
129 | 
130 |         return $token;
131 |     }
132 | }
133 | 
134 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Analysis/Analyzer/Common/Utf8/CaseInsensitive.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Analysis
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: CaseInsensitive.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | 
24 | /**
25 |  * Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8 
26 | */
27 | require_once 'Zend/Search/Lucene/Analysis/Analyzer/Common/Utf8.php';
28 | 
29 | /**
30 |  * Zend_Search_Lucene_Analysis_TokenFilter_LowerCaseUtf8 
31 | */
32 | require_once 'Zend/Search/Lucene/Analysis/TokenFilter/LowerCaseUtf8.php';
33 | 
34 | 
35 | /**
36 |  * @category   Zend
37 |  * @package    Zend_Search_Lucene
38 |  * @subpackage Analysis
39 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
40 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
41 |  */
42 | 
43 | 
44 | class Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8_CaseInsensitive extends Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8
45 | {
46 |     public function __construct()
47 |     {
48 |         parent::__construct();
49 | 
50 |         $this->addFilter(new Zend_Search_Lucene_Analysis_TokenFilter_LowerCaseUtf8());
51 |     }
52 | }
53 | 
54 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Analysis/Analyzer/Common/Utf8Num.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Analysis
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: Utf8Num.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | 
 24 | /**
 25 |  * Zend_Search_Lucene_Analysis_Analyzer_Common 
 26 | */
 27 | require_once 'Zend/Search/Lucene/Analysis/Analyzer/Common.php';
 28 | 
 29 | 
 30 | /**
 31 |  * @category   Zend
 32 |  * @package    Zend_Search_Lucene
 33 |  * @subpackage Analysis
 34 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 35 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 36 |  */
 37 | 
 38 | class Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8Num extends Zend_Search_Lucene_Analysis_Analyzer_Common
 39 | {
 40 |     /**
 41 |      * Current char position in an UTF-8 stream
 42 |      *
 43 |      * @var integer
 44 |      */
 45 |     private $_position;
 46 | 
 47 |     /**
 48 |      * Current binary position in an UTF-8 stream
 49 |      *
 50 |      * @var integer
 51 |      */
 52 |     private $_bytePosition;
 53 | 
 54 |     /**
 55 |      * Object constructor
 56 |      *
 57 |      * @throws Zend_Search_Lucene_Exception
 58 |      */
 59 |     public function __construct()
 60 |     {
 61 |         if (@preg_match('/\pL/u', 'a') != 1) {
 62 |             // PCRE unicode support is turned off
 63 |             include_once 'Zend/Search/Lucene/Exception.php';
 64 |             throw new Zend_Search_Lucene_Exception('Utf8Num analyzer needs PCRE unicode support to be enabled.');
 65 |         }
 66 |     }
 67 | 
 68 |     /**
 69 |      * Reset token stream
 70 |      */
 71 |     public function reset()
 72 |     {
 73 |         $this->_position     = 0;
 74 |         $this->_bytePosition = 0;
 75 | 
 76 |         // convert input into UTF-8
 77 |         if (strcasecmp($this->_encoding, 'utf8') != 0  
 78 |             && strcasecmp($this->_encoding, 'utf-8') != 0 
 79 |         ) {
 80 |                 $this->_input = iconv($this->_encoding, 'UTF-8', $this->_input);
 81 |                 $this->_encoding = 'UTF-8';
 82 |         }
 83 |     }
 84 | 
 85 |     /**
 86 |      * Tokenization stream API
 87 |      * Get next token
 88 |      * Returns null at the end of stream
 89 |      *
 90 |      * @return Zend_Search_Lucene_Analysis_Token|null
 91 |      */
 92 |     public function nextToken()
 93 |     {
 94 |         if ($this->_input === null) {
 95 |             return null;
 96 |         }
 97 | 
 98 |         do {
 99 |             if (! preg_match('/[\p{L}\p{N}]+/u', $this->_input, $match, PREG_OFFSET_CAPTURE, $this->_bytePosition)) {
100 |                 // It covers both cases a) there are no matches (preg_match(...) === 0)
101 |                 // b) error occured (preg_match(...) === FALSE)
102 |                 return null;
103 |             }
104 | 
105 |             // matched string
106 |             $matchedWord = $match[0][0];
107 | 
108 |             // binary position of the matched word in the input stream
109 |             $binStartPos = $match[0][1];
110 | 
111 |             // character position of the matched word in the input stream
112 |             $startPos = $this->_position +
113 |                         iconv_strlen(
114 |                             substr(
115 |                                 $this->_input,
116 |                                 $this->_bytePosition,
117 |                                 $binStartPos - $this->_bytePosition
118 |                             ),
119 |                             'UTF-8'
120 |                         );
121 |             // character postion of the end of matched word in the input stream
122 |             $endPos = $startPos + iconv_strlen($matchedWord, 'UTF-8');
123 | 
124 |             $this->_bytePosition = $binStartPos + strlen($matchedWord);
125 |             $this->_position     = $endPos;
126 | 
127 |             $token = $this->normalize(new Zend_Search_Lucene_Analysis_Token($matchedWord, $startPos, $endPos));
128 |         } while ($token === null); // try again if token is skipped
129 | 
130 |         return $token;
131 |     }
132 | }
133 | 
134 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Analysis/Analyzer/Common/Utf8Num/CaseInsensitive.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Analysis
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: CaseInsensitive.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | 
24 | /**
25 |  * Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8Num 
26 | */
27 | require_once 'Zend/Search/Lucene/Analysis/Analyzer/Common/Utf8Num.php';
28 | 
29 | /**
30 |  * Zend_Search_Lucene_Analysis_TokenFilter_LowerCaseUtf8 
31 | */
32 | require_once 'Zend/Search/Lucene/Analysis/TokenFilter/LowerCaseUtf8.php';
33 | 
34 | 
35 | /**
36 |  * @category   Zend
37 |  * @package    Zend_Search_Lucene
38 |  * @subpackage Analysis
39 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
40 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
41 |  */
42 | 
43 | 
44 | class Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8Num_CaseInsensitive extends Zend_Search_Lucene_Analysis_Analyzer_Common_Utf8Num
45 | {
46 |     public function __construct()
47 |     {
48 |         parent::__construct();
49 | 
50 |         $this->addFilter(new Zend_Search_Lucene_Analysis_TokenFilter_LowerCaseUtf8());
51 |     }
52 | }
53 | 
54 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Analysis/Token.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Analysis
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: Token.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | 
 24 | /**
 25 |  * @category   Zend
 26 |  * @package    Zend_Search_Lucene
 27 |  * @subpackage Analysis
 28 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 29 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 30 |  */
 31 | class Zend_Search_Lucene_Analysis_Token
 32 | {
 33 |     /**
 34 |      * The text of the term.
 35 |      *
 36 |      * @var string
 37 |      */
 38 |     private $_termText;
 39 | 
 40 |     /**
 41 |      * Start in source text.
 42 |      *
 43 |      * @var integer
 44 |      */
 45 |     private $_startOffset;
 46 | 
 47 |     /**
 48 |      * End in source text
 49 |      *
 50 |      * @var integer
 51 |      */
 52 |     private $_endOffset;
 53 | 
 54 |     /**
 55 |      * The position of this token relative to the previous Token.
 56 |      *
 57 |      * The default value is one.
 58 |      *
 59 |      * Some common uses for this are:
 60 |      * Set it to zero to put multiple terms in the same position.  This is
 61 |      * useful if, e.g., a word has multiple stems.  Searches for phrases
 62 |      * including either stem will match.  In this case, all but the first stem's
 63 |      * increment should be set to zero: the increment of the first instance
 64 |      * should be one.  Repeating a token with an increment of zero can also be
 65 |      * used to boost the scores of matches on that token.
 66 |      *
 67 |      * Set it to values greater than one to inhibit exact phrase matches.
 68 |      * If, for example, one does not want phrases to match across removed stop
 69 |      * words, then one could build a stop word filter that removes stop words and
 70 |      * also sets the increment to the number of stop words removed before each
 71 |      * non-stop word.  Then exact phrase queries will only match when the terms
 72 |      * occur with no intervening stop words.
 73 |      *
 74 |      * @var integer
 75 |      */
 76 |     private $_positionIncrement;
 77 | 
 78 | 
 79 |     /**
 80 |      * Object constructor
 81 |      *
 82 |      * @param string  $text
 83 |      * @param integer $start
 84 |      * @param integer $end
 85 |      * @param string  $type
 86 |      */
 87 |     public function __construct($text, $start, $end)
 88 |     {
 89 |         $this->_termText    = $text;
 90 |         $this->_startOffset = $start;
 91 |         $this->_endOffset   = $end;
 92 | 
 93 |         $this->_positionIncrement = 1;
 94 |     }
 95 | 
 96 | 
 97 |     /**
 98 |      * positionIncrement setter
 99 |      *
100 |      * @param integer $positionIncrement
101 |      */
102 |     public function setPositionIncrement($positionIncrement)
103 |     {
104 |         $this->_positionIncrement = $positionIncrement;
105 |     }
106 | 
107 |     /**
108 |      * Returns the position increment of this Token.
109 |      *
110 |      * @return integer
111 |      */
112 |     public function getPositionIncrement()
113 |     {
114 |         return $this->_positionIncrement;
115 |     }
116 | 
117 |     /**
118 |      * Returns the Token's term text.
119 |      *
120 |      * @return string
121 |      */
122 |     public function getTermText()
123 |     {
124 |         return $this->_termText;
125 |     }
126 | 
127 |     /**
128 |      * Returns this Token's starting offset, the position of the first character
129 |      * corresponding to this token in the source text.
130 |      *
131 |      * Note:
132 |      * The difference between getEndOffset() and getStartOffset() may not be equal
133 |      * to strlen(Zend_Search_Lucene_Analysis_Token::getTermText()), as the term text may have been altered
134 |      * by a stemmer or some other filter.
135 |      *
136 |      * @return integer
137 |      */
138 |     public function getStartOffset()
139 |     {
140 |         return $this->_startOffset;
141 |     }
142 | 
143 |     /**
144 |      * Returns this Token's ending offset, one greater than the position of the
145 |      * last character corresponding to this token in the source text.
146 |      *
147 |      * @return integer
148 |      */
149 |     public function getEndOffset()
150 |     {
151 |         return $this->_endOffset;
152 |     }
153 | }
154 | 
155 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Analysis/TokenFilter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Analysis
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: TokenFilter.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | 
24 | /**
25 |  * Zend_Search_Lucene_Analysis_Token 
26 | */
27 | require_once 'Zend/Search/Lucene/Analysis/Token.php';
28 | 
29 | 
30 | /**
31 |  * Token filter converts (normalizes) Token ore removes it from a token stream.
32 |  *
33 |  * @category   Zend
34 |  * @package    Zend_Search_Lucene
35 |  * @subpackage Analysis
36 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
37 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
38 |  */
39 | abstract class Zend_Search_Lucene_Analysis_TokenFilter
40 | {
41 |     /**
42 |      * Normalize Token or remove it (if null is returned)
43 |      *
44 |      * @param  Zend_Search_Lucene_Analysis_Token $srcToken
45 |      * @return Zend_Search_Lucene_Analysis_Token
46 |      */
47 |     abstract public function normalize(Zend_Search_Lucene_Analysis_Token $srcToken);
48 | }
49 | 
50 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Analysis/TokenFilter/LowerCase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Analysis
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: LowerCase.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | 
24 | /**
25 |  * Zend_Search_Lucene_Analysis_TokenFilter 
26 | */
27 | require_once 'Zend/Search/Lucene/Analysis/TokenFilter.php';
28 | 
29 | 
30 | /**
31 |  * Lower case Token filter.
32 |  *
33 |  * @category   Zend
34 |  * @package    Zend_Search_Lucene
35 |  * @subpackage Analysis
36 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
37 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
38 |  */
39 | 
40 | class Zend_Search_Lucene_Analysis_TokenFilter_LowerCase extends Zend_Search_Lucene_Analysis_TokenFilter
41 | {
42 |     /**
43 |      * Normalize Token or remove it (if null is returned)
44 |      *
45 |      * @param  Zend_Search_Lucene_Analysis_Token $srcToken
46 |      * @return Zend_Search_Lucene_Analysis_Token
47 |      */
48 |     public function normalize(Zend_Search_Lucene_Analysis_Token $srcToken)
49 |     {
50 |         $newToken = new Zend_Search_Lucene_Analysis_Token(
51 |             strtolower($srcToken->getTermText()),
52 |             $srcToken->getStartOffset(),
53 |             $srcToken->getEndOffset()
54 |         );
55 | 
56 |         $newToken->setPositionIncrement($srcToken->getPositionIncrement());
57 | 
58 |         return $newToken;
59 |     }
60 | }
61 | 
62 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Analysis/TokenFilter/LowerCaseUtf8.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Analysis
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: LowerCaseUtf8.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | 
24 | /**
25 |  * Zend_Search_Lucene_Analysis_TokenFilter 
26 | */
27 | require_once 'Zend/Search/Lucene/Analysis/TokenFilter.php';
28 | 
29 | 
30 | /**
31 |  * Lower case Token filter.
32 |  *
33 |  * @category   Zend
34 |  * @package    Zend_Search_Lucene
35 |  * @subpackage Analysis
36 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
37 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
38 |  */
39 | 
40 | class Zend_Search_Lucene_Analysis_TokenFilter_LowerCaseUtf8 extends Zend_Search_Lucene_Analysis_TokenFilter
41 | {
42 |     /**
43 |      * Object constructor
44 |      */
45 |     public function __construct()
46 |     {
47 |         if (!function_exists('mb_strtolower')) {
48 |             // mbstring extension is disabled
49 |             include_once 'Zend/Search/Lucene/Exception.php';
50 |             throw new Zend_Search_Lucene_Exception('Utf8 compatible lower case filter needs mbstring extension to be enabled.');
51 |         }
52 |     }
53 | 
54 |     /**
55 |      * Normalize Token or remove it (if null is returned)
56 |      *
57 |      * @param  Zend_Search_Lucene_Analysis_Token $srcToken
58 |      * @return Zend_Search_Lucene_Analysis_Token
59 |      */
60 |     public function normalize(Zend_Search_Lucene_Analysis_Token $srcToken)
61 |     {
62 |         $newToken = new Zend_Search_Lucene_Analysis_Token(
63 |             mb_strtolower($srcToken->getTermText(), 'UTF-8'),
64 |             $srcToken->getStartOffset(),
65 |             $srcToken->getEndOffset()
66 |         );
67 | 
68 |         $newToken->setPositionIncrement($srcToken->getPositionIncrement());
69 | 
70 |         return $newToken;
71 |     }
72 | }
73 | 
74 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Analysis/TokenFilter/ShortWords.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Analysis
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: ShortWords.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | 
24 | /**
25 |  * Zend_Search_Lucene_Analysis_TokenFilter 
26 | */
27 | require_once 'Zend/Search/Lucene/Analysis/TokenFilter.php';
28 | 
29 | 
30 | /**
31 |  * Token filter that removes short words. What is short word can be configured with constructor.
32 |  *
33 |  * @category   Zend
34 |  * @package    Zend_Search_Lucene
35 |  * @subpackage Analysis
36 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
37 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
38 |  */
39 | 
40 | class Zend_Search_Lucene_Analysis_TokenFilter_ShortWords extends Zend_Search_Lucene_Analysis_TokenFilter
41 | {
42 |     /**
43 |      * Minimum allowed term length
44 |      *
45 |      * @var integer
46 |      */
47 |     private $length;
48 | 
49 |     /**
50 |      * Constructs new instance of this filter.
51 |      *
52 |      * @param integer $short minimum allowed length of term which passes this filter (default 2)
53 |      */
54 |     public function __construct($length = 2) 
55 |     {
56 |         $this->length = $length;
57 |     }
58 | 
59 |     /**
60 |      * Normalize Token or remove it (if null is returned)
61 |      *
62 |      * @param  Zend_Search_Lucene_Analysis_Token $srcToken
63 |      * @return Zend_Search_Lucene_Analysis_Token
64 |      */
65 |     public function normalize(Zend_Search_Lucene_Analysis_Token $srcToken) 
66 |     {
67 |         if (strlen($srcToken->getTermText()) < $this->length) {
68 |             return null;
69 |         } else {
70 |             return $srcToken;
71 |         }
72 |     }
73 | }
74 | 
75 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Analysis/TokenFilter/StopWords.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Analysis
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: StopWords.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | /**
 24 |  * Zend_Search_Lucene_Analysis_TokenFilter 
 25 | */
 26 | require_once 'Zend/Search/Lucene/Analysis/TokenFilter.php';
 27 | 
 28 | /**
 29 |  * Token filter that removes stop words. These words must be provided as array (set), example:
 30 |  * $stopwords = array('the' => 1, 'an' => '1');
 31 |  *
 32 |  * We do recommend to provide all words in lowercase and concatenate this class after the lowercase filter.
 33 |  *
 34 |  * @category   Zend
 35 |  * @package    Zend_Search_Lucene
 36 |  * @subpackage Analysis
 37 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 38 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 39 |  */
 40 | 
 41 | class Zend_Search_Lucene_Analysis_TokenFilter_StopWords extends Zend_Search_Lucene_Analysis_TokenFilter
 42 | {
 43 |     /**
 44 |      * Stop Words
 45 |      *
 46 |      * @var array
 47 |      */
 48 |     private $_stopSet;
 49 | 
 50 |     /**
 51 |      * Constructs new instance of this filter.
 52 |      *
 53 |      * @param array $stopwords array (set) of words that will be filtered out
 54 |      */
 55 |     public function __construct($stopwords = array()) 
 56 |     {
 57 |         $this->_stopSet = array_flip($stopwords);
 58 |     }
 59 | 
 60 |     /**
 61 |      * Normalize Token or remove it (if null is returned)
 62 |      *
 63 |      * @param  Zend_Search_Lucene_Analysis_Token $srcToken
 64 |      * @return Zend_Search_Lucene_Analysis_Token
 65 |      */
 66 |     public function normalize(Zend_Search_Lucene_Analysis_Token $srcToken) 
 67 |     {
 68 |         if (array_key_exists($srcToken->getTermText(), $this->_stopSet)) {
 69 |             return null;
 70 |         } else {
 71 |             return $srcToken;
 72 |         }
 73 |     }
 74 | 
 75 |     /**
 76 |      * Fills stopwords set from a text file. Each line contains one stopword, lines with '#' in the first
 77 |      * column are ignored (as comments).
 78 |      *
 79 |      * You can call this method one or more times. New stopwords are always added to current set.
 80 |      *
 81 |      * @param  string $filepath full path for text file with stopwords
 82 |      * @throws Zend_Search_Exception When the file doesn`t exists or is not readable.
 83 |      */
 84 |     public function loadFromFile($filepath = null) 
 85 |     {
 86 |         if (! $filepath || ! file_exists($filepath)) {
 87 |             include_once 'Zend/Search/Lucene/Exception.php';
 88 |             throw new Zend_Search_Lucene_Exception('You have to provide valid file path');
 89 |         }
 90 |         $fd = fopen($filepath, "r");
 91 |         if (! $fd) {
 92 |             include_once 'Zend/Search/Lucene/Exception.php';
 93 |             throw new Zend_Search_Lucene_Exception('Cannot open file ' . $filepath);
 94 |         }
 95 |         while (!feof($fd)) {
 96 |             $buffer = trim(fgets($fd));
 97 |             if (strlen($buffer) > 0 && $buffer[0] != '#') {
 98 |                 $this->_stopSet[$buffer] = 1;
 99 |             }
100 |         }
101 |         if (!fclose($fd)) {
102 |             include_once 'Zend/Search/Lucene/Exception.php';
103 |             throw new Zend_Search_Lucene_Exception('Cannot close file ' . $filepath);
104 |         }
105 |     }
106 | }
107 | 
108 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Document.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Document
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: Document.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | 
 24 | /**
 25 |  * Zend_Search_Lucene_Field 
 26 | */
 27 | require_once 'Zend/Search/Lucene/Field.php';
 28 | 
 29 | 
 30 | /**
 31 |  * A Document is a set of fields. Each field has a name and a textual value.
 32 |  *
 33 |  * @category   Zend
 34 |  * @package    Zend_Search_Lucene
 35 |  * @subpackage Document
 36 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 37 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 38 |  */
 39 | class Zend_Search_Lucene_Document
 40 | {
 41 | 
 42 |     /**
 43 |      * Associative array Zend_Search_Lucene_Field objects where the keys to the
 44 |      * array are the names of the fields.
 45 |      *
 46 |      * @var array
 47 |      */
 48 |     protected $_fields = array();
 49 | 
 50 |     /**
 51 |      * Field boost factor
 52 |      * It's not stored directly in the index, but affects on normalization factor
 53 |      *
 54 |      * @var float
 55 |      */
 56 |     public $boost = 1.0;
 57 | 
 58 |     /**
 59 |      * Proxy method for getFieldValue(), provides more convenient access to
 60 |      * the string value of a field.
 61 |      *
 62 |      * @param  $offset
 63 |      * @return string
 64 |      */
 65 |     public function __get($offset)
 66 |     {
 67 |         return $this->getFieldValue($offset);
 68 |     }
 69 | 
 70 | 
 71 |     /**
 72 |      * Add a field object to this document.
 73 |      *
 74 |      * @param  Zend_Search_Lucene_Field $field
 75 |      * @return Zend_Search_Lucene_Document
 76 |      */
 77 |     public function addField(Zend_Search_Lucene_Field $field)
 78 |     {
 79 |         $this->_fields[$field->name] = $field;
 80 | 
 81 |         return $this;
 82 |     }
 83 | 
 84 | 
 85 |     /**
 86 |      * Return an array with the names of the fields in this document.
 87 |      *
 88 |      * @return array
 89 |      */
 90 |     public function getFieldNames()
 91 |     {
 92 |         return array_keys($this->_fields);
 93 |     }
 94 | 
 95 | 
 96 |     /**
 97 |      * Returns Zend_Search_Lucene_Field object for a named field in this document.
 98 |      *
 99 |      * @param  string $fieldName
100 |      * @return Zend_Search_Lucene_Field
101 |      */
102 |     public function getField($fieldName)
103 |     {
104 |         if (!array_key_exists($fieldName, $this->_fields)) {
105 |             include_once 'Zend/Search/Lucene/Exception.php';
106 |             throw new Zend_Search_Lucene_Exception("Field name \"$fieldName\" not found in document.");
107 |         }
108 |         return $this->_fields[$fieldName];
109 |     }
110 | 
111 | 
112 |     /**
113 |      * Returns the string value of a named field in this document.
114 |      *
115 |      * @see    __get()
116 |      * @return string
117 |      */
118 |     public function getFieldValue($fieldName)
119 |     {
120 |         return $this->getField($fieldName)->value;
121 |     }
122 | 
123 |     /**
124 |      * Returns the string value of a named field in UTF-8 encoding.
125 |      *
126 |      * @see    __get()
127 |      * @return string
128 |      */
129 |     public function getFieldUtf8Value($fieldName)
130 |     {
131 |         return $this->getField($fieldName)->getUtf8Value();
132 |     }
133 | }
134 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Document/Exception.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category  Zend
16 |  * @package   Zend_Search_Lucene
17 |  * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
18 |  * @license   http://framework.zend.com/license/new-bsd     New BSD License
19 |  * @version   $Id: Exception.php 20096 2010-01-06 02:05:09Z bkarwin $
20 |  */
21 | 
22 | 
23 | /**
24 |  * Framework base exception
25 |  */
26 | require_once 'Zend/Search/Lucene/Exception.php';
27 | 
28 | 
29 | /**
30 |  * @category   Zend
31 |  * @package    Zend_Search_Lucene
32 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
33 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
34 |  */
35 | class Zend_Search_Lucene_Document_Exception extends Zend_Search_Lucene_Exception
36 | {
37 | 
38 | }
39 | 
40 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Document/OpenXml.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Document
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: OpenXml.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | 
 24 | /**
 25 |  * Zend_Search_Lucene_Document 
 26 | */
 27 | require_once 'Zend/Search/Lucene/Document.php';
 28 | 
 29 | 
 30 | /**
 31 |  * OpenXML document.
 32 |  *
 33 |  * @category   Zend
 34 |  * @package    Zend_Search_Lucene
 35 |  * @subpackage Document
 36 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 37 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 38 |  */
 39 | abstract class Zend_Search_Lucene_Document_OpenXml extends Zend_Search_Lucene_Document
 40 | {
 41 |     /**
 42 |      * Xml Schema - Relationships
 43 |      *
 44 |      * @var string
 45 |      */
 46 |     const SCHEMA_RELATIONSHIP = 'http://schemas.openxmlformats.org/package/2006/relationships';
 47 | 
 48 |     /**
 49 |      * Xml Schema - Office document
 50 |      *
 51 |      * @var string
 52 |      */
 53 |     const SCHEMA_OFFICEDOCUMENT = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument';
 54 | 
 55 |     /**
 56 |      * Xml Schema - Core properties
 57 |      *
 58 |      * @var string
 59 |      */
 60 |     const SCHEMA_COREPROPERTIES = 'http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties';
 61 | 
 62 |     /**
 63 |      * Xml Schema - Dublin Core
 64 |      *
 65 |      * @var string
 66 |      */
 67 |     const SCHEMA_DUBLINCORE = 'http://purl.org/dc/elements/1.1/';
 68 | 
 69 |     /**
 70 |      * Xml Schema - Dublin Core Terms
 71 |      *
 72 |      * @var string
 73 |      */
 74 |     const SCHEMA_DUBLINCORETERMS = 'http://purl.org/dc/terms/';
 75 | 
 76 |     /**
 77 |      * Extract metadata from document
 78 |      *
 79 |      * @param  ZipArchive $package ZipArchive OpenXML package
 80 |      * @return array    Key-value pairs containing document meta data
 81 |      */
 82 |     protected function extractMetaData(ZipArchive $package)
 83 |     {
 84 |         // Data holders
 85 |         $coreProperties = array();
 86 | 
 87 |         // Read relations and search for core properties
 88 |         $relations = simplexml_load_string($package->getFromName("_rels/.rels"));
 89 |         foreach ($relations->Relationship as $rel) {
 90 |             if ($rel["Type"] == Zend_Search_Lucene_Document_OpenXml::SCHEMA_COREPROPERTIES) {
 91 |                 // Found core properties! Read in contents...
 92 |                 $contents = simplexml_load_string(
 93 |                     $package->getFromName(dirname($rel["Target"]) . "/" . basename($rel["Target"]))
 94 |                 );
 95 | 
 96 |                 foreach ($contents->children(Zend_Search_Lucene_Document_OpenXml::SCHEMA_DUBLINCORE) as $child) {
 97 |                     $coreProperties[$child->getName()] = (string)$child;
 98 |                 }
 99 |                 foreach ($contents->children(Zend_Search_Lucene_Document_OpenXml::SCHEMA_COREPROPERTIES) as $child) {
100 |                     $coreProperties[$child->getName()] = (string)$child;
101 |                 }
102 |                 foreach ($contents->children(Zend_Search_Lucene_Document_OpenXml::SCHEMA_DUBLINCORETERMS) as $child) {
103 |                     $coreProperties[$child->getName()] = (string)$child;
104 |                 }
105 |             }
106 |         }
107 | 
108 |         return $coreProperties;
109 |     }
110 | 
111 |     /**
112 |      * Determine absolute zip path
113 |      *
114 |      * @param  string $path
115 |      * @return string
116 |      */
117 |     protected function absoluteZipPath($path) 
118 |     {
119 |         $path = str_replace(array('/', '\\'), DIRECTORY_SEPARATOR, $path);
120 |         $parts = array_filter(explode(DIRECTORY_SEPARATOR, $path), 'strlen');
121 |         $absolutes = array();
122 |         foreach ($parts as $part) {
123 |             if ('.' == $part) { continue;
124 |             }
125 |             if ('..' == $part) {
126 |                 array_pop($absolutes);
127 |             } else {
128 |                 $absolutes[] = $part;
129 |             }
130 |         }
131 |         return implode('/', $absolutes);
132 |     }
133 | }
134 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Exception.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category  Zend
16 |  * @package   Zend_Search_Lucene
17 |  * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
18 |  * @license   http://framework.zend.com/license/new-bsd     New BSD License
19 |  * @version   $Id: Exception.php 20096 2010-01-06 02:05:09Z bkarwin $
20 |  */
21 | 
22 | 
23 | /**
24 |  * Framework base exception
25 |  */
26 | require_once 'Zend/Search/Exception.php';
27 | 
28 | 
29 | /**
30 |  * @category   Zend
31 |  * @package    Zend_Search_Lucene
32 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
33 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
34 |  */
35 | class Zend_Search_Lucene_Exception extends Zend_Search_Exception
36 | {
37 | 
38 | }
39 | 
40 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/FSMAction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category  Zend
16 |  * @package   Zend_Search_Lucene
17 |  * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
18 |  * @license   http://framework.zend.com/license/new-bsd     New BSD License
19 |  * @version   $Id: FSMAction.php 20096 2010-01-06 02:05:09Z bkarwin $
20 |  */
21 | 
22 | 
23 | /**
24 |  * Abstract Finite State Machine
25 |  *
26 |  * @category  Zend
27 |  * @package   Zend_Search_Lucene
28 |  * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
29 |  * @license   http://framework.zend.com/license/new-bsd     New BSD License
30 |  */
31 | class Zend_Search_Lucene_FSMAction
32 | {
33 |     /**
34 |      * Object reference
35 |      *
36 |      * @var object
37 |      */
38 |     private $_object;
39 | 
40 |     /**
41 |      * Method name
42 |      *
43 |      * @var string
44 |      */
45 |     private $_method;
46 | 
47 |     /**
48 |      * Object constructor
49 |      *
50 |      * @param object $object
51 |      * @param string $method
52 |      */
53 |     public function __construct($object, $method)
54 |     {
55 |         $this->_object = $object;
56 |         $this->_method = $method;
57 |     }
58 | 
59 |     public function doAction()
60 |     {
61 |         $methodName = $this->_method;
62 |         $this->_object->$methodName();
63 |     }
64 | }
65 | 
66 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Index/DocsFilter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Index
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: DocsFilter.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | 
24 | /**
25 |  * A Zend_Search_Lucene_Index_DocsFilter is used to filter documents while searching.
26 |  *
27 |  * It may or _may_not_ be used for actual filtering, so it's just a hint that upper query limits
28 |  * search result by specified list.
29 |  *
30 |  * @category   Zend
31 |  * @package    Zend_Search_Lucene
32 |  * @subpackage Index
33 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
34 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
35 |  */
36 | class Zend_Search_Lucene_Index_DocsFilter
37 | {
38 |     /**
39 |      * Set of segment filters:
40 |      *  array( <segmentName> => array(<docId> => <undefined_value>,
41 |      *                                <docId> => <undefined_value>,
42 |      *                                <docId> => <undefined_value>,
43 |      *                                ...                          ),
44 |      *         <segmentName> => array(<docId> => <undefined_value>,
45 |      *                                <docId> => <undefined_value>,
46 |      *                                <docId> => <undefined_value>,
47 |      *                                ...                          ),
48 |      *         <segmentName> => array(<docId> => <undefined_value>,
49 |      *                                <docId> => <undefined_value>,
50 |      *                                <docId> => <undefined_value>,
51 |      *                                ...                          ),
52 |      *         ...
53 |      *       )
54 |      *
55 |      * @var array
56 |      */
57 |     public $segmentFilters = array();
58 | }
59 | 
60 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Index/FieldInfo.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Index
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: FieldInfo.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | 
24 | /**
25 |  * @category   Zend
26 |  * @package    Zend_Search_Lucene
27 |  * @subpackage Index
28 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
29 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
30 |  */
31 | class Zend_Search_Lucene_Index_FieldInfo
32 | {
33 |     public $name;
34 |     public $isIndexed;
35 |     public $number;
36 |     public $storeTermVector;
37 |     public $normsOmitted;
38 |     public $payloadsStored;
39 | 
40 |     public function __construct($name, $isIndexed, $number, $storeTermVector, $normsOmitted = false, $payloadsStored = false)
41 |     {
42 |         $this->name            = $name;
43 |         $this->isIndexed       = $isIndexed;
44 |         $this->number          = $number;
45 |         $this->storeTermVector = $storeTermVector;
46 |         $this->normsOmitted    = $normsOmitted;
47 |         $this->payloadsStored  = $payloadsStored;
48 |     }
49 | }
50 | 
51 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Index/SegmentWriter/StreamWriter.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Index
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: StreamWriter.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | /**
 24 |  * Zend_Search_Lucene_Index_SegmentWriter 
 25 | */
 26 | require_once 'Zend/Search/Lucene/Index/SegmentWriter.php';
 27 | 
 28 | /**
 29 |  * @category   Zend
 30 |  * @package    Zend_Search_Lucene
 31 |  * @subpackage Index
 32 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 33 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 34 |  */
 35 | class Zend_Search_Lucene_Index_SegmentWriter_StreamWriter extends Zend_Search_Lucene_Index_SegmentWriter
 36 | {
 37 |     /**
 38 |      * Object constructor.
 39 |      *
 40 |      * @param Zend_Search_Lucene_Storage_Directory $directory
 41 |      * @param string                               $name
 42 |      */
 43 |     public function __construct(Zend_Search_Lucene_Storage_Directory $directory, $name)
 44 |     {
 45 |         parent::__construct($directory, $name);
 46 |     }
 47 | 
 48 | 
 49 |     /**
 50 |      * Create stored fields files and open them for write
 51 |      */
 52 |     public function createStoredFieldsFiles()
 53 |     {
 54 |         $this->_fdxFile = $this->_directory->createFile($this->_name . '.fdx');
 55 |         $this->_fdtFile = $this->_directory->createFile($this->_name . '.fdt');
 56 | 
 57 |         $this->_files[] = $this->_name . '.fdx';
 58 |         $this->_files[] = $this->_name . '.fdt';
 59 |     }
 60 | 
 61 |     public function addNorm($fieldName, $normVector)
 62 |     {
 63 |         if (isset($this->_norms[$fieldName])) {
 64 |             $this->_norms[$fieldName] .= $normVector;
 65 |         } else {
 66 |             $this->_norms[$fieldName] = $normVector;
 67 |         }
 68 |     }
 69 | 
 70 |     /**
 71 |      * Close segment, write it to disk and return segment info
 72 |      *
 73 |      * @return Zend_Search_Lucene_Index_SegmentInfo
 74 |      */
 75 |     public function close()
 76 |     {
 77 |         if ($this->_docCount == 0) {
 78 |             return null;
 79 |         }
 80 | 
 81 |         $this->_dumpFNM();
 82 |         $this->_generateCFS();
 83 | 
 84 |         /**
 85 |  * Zend_Search_Lucene_Index_SegmentInfo 
 86 | */
 87 |         include_once 'Zend/Search/Lucene/Index/SegmentInfo.php';
 88 | 
 89 |         return new Zend_Search_Lucene_Index_SegmentInfo(
 90 |             $this->_directory,
 91 |             $this->_name,
 92 |             $this->_docCount,
 93 |             -1,
 94 |             null,
 95 |             true,
 96 |             true
 97 |         );
 98 |     }
 99 | }
100 | 
101 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Index/Term.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Index
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: Term.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | 
 24 | /**
 25 |  * A Term represents a word from text.  This is the unit of search.  It is
 26 |  * composed of two elements, the text of the word, as a string, and the name of
 27 |  * the field that the text occured in, an interned string.
 28 |  *
 29 |  * Note that terms may represent more than words from text fields, but also
 30 |  * things like dates, email addresses, urls, etc.
 31 |  *
 32 |  * @category   Zend
 33 |  * @package    Zend_Search_Lucene
 34 |  * @subpackage Index
 35 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 36 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 37 |  */
 38 | class Zend_Search_Lucene_Index_Term
 39 | {
 40 |     /**
 41 |      * Field name or field number (depending from context)
 42 |      *
 43 |      * @var mixed
 44 |      */
 45 |     public $field;
 46 | 
 47 |     /**
 48 |      * Term value
 49 |      *
 50 |      * @var string
 51 |      */
 52 |     public $text;
 53 | 
 54 | 
 55 |     /**
 56 |      * Object constructor
 57 |      */
 58 |     public function __construct($text, $field = null)
 59 |     {
 60 |         $this->field = ($field === null)?  Zend_Search_Lucene::getDefaultSearchField() : $field;
 61 |         $this->text  = $text;
 62 |     }
 63 | 
 64 | 
 65 |     /**
 66 |      * Returns term key
 67 |      *
 68 |      * @return string
 69 |      */
 70 |     public function key()
 71 |     {
 72 |         return $this->field . chr(0) . $this->text;
 73 |     }
 74 | 
 75 |     /**
 76 |      * Get term prefix
 77 |      *
 78 |      * @param  string  $str
 79 |      * @param  integer $length
 80 |      * @return string
 81 |      */
 82 |     public static function getPrefix($str, $length)
 83 |     {
 84 |         $prefixBytes = 0;
 85 |         $prefixChars = 0;
 86 |         while ($prefixBytes < strlen($str)  &&  $prefixChars < $length) {
 87 |             $charBytes = 1;
 88 |             if ((ord($str[$prefixBytes]) & 0xC0) == 0xC0) {
 89 |                 $charBytes++;
 90 |                 if (ord($str[$prefixBytes]) & 0x20 ) {
 91 |                     $charBytes++;
 92 |                     if (ord($str[$prefixBytes]) & 0x10 ) {
 93 |                         $charBytes++;
 94 |                     }
 95 |                 }
 96 |             }
 97 | 
 98 |             if ($prefixBytes + $charBytes > strlen($str)) {
 99 |                 // wrong character
100 |                 break;
101 |             }
102 | 
103 |             $prefixChars++;
104 |             $prefixBytes += $charBytes;
105 |         }
106 | 
107 |         return substr($str, 0, $prefixBytes);
108 |     }
109 | 
110 |     /**
111 |      * Get UTF-8 string length
112 |      *
113 |      * @param  string $str
114 |      * @return string
115 |      */
116 |     public static function getLength($str)
117 |     {
118 |         $bytes = 0;
119 |         $chars = 0;
120 |         while ($bytes < strlen($str)) {
121 |             $charBytes = 1;
122 |             if ((ord($str[$bytes]) & 0xC0) == 0xC0) {
123 |                 $charBytes++;
124 |                 if (ord($str[$bytes]) & 0x20 ) {
125 |                     $charBytes++;
126 |                     if (ord($str[$bytes]) & 0x10 ) {
127 |                         $charBytes++;
128 |                     }
129 |                 }
130 |             }
131 | 
132 |             if ($bytes + $charBytes > strlen($str)) {
133 |                 // wrong character
134 |                 break;
135 |             }
136 | 
137 |             $chars++;
138 |             $bytes += $charBytes;
139 |         }
140 | 
141 |         return $chars;
142 |     }
143 | }
144 | 
145 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Index/TermInfo.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Index
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: TermInfo.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | 
24 | /**
25 |  * A Zend_Search_Lucene_Index_TermInfo represents a record of information stored for a term.
26 |  *
27 |  * @category   Zend
28 |  * @package    Zend_Search_Lucene
29 |  * @subpackage Index
30 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
31 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
32 |  */
33 | class Zend_Search_Lucene_Index_TermInfo
34 | {
35 |     /**
36 |      * The number of documents which contain the term.
37 |      *
38 |      * @var integer
39 |      */
40 |     public $docFreq;
41 | 
42 |     /**
43 |      * Data offset in a Frequencies file.
44 |      *
45 |      * @var integer
46 |      */
47 |     public $freqPointer;
48 | 
49 |     /**
50 |      * Data offset in a Positions file.
51 |      *
52 |      * @var integer
53 |      */
54 |     public $proxPointer;
55 | 
56 |     /**
57 |      * ScipData offset in a Frequencies file.
58 |      *
59 |      * @var integer
60 |      */
61 |     public $skipOffset;
62 | 
63 |     /**
64 |      * Term offset of the _next_ term in a TermDictionary file.
65 |      * Used only for Term Index
66 |      *
67 |      * @var integer
68 |      */
69 |     public $indexPointer;
70 | 
71 |     public function __construct($docFreq, $freqPointer, $proxPointer, $skipOffset, $indexPointer = null)
72 |     {
73 |         $this->docFreq      = $docFreq;
74 |         $this->freqPointer  = $freqPointer;
75 |         $this->proxPointer  = $proxPointer;
76 |         $this->skipOffset   = $skipOffset;
77 |         $this->indexPointer = $indexPointer;
78 |     }
79 | }
80 | 
81 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Index/TermsPriorityQueue.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Index
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: TermsPriorityQueue.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | /**
24 |  * Zend_Search_Lucene_PriorityQueue 
25 | */
26 | require_once 'Zend/Search/Lucene/PriorityQueue.php';
27 | 
28 | /**
29 |  * @category   Zend
30 |  * @package    Zend_Search_Lucene
31 |  * @subpackage Index
32 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
33 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
34 |  */
35 | class Zend_Search_Lucene_Index_TermsPriorityQueue extends Zend_Search_Lucene_PriorityQueue
36 | {
37 |     /**
38 |      * Compare elements
39 |      *
40 |      * Returns true, if $termsStream1 is "less" than $termsStream2; else otherwise
41 |      *
42 |      * @param  mixed $termsStream1
43 |      * @param  mixed $termsStream2
44 |      * @return boolean
45 |      */
46 |     protected function _less($termsStream1, $termsStream2)
47 |     {
48 |         return strcmp($termsStream1->currentTerm()->key(), $termsStream2->currentTerm()->key()) < 0;
49 |     }
50 | 
51 | }
52 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Index/TermsStream/Interface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Index
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | /**
24 |  * @category   Zend
25 |  * @package    Zend_Search_Lucene
26 |  * @subpackage Index
27 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
28 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
29 |  */
30 | interface Zend_Search_Lucene_Index_TermsStream_Interface
31 | {
32 |     /**
33 |      * Reset terms stream.
34 |      */
35 |     public function resetTermsStream();
36 | 
37 |     /**
38 |      * Skip terms stream up to specified term preffix.
39 |      *
40 |      * Prefix contains fully specified field info and portion of searched term
41 |      *
42 |      * @param Zend_Search_Lucene_Index_Term $prefix
43 |      */
44 |     public function skipTo(Zend_Search_Lucene_Index_Term $prefix);
45 | 
46 |     /**
47 |      * Scans terms dictionary and returns next term
48 |      *
49 |      * @return Zend_Search_Lucene_Index_Term|null
50 |      */
51 |     public function nextTerm();
52 | 
53 |     /**
54 |      * Returns term in current position
55 |      *
56 |      * @return Zend_Search_Lucene_Index_Term|null
57 |      */
58 |     public function currentTerm();
59 | 
60 |     /**
61 |      * Close terms stream
62 |      *
63 |      * Should be used for resources clean up if stream is not read up to the end
64 |      */
65 |     public function closeTermsStream();
66 | }
67 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/PriorityQueue.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category  Zend
 16 |  * @package   Zend_Search_Lucene
 17 |  * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 18 |  * @license   http://framework.zend.com/license/new-bsd     New BSD License
 19 |  * @version   $Id: PriorityQueue.php 20096 2010-01-06 02:05:09Z bkarwin $
 20 |  */
 21 | 
 22 | 
 23 | /**
 24 |  * Abstract Priority Queue
 25 |  *
 26 |  * It implements a priority queue.
 27 |  * Please go to "Data Structures and Algorithms",
 28 |  * Aho, Hopcroft, and Ullman, Addison-Wesley, 1983 (corrected 1987 edition),
 29 |  * for implementation details.
 30 |  *
 31 |  * It provides O(log(N)) time of put/pop operations, where N is a size of queue
 32 |  *
 33 |  * @category  Zend
 34 |  * @package   Zend_Search_Lucene
 35 |  * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 36 |  * @license   http://framework.zend.com/license/new-bsd     New BSD License
 37 |  */
 38 | abstract class Zend_Search_Lucene_PriorityQueue
 39 | {
 40 |     /**
 41 |      * Queue heap
 42 |      *
 43 |      * Heap contains balanced partial ordered binary tree represented in array
 44 |      * [0] - top of the tree
 45 |      * [1] - first child of [0]
 46 |      * [2] - second child of [0]
 47 |      * ...
 48 |      * [2*n + 1] - first child of [n]
 49 |      * [2*n + 2] - second child of [n]
 50 |      *
 51 |      * @var array
 52 |      */
 53 |     private $_heap = array();
 54 | 
 55 | 
 56 |     /**
 57 |      * Add element to the queue
 58 |      *
 59 |      * O(log(N)) time
 60 |      *
 61 |      * @param mixed $element
 62 |      */
 63 |     public function put($element)
 64 |     {
 65 |         $nodeId   = count($this->_heap);
 66 |         $parentId = ($nodeId-1) >> 1;   // floor( ($nodeId-1)/2 )
 67 | 
 68 |         while ($nodeId != 0  &&  $this->_less($element, $this->_heap[$parentId])) {
 69 |             // Move parent node down
 70 |             $this->_heap[$nodeId] = $this->_heap[$parentId];
 71 | 
 72 |             // Move pointer to the next level of tree
 73 |             $nodeId   = $parentId;
 74 |             $parentId = ($nodeId-1) >> 1;   // floor( ($nodeId-1)/2 )
 75 |         }
 76 | 
 77 |         // Put new node into the tree
 78 |         $this->_heap[$nodeId] = $element;
 79 |     }
 80 | 
 81 | 
 82 |     /**
 83 |      * Return least element of the queue
 84 |      *
 85 |      * Constant time
 86 |      *
 87 |      * @return mixed
 88 |      */
 89 |     public function top()
 90 |     {
 91 |         if (count($this->_heap) == 0) {
 92 |             return null;
 93 |         }
 94 | 
 95 |         return $this->_heap[0];
 96 |     }
 97 | 
 98 | 
 99 |     /**
100 |      * Removes and return least element of the queue
101 |      *
102 |      * O(log(N)) time
103 |      *
104 |      * @return mixed
105 |      */
106 |     public function pop()
107 |     {
108 |         if (count($this->_heap) == 0) {
109 |             return null;
110 |         }
111 | 
112 |         $top = $this->_heap[0];
113 |         $lastId = count($this->_heap) - 1;
114 | 
115 |         /**
116 |          * Find appropriate position for last node
117 |          */
118 |         $nodeId  = 0;     // Start from a top
119 |         $childId = 1;     // First child
120 | 
121 |         // Choose smaller child
122 |         if ($lastId > 2  &&  $this->_less($this->_heap[2], $this->_heap[1])) {
123 |             $childId = 2;
124 |         }
125 | 
126 |         while ($childId < $lastId  &&
127 |                $this->_less($this->_heap[$childId], $this->_heap[$lastId])
128 |           ) {
129 |             // Move child node up
130 |             $this->_heap[$nodeId] = $this->_heap[$childId];
131 | 
132 |             $nodeId  = $childId;               // Go down
133 |             $childId = ($nodeId << 1) + 1;     // First child
134 | 
135 |             // Choose smaller child
136 |             if (($childId+1) < $lastId  
137 |                 && $this->_less($this->_heap[$childId+1], $this->_heap[$childId])
138 |             ) {
139 |                 $childId++;
140 |             }
141 |         }
142 | 
143 |         // Move last element to the new position
144 |         $this->_heap[$nodeId] = $this->_heap[$lastId];
145 |         unset($this->_heap[$lastId]);
146 | 
147 |         return $top;
148 |     }
149 | 
150 | 
151 |     /**
152 |      * Clear queue
153 |      */
154 |     public function clear()
155 |     {
156 |         $this->_heap = array();
157 |     }
158 | 
159 | 
160 |     /**
161 |      * Compare elements
162 |      *
163 |      * Returns true, if $el1 is less than $el2; else otherwise
164 |      *
165 |      * @param  mixed $el1
166 |      * @param  mixed $el2
167 |      * @return boolean
168 |      */
169 |     abstract protected function _less($el1, $el2);
170 | }
171 | 
172 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/Highlighter/Default.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Search
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: Default.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | /**
24 |  * @see Zend_Search_Lucene_Search_Highlighter_Interface 
25 | */
26 | require_once 'Zend/Search/Lucene/Search/Highlighter/Interface.php';
27 | /**
28 |  * @category   Zend
29 |  * @package    Zend_Search_Lucene
30 |  * @subpackage Search
31 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
32 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
33 |  */
34 | class Zend_Search_Lucene_Search_Highlighter_Default implements Zend_Search_Lucene_Search_Highlighter_Interface
35 | {
36 |     /**
37 |      * List of colors for text highlighting
38 |      *
39 |      * @var array
40 |      */
41 |     protected $_highlightColors = array('#66ffff', '#ff66ff', '#ffff66',
42 |                                         '#ff8888', '#88ff88', '#8888ff',
43 |                                         '#88dddd', '#dd88dd', '#dddd88',
44 |                                         '#aaddff', '#aaffdd', '#ddaaff',
45 |                                         '#ddffaa', '#ffaadd', '#ffddaa');
46 | 
47 |     /**
48 |      * Index of current color for highlighting
49 |      *
50 |      * Index is increased at each highlight() call, so terms matching different queries are highlighted using different colors.
51 |      *
52 |      * @var integer
53 |      */
54 |     protected $_currentColorIndex = 0;
55 | 
56 |     /**
57 |      * HTML document for highlighting
58 |      *
59 |      * @var Zend_Search_Lucene_Document_Html
60 |      */
61 |     protected $_doc;
62 | 
63 |     /**
64 |      * Set document for highlighting.
65 |      *
66 |      * @param Zend_Search_Lucene_Document_Html $document
67 |      */
68 |     public function setDocument(Zend_Search_Lucene_Document_Html $document)
69 |     {
70 |         $this->_doc = $document;
71 |     }
72 | 
73 |     /**
74 |      * Get document for highlighting.
75 |      *
76 |      * @return Zend_Search_Lucene_Document_Html $document
77 |      */
78 |     public function getDocument()
79 |     {
80 |         return $this->_doc;
81 |     }
82 | 
83 |     /**
84 |      * Highlight specified words
85 |      *
86 |      * @param string|array $words Words to highlight. They could be organized using the array or string.
87 |      */
88 |     public function highlight($words)
89 |     {
90 |         $color = $this->_highlightColors[$this->_currentColorIndex];
91 |         $this->_currentColorIndex = ($this->_currentColorIndex + 1) % count($this->_highlightColors);
92 | 
93 |         $this->_doc->highlight($words, $color);
94 |     }
95 | 
96 | }
97 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/Highlighter/Interface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Search
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | 
24 | /**
25 |  * @category   Zend
26 |  * @package    Zend_Search_Lucene
27 |  * @subpackage Search
28 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
29 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
30 |  */
31 | interface Zend_Search_Lucene_Search_Highlighter_Interface
32 | {
33 |     /**
34 |      * Set document for highlighting.
35 |      *
36 |      * @param Zend_Search_Lucene_Document_Html $document
37 |      */
38 |     public function setDocument(Zend_Search_Lucene_Document_Html $document);
39 | 
40 |     /**
41 |      * Get document for highlighting.
42 |      *
43 |      * @return Zend_Search_Lucene_Document_Html $document
44 |      */
45 |     public function getDocument();
46 | 
47 |     /**
48 |      * Highlight specified words (method is invoked once per subquery)
49 |      *
50 |      * @param string|array $words Words to highlight. They could be organized using the array or string.
51 |      */
52 |     public function highlight($words);
53 | }
54 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/Query/Empty.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Search
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: Empty.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | 
 24 | /**
 25 |  * Zend_Search_Lucene_Search_Query 
 26 | */
 27 | require_once 'Zend/Search/Lucene/Search/Query.php';
 28 | 
 29 | 
 30 | /**
 31 |  * @category   Zend
 32 |  * @package    Zend_Search_Lucene
 33 |  * @subpackage Search
 34 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 35 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 36 |  */
 37 | class Zend_Search_Lucene_Search_Query_Empty extends Zend_Search_Lucene_Search_Query
 38 | {
 39 |     /**
 40 |      * Re-write query into primitive queries in the context of specified index
 41 |      *
 42 |      * @param  Zend_Search_Lucene_Interface $index
 43 |      * @return Zend_Search_Lucene_Search_Query
 44 |      */
 45 |     public function rewrite(Zend_Search_Lucene_Interface $index)
 46 |     {
 47 |         return $this;
 48 |     }
 49 | 
 50 |     /**
 51 |      * Optimize query in the context of specified index
 52 |      *
 53 |      * @param  Zend_Search_Lucene_Interface $index
 54 |      * @return Zend_Search_Lucene_Search_Query
 55 |      */
 56 |     public function optimize(Zend_Search_Lucene_Interface $index)
 57 |     {
 58 |         // "Empty" query is a primitive query and don't need to be optimized
 59 |         return $this;
 60 |     }
 61 | 
 62 |     /**
 63 |      * Constructs an appropriate Weight implementation for this query.
 64 |      *
 65 |      * @param  Zend_Search_Lucene_Interface $reader
 66 |      * @return Zend_Search_Lucene_Search_Weight
 67 |      */
 68 |     public function createWeight(Zend_Search_Lucene_Interface $reader)
 69 |     {
 70 |         include_once 'Zend/Search/Lucene/Search/Weight/Empty.php';
 71 |         return new Zend_Search_Lucene_Search_Weight_Empty();
 72 |     }
 73 | 
 74 |     /**
 75 |      * Execute query in context of index reader
 76 |      * It also initializes necessary internal structures
 77 |      *
 78 |      * @param Zend_Search_Lucene_Interface             $reader
 79 |      * @param Zend_Search_Lucene_Index_DocsFilter|null $docsFilter
 80 |      */
 81 |     public function execute(Zend_Search_Lucene_Interface $reader, $docsFilter = null)
 82 |     {
 83 |         // Do nothing
 84 |     }
 85 | 
 86 |     /**
 87 |      * Get document ids likely matching the query
 88 |      *
 89 |      * It's an array with document ids as keys (performance considerations)
 90 |      *
 91 |      * @return array
 92 |      */
 93 |     public function matchedDocs()
 94 |     {
 95 |         return array();
 96 |     }
 97 | 
 98 |     /**
 99 |      * Score specified document
100 |      *
101 |      * @param  integer                      $docId
102 |      * @param  Zend_Search_Lucene_Interface $reader
103 |      * @return float
104 |      */
105 |     public function score($docId, Zend_Search_Lucene_Interface $reader)
106 |     {
107 |         return 0;
108 |     }
109 | 
110 |     /**
111 |      * Return query terms
112 |      *
113 |      * @return array
114 |      */
115 |     public function getQueryTerms()
116 |     {
117 |         return array();
118 |     }
119 | 
120 |     /**
121 |      * Query specific matches highlighting
122 |      *
123 |      * @param Zend_Search_Lucene_Search_Highlighter_Interface $highlighter Highlighter object (also contains doc for highlighting)
124 |      */
125 |     protected function _highlightMatches(Zend_Search_Lucene_Search_Highlighter_Interface $highlighter)
126 |     {
127 |         // Do nothing
128 |     }
129 | 
130 |     /**
131 |      * Print a query
132 |      *
133 |      * @return string
134 |      */
135 |     public function __toString()
136 |     {
137 |         return '<EmptyQuery>';
138 |     }
139 | }
140 | 
141 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/Query/Insignificant.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Search
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: Insignificant.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | 
 24 | /**
 25 |  * Zend_Search_Lucene_Search_Query 
 26 | */
 27 | require_once 'Zend/Search/Lucene/Search/Query.php';
 28 | 
 29 | 
 30 | /**
 31 |  * The insignificant query returns empty result, but doesn't limit result set as a part of other queries
 32 |  *
 33 |  * @category   Zend
 34 |  * @package    Zend_Search_Lucene
 35 |  * @subpackage Search
 36 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 37 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 38 |  */
 39 | class Zend_Search_Lucene_Search_Query_Insignificant extends Zend_Search_Lucene_Search_Query
 40 | {
 41 |     /**
 42 |      * Re-write query into primitive queries in the context of specified index
 43 |      *
 44 |      * @param  Zend_Search_Lucene_Interface $index
 45 |      * @return Zend_Search_Lucene_Search_Query
 46 |      */
 47 |     public function rewrite(Zend_Search_Lucene_Interface $index)
 48 |     {
 49 |         return $this;
 50 |     }
 51 | 
 52 |     /**
 53 |      * Optimize query in the context of specified index
 54 |      *
 55 |      * @param  Zend_Search_Lucene_Interface $index
 56 |      * @return Zend_Search_Lucene_Search_Query
 57 |      */
 58 |     public function optimize(Zend_Search_Lucene_Interface $index)
 59 |     {
 60 |         return $this;
 61 |     }
 62 | 
 63 |     /**
 64 |      * Constructs an appropriate Weight implementation for this query.
 65 |      *
 66 |      * @param  Zend_Search_Lucene_Interface $reader
 67 |      * @return Zend_Search_Lucene_Search_Weight
 68 |      */
 69 |     public function createWeight(Zend_Search_Lucene_Interface $reader)
 70 |     {
 71 |         include_once 'Zend/Search/Lucene/Search/Weight/Empty.php';
 72 |         return new Zend_Search_Lucene_Search_Weight_Empty();
 73 |     }
 74 | 
 75 |     /**
 76 |      * Execute query in context of index reader
 77 |      * It also initializes necessary internal structures
 78 |      *
 79 |      * @param Zend_Search_Lucene_Interface             $reader
 80 |      * @param Zend_Search_Lucene_Index_DocsFilter|null $docsFilter
 81 |      */
 82 |     public function execute(Zend_Search_Lucene_Interface $reader, $docsFilter = null)
 83 |     {
 84 |         // Do nothing
 85 |     }
 86 | 
 87 |     /**
 88 |      * Get document ids likely matching the query
 89 |      *
 90 |      * It's an array with document ids as keys (performance considerations)
 91 |      *
 92 |      * @return array
 93 |      */
 94 |     public function matchedDocs()
 95 |     {
 96 |         return array();
 97 |     }
 98 | 
 99 |     /**
100 |      * Score specified document
101 |      *
102 |      * @param  integer                      $docId
103 |      * @param  Zend_Search_Lucene_Interface $reader
104 |      * @return float
105 |      */
106 |     public function score($docId, Zend_Search_Lucene_Interface $reader)
107 |     {
108 |         return 0;
109 |     }
110 | 
111 |     /**
112 |      * Return query terms
113 |      *
114 |      * @return array
115 |      */
116 |     public function getQueryTerms()
117 |     {
118 |         return array();
119 |     }
120 | 
121 |     /**
122 |      * Query specific matches highlighting
123 |      *
124 |      * @param Zend_Search_Lucene_Search_Highlighter_Interface $highlighter Highlighter object (also contains doc for highlighting)
125 |      */
126 |     protected function _highlightMatches(Zend_Search_Lucene_Search_Highlighter_Interface $highlighter)
127 |     {
128 |         // Do nothing
129 |     }
130 | 
131 |     /**
132 |      * Print a query
133 |      *
134 |      * @return string
135 |      */
136 |     public function __toString()
137 |     {
138 |         return '<InsignificantQuery>';
139 |     }
140 | }
141 | 
142 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/Query/Preprocessing.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Search
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: Preprocessing.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | 
 24 | /**
 25 |  * Zend_Search_Lucene_Search_Query 
 26 | */
 27 | require_once 'Zend/Search/Lucene/Search/Query.php';
 28 | 
 29 | 
 30 | /**
 31 |  * It's an internal abstract class intended to finalize ase a query processing after query parsing.
 32 |  * This type of query is not actually involved into query execution.
 33 |  *
 34 |  * @category   Zend
 35 |  * @package    Zend_Search_Lucene
 36 |  * @subpackage Search
 37 |  * @internal
 38 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 39 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 40 |  */
 41 | abstract class Zend_Search_Lucene_Search_Query_Preprocessing extends Zend_Search_Lucene_Search_Query
 42 | {
 43 |     /**
 44 |      * Matched terms.
 45 |      *
 46 |      * Matched terms list.
 47 |      * It's filled during rewrite operation and may be used for search result highlighting
 48 |      *
 49 |      * Array of Zend_Search_Lucene_Index_Term objects
 50 |      *
 51 |      * @var array
 52 |      */
 53 |     protected $_matches = null;
 54 | 
 55 |     /**
 56 |      * Optimize query in the context of specified index
 57 |      *
 58 |      * @param  Zend_Search_Lucene_Interface $index
 59 |      * @return Zend_Search_Lucene_Search_Query
 60 |      */
 61 |     public function optimize(Zend_Search_Lucene_Interface $index)
 62 |     {
 63 |         include_once 'Zend/Search/Lucene/Exception.php';
 64 |         throw new Zend_Search_Lucene_Exception('This query is not intended to be executed.');
 65 |     }
 66 | 
 67 |     /**
 68 |      * Constructs an appropriate Weight implementation for this query.
 69 |      *
 70 |      * @param  Zend_Search_Lucene_Interface $reader
 71 |      * @return Zend_Search_Lucene_Search_Weight
 72 |      */
 73 |     public function createWeight(Zend_Search_Lucene_Interface $reader)
 74 |     {
 75 |         include_once 'Zend/Search/Lucene/Exception.php';
 76 |         throw new Zend_Search_Lucene_Exception('This query is not intended to be executed.');
 77 |     }
 78 | 
 79 |     /**
 80 |      * Execute query in context of index reader
 81 |      * It also initializes necessary internal structures
 82 |      *
 83 |      * @param Zend_Search_Lucene_Interface             $reader
 84 |      * @param Zend_Search_Lucene_Index_DocsFilter|null $docsFilter
 85 |      */
 86 |     public function execute(Zend_Search_Lucene_Interface $reader, $docsFilter = null)
 87 |     {
 88 |         include_once 'Zend/Search/Lucene/Exception.php';
 89 |         throw new Zend_Search_Lucene_Exception('This query is not intended to be executed.');
 90 |     }
 91 | 
 92 |     /**
 93 |      * Get document ids likely matching the query
 94 |      *
 95 |      * It's an array with document ids as keys (performance considerations)
 96 |      *
 97 |      * @return array
 98 |      */
 99 |     public function matchedDocs()
100 |     {
101 |         include_once 'Zend/Search/Lucene/Exception.php';
102 |         throw new Zend_Search_Lucene_Exception('This query is not intended to be executed.');
103 |     }
104 | 
105 |     /**
106 |      * Score specified document
107 |      *
108 |      * @param  integer                      $docId
109 |      * @param  Zend_Search_Lucene_Interface $reader
110 |      * @return float
111 |      */
112 |     public function score($docId, Zend_Search_Lucene_Interface $reader)
113 |     {
114 |         include_once 'Zend/Search/Lucene/Exception.php';
115 |         throw new Zend_Search_Lucene_Exception('This query is not intended to be executed.');
116 |     }
117 | 
118 |     /**
119 |      * Return query terms
120 |      *
121 |      * @return array
122 |      */
123 |     public function getQueryTerms()
124 |     {
125 |         include_once 'Zend/Search/Lucene/Exception.php';
126 |         throw new Zend_Search_Lucene_Exception('Rewrite operation has to be done before retrieving query terms.');
127 |     }
128 | }
129 | 
130 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/QueryEntry.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Search
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: QueryEntry.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | /**
24 |  * @category   Zend
25 |  * @package    Zend_Search_Lucene
26 |  * @subpackage Search
27 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
28 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
29 |  */
30 | abstract class Zend_Search_Lucene_Search_QueryEntry
31 | {
32 |     /**
33 |      * Query entry boost factor
34 |      *
35 |      * @var float
36 |      */
37 |     protected $_boost = 1.0;
38 | 
39 | 
40 |     /**
41 |      * Process modifier ('~')
42 |      *
43 |      * @param mixed $parameter
44 |      */
45 |     abstract public function processFuzzyProximityModifier($parameter = null);
46 | 
47 | 
48 |     /**
49 |      * Transform entry to a subquery
50 |      *
51 |      * @param  string $encoding
52 |      * @return Zend_Search_Lucene_Search_Query
53 |      */
54 |     abstract public function getQuery($encoding);
55 | 
56 |     /**
57 |      * Boost query entry
58 |      *
59 |      * @param float $boostFactor
60 |      */
61 |     public function boost($boostFactor)
62 |     {
63 |         $this->_boost *= $boostFactor;
64 |     }
65 | 
66 | 
67 | }
68 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/QueryEntry/Phrase.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Search
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: Phrase.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | /**
 24 |  * Zend_Search_Lucene_Search_QueryEntry 
 25 | */
 26 | require_once 'Zend/Search/Lucene/Search/QueryEntry.php';
 27 | 
 28 | /**
 29 |  * @category   Zend
 30 |  * @package    Zend_Search_Lucene
 31 |  * @subpackage Search
 32 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 33 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 34 |  */
 35 | class Zend_Search_Lucene_Search_QueryEntry_Phrase extends Zend_Search_Lucene_Search_QueryEntry
 36 | {
 37 |     /**
 38 |      * Phrase value
 39 |      *
 40 |      * @var string
 41 |      */
 42 |     private $_phrase;
 43 | 
 44 |     /**
 45 |      * Field
 46 |      *
 47 |      * @var string|null
 48 |      */
 49 |     private $_field;
 50 | 
 51 | 
 52 |     /**
 53 |      * Proximity phrase query
 54 |      *
 55 |      * @var boolean
 56 |      */
 57 |     private $_proximityQuery = false;
 58 | 
 59 |     /**
 60 |      * Words distance, used for proximiti queries
 61 |      *
 62 |      * @var integer
 63 |      */
 64 |     private $_wordsDistance = 0;
 65 | 
 66 | 
 67 |     /**
 68 |      * Object constractor
 69 |      *
 70 |      * @param string $phrase
 71 |      * @param string $field
 72 |      */
 73 |     public function __construct($phrase, $field)
 74 |     {
 75 |         $this->_phrase = $phrase;
 76 |         $this->_field  = $field;
 77 |     }
 78 | 
 79 |     /**
 80 |      * Process modifier ('~')
 81 |      *
 82 |      * @param mixed $parameter
 83 |      */
 84 |     public function processFuzzyProximityModifier($parameter = null)
 85 |     {
 86 |         $this->_proximityQuery = true;
 87 | 
 88 |         if ($parameter !== null) {
 89 |             $this->_wordsDistance = $parameter;
 90 |         }
 91 |     }
 92 | 
 93 |     /**
 94 |      * Transform entry to a subquery
 95 |      *
 96 |      * @param  string $encoding
 97 |      * @return Zend_Search_Lucene_Search_Query
 98 |      * @throws Zend_Search_Lucene_Search_QueryParserException
 99 |      */
100 |     public function getQuery($encoding)
101 |     {
102 |         /**
103 |  * Zend_Search_Lucene_Search_Query_Preprocessing_Phrase 
104 | */
105 |         include_once 'Zend/Search/Lucene/Search/Query/Preprocessing/Phrase.php';
106 |         $query = new Zend_Search_Lucene_Search_Query_Preprocessing_Phrase(
107 |             $this->_phrase,
108 |             $encoding,
109 |             ($this->_field !== null)?
110 |                                                                               iconv($encoding, 'UTF-8', $this->_field) :
111 |             null
112 |         );
113 | 
114 |         if ($this->_proximityQuery) {
115 |             $query->setSlop($this->_wordsDistance);
116 |         }
117 | 
118 |         $query->setBoost($this->_boost);
119 | 
120 |         return $query;
121 |     }
122 | }
123 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/QueryEntry/Subquery.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Search
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: Subquery.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | /**
24 |  * Zend_Search_Lucene_Search_QueryEntry 
25 | */
26 | require_once 'Zend/Search/Lucene/Search/QueryEntry.php';
27 | 
28 | /**
29 |  * @category   Zend
30 |  * @package    Zend_Search_Lucene
31 |  * @subpackage Search
32 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
33 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
34 |  */
35 | class Zend_Search_Lucene_Search_QueryEntry_Subquery extends Zend_Search_Lucene_Search_QueryEntry
36 | {
37 |     /**
38 |      * Query
39 |      *
40 |      * @var Zend_Search_Lucene_Search_Query
41 |      */
42 |     private $_query;
43 | 
44 |     /**
45 |      * Object constractor
46 |      *
47 |      * @param Zend_Search_Lucene_Search_Query $query
48 |      */
49 |     public function __construct(Zend_Search_Lucene_Search_Query $query)
50 |     {
51 |         $this->_query = $query;
52 |     }
53 | 
54 |     /**
55 |      * Process modifier ('~')
56 |      *
57 |      * @param  mixed $parameter
58 |      * @throws Zend_Search_Lucene_Search_QueryParserException
59 |      */
60 |     public function processFuzzyProximityModifier($parameter = null)
61 |     {
62 |         include_once 'Zend/Search/Lucene/Search/QueryParserException.php';
63 |         throw new Zend_Search_Lucene_Search_QueryParserException('\'~\' sign must follow term or phrase');
64 |     }
65 | 
66 | 
67 |     /**
68 |      * Transform entry to a subquery
69 |      *
70 |      * @param  string $encoding
71 |      * @return Zend_Search_Lucene_Search_Query
72 |      */
73 |     public function getQuery($encoding)
74 |     {
75 |         $this->_query->setBoost($this->_boost);
76 | 
77 |         return $this->_query;
78 |     }
79 | }
80 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/QueryEntry/Term.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Search
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: Term.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | /**
 24 |  * Zend_Search_Lucene_Search_QueryEntry 
 25 | */
 26 | require_once 'Zend/Search/Lucene/Search/QueryEntry.php';
 27 | 
 28 | /**
 29 |  * @category   Zend
 30 |  * @package    Zend_Search_Lucene
 31 |  * @subpackage Search
 32 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 33 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 34 |  */
 35 | class Zend_Search_Lucene_Search_QueryEntry_Term extends Zend_Search_Lucene_Search_QueryEntry
 36 | {
 37 |     /**
 38 |      * Term value
 39 |      *
 40 |      * @var string
 41 |      */
 42 |     private $_term;
 43 | 
 44 |     /**
 45 |      * Field
 46 |      *
 47 |      * @var string|null
 48 |      */
 49 |     private $_field;
 50 | 
 51 | 
 52 |     /**
 53 |      * Fuzzy search query
 54 |      *
 55 |      * @var boolean
 56 |      */
 57 |     private $_fuzzyQuery = false;
 58 | 
 59 |     /**
 60 |      * Similarity
 61 |      *
 62 |      * @var float
 63 |      */
 64 |     private $_similarity = 1.;
 65 | 
 66 | 
 67 |     /**
 68 |      * Object constractor
 69 |      *
 70 |      * @param string $term
 71 |      * @param string $field
 72 |      */
 73 |     public function __construct($term, $field)
 74 |     {
 75 |         $this->_term  = $term;
 76 |         $this->_field = $field;
 77 |     }
 78 | 
 79 |     /**
 80 |      * Process modifier ('~')
 81 |      *
 82 |      * @param mixed $parameter
 83 |      */
 84 |     public function processFuzzyProximityModifier($parameter = null)
 85 |     {
 86 |         $this->_fuzzyQuery = true;
 87 | 
 88 |         if ($parameter !== null) {
 89 |             $this->_similarity = $parameter;
 90 |         } else {
 91 |             /**
 92 |  * Zend_Search_Lucene_Search_Query_Fuzzy 
 93 | */
 94 |             include_once 'Zend/Search/Lucene/Search/Query/Fuzzy.php';
 95 |             $this->_similarity = Zend_Search_Lucene_Search_Query_Fuzzy::DEFAULT_MIN_SIMILARITY;
 96 |         }
 97 |     }
 98 | 
 99 |     /**
100 |      * Transform entry to a subquery
101 |      *
102 |      * @param  string $encoding
103 |      * @return Zend_Search_Lucene_Search_Query
104 |      * @throws Zend_Search_Lucene_Search_QueryParserException
105 |      */
106 |     public function getQuery($encoding)
107 |     {
108 |         if ($this->_fuzzyQuery) {
109 |             /**
110 |  * Zend_Search_Lucene_Search_Query_Preprocessing_Fuzzy 
111 | */
112 |             include_once 'Zend/Search/Lucene/Search/Query/Preprocessing/Fuzzy.php';
113 |             $query = new Zend_Search_Lucene_Search_Query_Preprocessing_Fuzzy(
114 |                 $this->_term,
115 |                 $encoding,
116 |                 ($this->_field !== null)?
117 |                                                                                   iconv($encoding, 'UTF-8', $this->_field) :
118 |                                                                                   null,
119 |                 $this->_similarity
120 |             );
121 |             $query->setBoost($this->_boost);
122 |             return $query;
123 |         }
124 | 
125 | 
126 |         /**
127 |  * Zend_Search_Lucene_Search_Query_Preprocessing_Term 
128 | */
129 |         include_once 'Zend/Search/Lucene/Search/Query/Preprocessing/Term.php';
130 |         $query = new Zend_Search_Lucene_Search_Query_Preprocessing_Term(
131 |             $this->_term,
132 |             $encoding,
133 |             ($this->_field !== null)?
134 |                                                                               iconv($encoding, 'UTF-8', $this->_field) :
135 |                                                                               null
136 |         );
137 |         $query->setBoost($this->_boost);
138 |         return $query;
139 |     }
140 | }
141 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/QueryHit.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Search
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: QueryHit.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | 
 24 | /**
 25 |  * @category   Zend
 26 |  * @package    Zend_Search_Lucene
 27 |  * @subpackage Search
 28 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 29 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 30 |  */
 31 | class Zend_Search_Lucene_Search_QueryHit
 32 | {
 33 |     /**
 34 |      * Object handle of the index
 35 |      *
 36 |      * @var Zend_Search_Lucene_Interface
 37 |      */
 38 |     protected $_index = null;
 39 | 
 40 |     /**
 41 |      * Object handle of the document associated with this hit
 42 |      *
 43 |      * @var Zend_Search_Lucene_Document
 44 |      */
 45 |     protected $_document = null;
 46 | 
 47 |     /**
 48 |      * Number of the document in the index
 49 |      *
 50 |      * @var integer
 51 |      */
 52 |     public $id;
 53 | 
 54 |     /**
 55 |      * Score of the hit
 56 |      *
 57 |      * @var float
 58 |      */
 59 |     public $score;
 60 | 
 61 | 
 62 |     /**
 63 |      * Constructor - pass object handle of Zend_Search_Lucene_Interface index that produced
 64 |      * the hit so the document can be retrieved easily from the hit.
 65 |      *
 66 |      * @param Zend_Search_Lucene_Interface $index
 67 |      */
 68 | 
 69 |     public function __construct(Zend_Search_Lucene_Interface $index)
 70 |     {
 71 |         include_once 'Zend/Search/Lucene/Proxy.php';
 72 |         $this->_index = new Zend_Search_Lucene_Proxy($index);
 73 |     }
 74 | 
 75 | 
 76 |     /**
 77 |      * Convenience function for getting fields from the document
 78 |      * associated with this hit.
 79 |      *
 80 |      * @param  string $offset
 81 |      * @return string
 82 |      */
 83 |     public function __get($offset)
 84 |     {
 85 |         return $this->getDocument()->getFieldValue($offset);
 86 |     }
 87 | 
 88 | 
 89 |     /**
 90 |      * Return the document object for this hit
 91 |      *
 92 |      * @return Zend_Search_Lucene_Document
 93 |      */
 94 |     public function getDocument()
 95 |     {
 96 |         if (!$this->_document instanceof Zend_Search_Lucene_Document) {
 97 |             $this->_document = $this->_index->getDocument($this->id);
 98 |         }
 99 | 
100 |         return $this->_document;
101 |     }
102 | 
103 | 
104 |     /**
105 |      * Return the index object for this hit
106 |      *
107 |      * @return Zend_Search_Lucene_Interface
108 |      */
109 |     public function getIndex()
110 |     {
111 |         return $this->_index;
112 |     }
113 | }
114 | 
115 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/QueryParserException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Search
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: QueryParserException.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | 
24 | /**
25 |  * Zend_Search_Lucene base exception
26 |  */
27 | require_once 'Zend/Search/Lucene/Exception.php';
28 | 
29 | 
30 | /**
31 |  * @category   Zend
32 |  * @package    Zend_Search_Lucene
33 |  * @subpackage Search
34 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
35 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
36 |  *
37 |  * Special exception type, which may be used to intercept wrong user input
38 |  */
39 | class Zend_Search_Lucene_Search_QueryParserException extends Zend_Search_Lucene_Exception
40 | {
41 | 
42 | }
43 | 
44 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/Similarity/Default.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Search
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: Default.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | 
 24 | /**
 25 |  * Zend_Search_Lucene_Search_Similarity 
 26 | */
 27 | require_once 'Zend/Search/Lucene/Search/Similarity.php';
 28 | 
 29 | 
 30 | /**
 31 |  * @category   Zend
 32 |  * @package    Zend_Search_Lucene
 33 |  * @subpackage Search
 34 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 35 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 36 |  */
 37 | class Zend_Search_Lucene_Search_Similarity_Default extends Zend_Search_Lucene_Search_Similarity
 38 | {
 39 | 
 40 |     /**
 41 |      * Implemented as '1/sqrt(numTerms)'.
 42 |      *
 43 |      * @param  string  $fieldName
 44 |      * @param  integer $numTerms
 45 |      * @return float
 46 |      */
 47 |     public function lengthNorm($fieldName, $numTerms)
 48 |     {
 49 |         if ($numTerms == 0) {
 50 |             return 1E10;
 51 |         }
 52 | 
 53 |         return 1.0/sqrt($numTerms);
 54 |     }
 55 | 
 56 |     /**
 57 |      * Implemented as '1/sqrt(sumOfSquaredWeights)'.
 58 |      *
 59 |      * @param  float $sumOfSquaredWeights
 60 |      * @return float
 61 |      */
 62 |     public function queryNorm($sumOfSquaredWeights)
 63 |     {
 64 |         return 1.0/sqrt($sumOfSquaredWeights);
 65 |     }
 66 | 
 67 |     /**
 68 |      * Implemented as 'sqrt(freq)'.
 69 |      *
 70 |      * @param  float $freq
 71 |      * @return float
 72 |      */
 73 |     public function tf($freq)
 74 |     {
 75 |         return sqrt($freq);
 76 |     }
 77 | 
 78 |     /**
 79 |      * Implemented as '1/(distance + 1)'.
 80 |      *
 81 |      * @param  integer $distance
 82 |      * @return float
 83 |      */
 84 |     public function sloppyFreq($distance)
 85 |     {
 86 |         return 1.0/($distance + 1);
 87 |     }
 88 | 
 89 |     /**
 90 |      * Implemented as 'log(numDocs/(docFreq+1)) + 1'.
 91 |      *
 92 |      * @param  integer $docFreq
 93 |      * @param  integer $numDocs
 94 |      * @return float
 95 |      */
 96 |     public function idfFreq($docFreq, $numDocs)
 97 |     {
 98 |         return log($numDocs/(float)($docFreq+1)) + 1.0;
 99 |     }
100 | 
101 |     /**
102 |      * Implemented as 'overlap/maxOverlap'.
103 |      *
104 |      * @param  integer $overlap
105 |      * @param  integer $maxOverlap
106 |      * @return float
107 |      */
108 |     public function coord($overlap, $maxOverlap)
109 |     {
110 |         return $overlap/(float)$maxOverlap;
111 |     }
112 | }
113 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/Weight.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Search
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: Weight.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | 
24 | /**
25 |  * Calculate query weights and build query scorers.
26 |  *
27 |  * A Weight is constructed by a query Query->createWeight().
28 |  * The sumOfSquaredWeights() method is then called on the top-level
29 |  * query to compute the query normalization factor Similarity->queryNorm(float).
30 |  * This factor is then passed to normalize(float).  At this point the weighting
31 |  * is complete.
32 |  *
33 |  * @category   Zend
34 |  * @package    Zend_Search_Lucene
35 |  * @subpackage Search
36 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
37 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
38 |  */
39 | abstract class Zend_Search_Lucene_Search_Weight
40 | {
41 |     /**
42 |      * Normalization factor.
43 |      * This value is stored only for query expanation purpose and not used in any other place
44 |      *
45 |      * @var float
46 |      */
47 |     protected $_queryNorm;
48 | 
49 |     /**
50 |      * Weight value
51 |      *
52 |      * Weight value may be initialized in sumOfSquaredWeights() or normalize()
53 |      * because they both are invoked either in Query::_initWeight (for top-level query) or
54 |      * in corresponding methods of parent query's weights
55 |      *
56 |      * @var float
57 |      */
58 |     protected $_value;
59 | 
60 | 
61 |     /**
62 |      * The weight for this query.
63 |      *
64 |      * @return float
65 |      */
66 |     public function getValue()
67 |     {
68 |         return $this->_value;
69 |     }
70 | 
71 |     /**
72 |      * The sum of squared weights of contained query clauses.
73 |      *
74 |      * @return float
75 |      */
76 |     abstract public function sumOfSquaredWeights();
77 | 
78 |     /**
79 |      * Assigns the query normalization factor to this.
80 |      *
81 |      * @param $norm
82 |      */
83 |     abstract public function normalize($norm);
84 | }
85 | 
86 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/Weight/Boolean.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Search
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: Boolean.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | 
 24 | /**
 25 |  * Zend_Search_Lucene_Search_Weight 
 26 | */
 27 | require_once 'Zend/Search/Lucene/Search/Weight.php';
 28 | 
 29 | 
 30 | /**
 31 |  * @category   Zend
 32 |  * @package    Zend_Search_Lucene
 33 |  * @subpackage Search
 34 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 35 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 36 |  */
 37 | class Zend_Search_Lucene_Search_Weight_Boolean extends Zend_Search_Lucene_Search_Weight
 38 | {
 39 |     /**
 40 |      * IndexReader.
 41 |      *
 42 |      * @var Zend_Search_Lucene_Interface
 43 |      */
 44 |     private $_reader;
 45 | 
 46 |     /**
 47 |      * The query that this concerns.
 48 |      *
 49 |      * @var Zend_Search_Lucene_Search_Query
 50 |      */
 51 |     private $_query;
 52 | 
 53 |     /**
 54 |      * Queries weights
 55 |      * Array of Zend_Search_Lucene_Search_Weight
 56 |      *
 57 |      * @var array
 58 |      */
 59 |     private $_weights;
 60 | 
 61 | 
 62 |     /**
 63 |      * Zend_Search_Lucene_Search_Weight_Boolean constructor
 64 |      * query - the query that this concerns.
 65 |      * reader - index reader
 66 |      *
 67 |      * @param Zend_Search_Lucene_Search_Query $query
 68 |      * @param Zend_Search_Lucene_Interface    $reader
 69 |      */
 70 |     public function __construct(Zend_Search_Lucene_Search_Query $query,
 71 |         Zend_Search_Lucene_Interface    $reader
 72 |     ) {
 73 |     
 74 |         $this->_query   = $query;
 75 |         $this->_reader  = $reader;
 76 |         $this->_weights = array();
 77 | 
 78 |         $signs = $query->getSigns();
 79 | 
 80 |         foreach ($query->getSubqueries() as $num => $subquery) {
 81 |             if ($signs === null || $signs[$num] === null || $signs[$num]) {
 82 |                 $this->_weights[$num] = $subquery->createWeight($reader);
 83 |             }
 84 |         }
 85 |     }
 86 | 
 87 | 
 88 |     /**
 89 |      * The weight for this query
 90 |      * Standard Weight::$_value is not used for boolean queries
 91 |      *
 92 |      * @return float
 93 |      */
 94 |     public function getValue()
 95 |     {
 96 |         return $this->_query->getBoost();
 97 |     }
 98 | 
 99 | 
100 |     /**
101 |      * The sum of squared weights of contained query clauses.
102 |      *
103 |      * @return float
104 |      */
105 |     public function sumOfSquaredWeights()
106 |     {
107 |         $sum = 0;
108 |         foreach ($this->_weights as $weight) {
109 |             // sum sub weights
110 |             $sum += $weight->sumOfSquaredWeights();
111 |         }
112 | 
113 |         // boost each sub-weight
114 |         $sum *= $this->_query->getBoost() * $this->_query->getBoost();
115 | 
116 |         // check for empty query (like '-something -another')
117 |         if ($sum == 0) {
118 |             $sum = 1.0;
119 |         }
120 |         return $sum;
121 |     }
122 | 
123 | 
124 |     /**
125 |      * Assigns the query normalization factor to this.
126 |      *
127 |      * @param float $queryNorm
128 |      */
129 |     public function normalize($queryNorm)
130 |     {
131 |         // incorporate boost
132 |         $queryNorm *= $this->_query->getBoost();
133 | 
134 |         foreach ($this->_weights as $weight) {
135 |             $weight->normalize($queryNorm);
136 |         }
137 |     }
138 | }
139 | 
140 | 
141 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/Weight/Empty.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Zend Framework
 4 |  *
 5 |  * LICENSE
 6 |  *
 7 |  * This source file is subject to the new BSD license that is bundled
 8 |  * with this package in the file LICENSE.txt.
 9 |  * It is also available through the world-wide-web at this URL:
10 |  * http://framework.zend.com/license/new-bsd
11 |  * If you did not receive a copy of the license and are unable to
12 |  * obtain it through the world-wide-web, please send an email
13 |  * to license@zend.com so we can send you a copy immediately.
14 |  *
15 |  * @category   Zend
16 |  * @package    Zend_Search_Lucene
17 |  * @subpackage Search
18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 |  * @version    $Id: Empty.php 20096 2010-01-06 02:05:09Z bkarwin $
21 |  */
22 | 
23 | 
24 | /**
25 |  * Zend_Search_Lucene_Search_Weight 
26 | */
27 | require_once 'Zend/Search/Lucene/Search/Weight.php';
28 | 
29 | 
30 | /**
31 |  * @category   Zend
32 |  * @package    Zend_Search_Lucene
33 |  * @subpackage Search
34 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
35 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
36 |  */
37 | class Zend_Search_Lucene_Search_Weight_Empty extends Zend_Search_Lucene_Search_Weight
38 | {
39 |     /**
40 |      * The sum of squared weights of contained query clauses.
41 |      *
42 |      * @return float
43 |      */
44 |     public function sumOfSquaredWeights()
45 |     {
46 |         return 1;
47 |     }
48 | 
49 | 
50 |     /**
51 |      * Assigns the query normalization factor to this.
52 |      *
53 |      * @param float $queryNorm
54 |      */
55 |     public function normalize($queryNorm)
56 |     {
57 |     }
58 | }
59 | 
60 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/Weight/MultiTerm.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Search
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: MultiTerm.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | 
 24 | /**
 25 |  * Zend_Search_Lucene_Search_Weight 
 26 | */
 27 | require_once 'Zend/Search/Lucene/Search/Weight.php';
 28 | 
 29 | 
 30 | /**
 31 |  * @category   Zend
 32 |  * @package    Zend_Search_Lucene
 33 |  * @subpackage Search
 34 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 35 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 36 |  */
 37 | class Zend_Search_Lucene_Search_Weight_MultiTerm extends Zend_Search_Lucene_Search_Weight
 38 | {
 39 |     /**
 40 |      * IndexReader.
 41 |      *
 42 |      * @var Zend_Search_Lucene_Interface
 43 |      */
 44 |     private $_reader;
 45 | 
 46 |     /**
 47 |      * The query that this concerns.
 48 |      *
 49 |      * @var Zend_Search_Lucene_Search_Query
 50 |      */
 51 |     private $_query;
 52 | 
 53 |     /**
 54 |      * Query terms weights
 55 |      * Array of Zend_Search_Lucene_Search_Weight_Term
 56 |      *
 57 |      * @var array
 58 |      */
 59 |     private $_weights;
 60 | 
 61 | 
 62 |     /**
 63 |      * Zend_Search_Lucene_Search_Weight_MultiTerm constructor
 64 |      * query - the query that this concerns.
 65 |      * reader - index reader
 66 |      *
 67 |      * @param Zend_Search_Lucene_Search_Query $query
 68 |      * @param Zend_Search_Lucene_Interface    $reader
 69 |      */
 70 |     public function __construct(Zend_Search_Lucene_Search_Query $query,
 71 |         Zend_Search_Lucene_Interface    $reader
 72 |     ) {
 73 |     
 74 |         $this->_query   = $query;
 75 |         $this->_reader  = $reader;
 76 |         $this->_weights = array();
 77 | 
 78 |         $signs = $query->getSigns();
 79 | 
 80 |         foreach ($query->getTerms() as $id => $term) {
 81 |             if ($signs === null || $signs[$id] === null || $signs[$id]) {
 82 |                 include_once 'Zend/Search/Lucene/Search/Weight/Term.php';
 83 |                 $this->_weights[$id] = new Zend_Search_Lucene_Search_Weight_Term($term, $query, $reader);
 84 |                 $query->setWeight($id, $this->_weights[$id]);
 85 |             }
 86 |         }
 87 |     }
 88 | 
 89 | 
 90 |     /**
 91 |      * The weight for this query
 92 |      * Standard Weight::$_value is not used for boolean queries
 93 |      *
 94 |      * @return float
 95 |      */
 96 |     public function getValue()
 97 |     {
 98 |         return $this->_query->getBoost();
 99 |     }
100 | 
101 | 
102 |     /**
103 |      * The sum of squared weights of contained query clauses.
104 |      *
105 |      * @return float
106 |      */
107 |     public function sumOfSquaredWeights()
108 |     {
109 |         $sum = 0;
110 |         foreach ($this->_weights as $weight) {
111 |             // sum sub weights
112 |             $sum += $weight->sumOfSquaredWeights();
113 |         }
114 | 
115 |         // boost each sub-weight
116 |         $sum *= $this->_query->getBoost() * $this->_query->getBoost();
117 | 
118 |         // check for empty query (like '-something -another')
119 |         if ($sum == 0) {
120 |             $sum = 1.0;
121 |         }
122 |         return $sum;
123 |     }
124 | 
125 | 
126 |     /**
127 |      * Assigns the query normalization factor to this.
128 |      *
129 |      * @param float $queryNorm
130 |      */
131 |     public function normalize($queryNorm)
132 |     {
133 |         // incorporate boost
134 |         $queryNorm *= $this->_query->getBoost();
135 | 
136 |         foreach ($this->_weights as $weight) {
137 |             $weight->normalize($queryNorm);
138 |         }
139 |     }
140 | }
141 | 
142 | 
143 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/Weight/Phrase.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Search
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: Phrase.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | 
 24 | /**
 25 |  * Zend_Search_Lucene_Search_Weight
 26 |  */
 27 | require_once 'Zend/Search/Lucene/Search/Weight.php';
 28 | 
 29 | 
 30 | /**
 31 |  * @category   Zend
 32 |  * @package    Zend_Search_Lucene
 33 |  * @subpackage Search
 34 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 35 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 36 |  */
 37 | class Zend_Search_Lucene_Search_Weight_Phrase extends Zend_Search_Lucene_Search_Weight
 38 | {
 39 |     /**
 40 |      * IndexReader.
 41 |      *
 42 |      * @var Zend_Search_Lucene_Interface
 43 |      */
 44 |     private $_reader;
 45 | 
 46 |     /**
 47 |      * The query that this concerns.
 48 |      *
 49 |      * @var Zend_Search_Lucene_Search_Query_Phrase
 50 |      */
 51 |     private $_query;
 52 | 
 53 |     /**
 54 |      * Score factor
 55 |      *
 56 |      * @var float
 57 |      */
 58 |     private $_idf;
 59 | 
 60 |     /**
 61 |      * Zend_Search_Lucene_Search_Weight_Phrase constructor
 62 |      *
 63 |      * @param Zend_Search_Lucene_Search_Query_Phrase $query
 64 |      * @param Zend_Search_Lucene_Interface           $reader
 65 |      */
 66 |     public function __construct(Zend_Search_Lucene_Search_Query_Phrase $query,
 67 |         Zend_Search_Lucene_Interface           $reader
 68 |     ) {
 69 |     
 70 |         $this->_query  = $query;
 71 |         $this->_reader = $reader;
 72 |     }
 73 | 
 74 |     /**
 75 |      * The sum of squared weights of contained query clauses.
 76 |      *
 77 |      * @return float
 78 |      */
 79 |     public function sumOfSquaredWeights()
 80 |     {
 81 |         // compute idf
 82 |         $this->_idf = $this->_reader->getSimilarity()->idf($this->_query->getTerms(), $this->_reader);
 83 | 
 84 |         // compute query weight
 85 |         $this->_queryWeight = $this->_idf * $this->_query->getBoost();
 86 | 
 87 |         // square it
 88 |         return $this->_queryWeight * $this->_queryWeight;
 89 |     }
 90 | 
 91 | 
 92 |     /**
 93 |      * Assigns the query normalization factor to this.
 94 |      *
 95 |      * @param float $queryNorm
 96 |      */
 97 |     public function normalize($queryNorm)
 98 |     {
 99 |         $this->_queryNorm = $queryNorm;
100 | 
101 |         // normalize query weight
102 |         $this->_queryWeight *= $queryNorm;
103 | 
104 |         // idf for documents
105 |         $this->_value = $this->_queryWeight * $this->_idf;
106 |     }
107 | }
108 | 
109 | 
110 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Search/Weight/Term.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Search
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: Term.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | 
 24 | /**
 25 |  * Zend_Search_Lucene_Search_Weight 
 26 | */
 27 | require_once 'Zend/Search/Lucene/Search/Weight.php';
 28 | 
 29 | 
 30 | /**
 31 |  * @category   Zend
 32 |  * @package    Zend_Search_Lucene
 33 |  * @subpackage Search
 34 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 35 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 36 |  */
 37 | class Zend_Search_Lucene_Search_Weight_Term extends Zend_Search_Lucene_Search_Weight
 38 | {
 39 |     /**
 40 |      * IndexReader.
 41 |      *
 42 |      * @var Zend_Search_Lucene_Interface
 43 |      */
 44 |     private $_reader;
 45 | 
 46 |     /**
 47 |      * Term
 48 |      *
 49 |      * @var Zend_Search_Lucene_Index_Term
 50 |      */
 51 |     private $_term;
 52 | 
 53 |     /**
 54 |      * The query that this concerns.
 55 |      *
 56 |      * @var Zend_Search_Lucene_Search_Query
 57 |      */
 58 |     private $_query;
 59 | 
 60 |     /**
 61 |      * Score factor
 62 |      *
 63 |      * @var float
 64 |      */
 65 |     private $_idf;
 66 | 
 67 |     /**
 68 |      * Query weight
 69 |      *
 70 |      * @var float
 71 |      */
 72 |     private $_queryWeight;
 73 | 
 74 | 
 75 |     /**
 76 |      * Zend_Search_Lucene_Search_Weight_Term constructor
 77 |      * reader - index reader
 78 |      *
 79 |      * @param Zend_Search_Lucene_Index_Term   $term
 80 |      * @param Zend_Search_Lucene_Search_Query $query
 81 |      * @param Zend_Search_Lucene_Interface    $reader
 82 |      */
 83 |     public function __construct(Zend_Search_Lucene_Index_Term   $term,
 84 |         Zend_Search_Lucene_Search_Query $query,
 85 |         Zend_Search_Lucene_Interface    $reader
 86 |     ) {
 87 |     
 88 |         $this->_term   = $term;
 89 |         $this->_query  = $query;
 90 |         $this->_reader = $reader;
 91 |     }
 92 | 
 93 | 
 94 |     /**
 95 |      * The sum of squared weights of contained query clauses.
 96 |      *
 97 |      * @return float
 98 |      */
 99 |     public function sumOfSquaredWeights()
100 |     {
101 |         // compute idf
102 |         $this->_idf = $this->_reader->getSimilarity()->idf($this->_term, $this->_reader);
103 | 
104 |         // compute query weight
105 |         $this->_queryWeight = $this->_idf * $this->_query->getBoost();
106 | 
107 |         // square it
108 |         return $this->_queryWeight * $this->_queryWeight;
109 |     }
110 | 
111 | 
112 |     /**
113 |      * Assigns the query normalization factor to this.
114 |      *
115 |      * @param float $queryNorm
116 |      */
117 |     public function normalize($queryNorm)
118 |     {
119 |         $this->_queryNorm = $queryNorm;
120 | 
121 |         // normalize query weight
122 |         $this->_queryWeight *= $queryNorm;
123 | 
124 |         // idf for documents
125 |         $this->_value = $this->_queryWeight * $this->_idf;
126 |     }
127 | }
128 | 
129 | 


--------------------------------------------------------------------------------
/thirdparty/Zend/Search/Lucene/Storage/Directory.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Zend Framework
  4 |  *
  5 |  * LICENSE
  6 |  *
  7 |  * This source file is subject to the new BSD license that is bundled
  8 |  * with this package in the file LICENSE.txt.
  9 |  * It is also available through the world-wide-web at this URL:
 10 |  * http://framework.zend.com/license/new-bsd
 11 |  * If you did not receive a copy of the license and are unable to
 12 |  * obtain it through the world-wide-web, please send an email
 13 |  * to license@zend.com so we can send you a copy immediately.
 14 |  *
 15 |  * @category   Zend
 16 |  * @package    Zend_Search_Lucene
 17 |  * @subpackage Storage
 18 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 19 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 20 |  * @version    $Id: Directory.php 20096 2010-01-06 02:05:09Z bkarwin $
 21 |  */
 22 | 
 23 | 
 24 | /**
 25 |  * @category   Zend
 26 |  * @package    Zend_Search_Lucene
 27 |  * @subpackage Storage
 28 |  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 29 |  * @license    http://framework.zend.com/license/new-bsd     New BSD License
 30 |  */
 31 | abstract class Zend_Search_Lucene_Storage_Directory
 32 | {
 33 | 
 34 |     /**
 35 |      * Closes the store.
 36 |      *
 37 |      * @return void
 38 |      */
 39 |     abstract public function close();
 40 | 
 41 |     /**
 42 |      * Returns an array of strings, one for each file in the directory.
 43 |      *
 44 |      * @return array
 45 |      */
 46 |     abstract public function fileList();
 47 | 
 48 |     /**
 49 |      * Creates a new, empty file in the directory with the given $filename.
 50 |      *
 51 |      * @param  string $filename
 52 |      * @return Zend_Search_Lucene_Storage_File
 53 |      */
 54 |     abstract public function createFile($filename);
 55 | 
 56 | 
 57 |     /**
 58 |      * Removes an existing $filename in the directory.
 59 |      *
 60 |      * @param  string $filename
 61 |      * @return void
 62 |      */
 63 |     abstract public function deleteFile($filename);
 64 | 
 65 |     /**
 66 |      * Purge file if it's cached by directory object
 67 |      *
 68 |      * Method is used to prevent 'too many open files' error
 69 |      *
 70 |      * @param  string $filename
 71 |      * @return void
 72 |      */
 73 |     abstract public function purgeFile($filename);
 74 | 
 75 |     /**
 76 |      * Returns true if a file with the given $filename exists.
 77 |      *
 78 |      * @param  string $filename
 79 |      * @return boolean
 80 |      */
 81 |     abstract public function fileExists($filename);
 82 | 
 83 | 
 84 |     /**
 85 |      * Returns the length of a $filename in the directory.
 86 |      *
 87 |      * @param  string $filename
 88 |      * @return integer
 89 |      */
 90 |     abstract public function fileLength($filename);
 91 | 
 92 | 
 93 |     /**
 94 |      * Returns the UNIX timestamp $filename was last modified.
 95 |      *
 96 |      * @param  string $filename
 97 |      * @return integer
 98 |      */
 99 |     abstract public function fileModified($filename);
100 | 
101 | 
102 |     /**
103 |      * Renames an existing file in the directory.
104 |      *
105 |      * @param  string $from
106 |      * @param  string $to
107 |      * @return void
108 |      */
109 |     abstract public function renameFile($from, $to);
110 | 
111 | 
112 |     /**
113 |      * Sets the modified time of $filename to now.
114 |      *
115 |      * @param  string $filename
116 |      * @return void
117 |      */
118 |     abstract public function touchFile($filename);
119 | 
120 | 
121 |     /**
122 |      * Returns a Zend_Search_Lucene_Storage_File object for a given $filename in the directory.
123 |      *
124 |      * If $shareHandler option is true, then file handler can be shared between File Object
125 |      * requests. It speed-ups performance, but makes problems with file position.
126 |      * Shared handler are good for short atomic requests.
127 |      * Non-shared handlers are useful for stream file reading (especial for compound files).
128 |      *
129 |      * @param  string  $filename
130 |      * @param  boolean $shareHandler
131 |      * @return Zend_Search_Lucene_Storage_File
132 |      */
133 |     abstract public function getFileObject($filename, $shareHandler = true);
134 | 
135 | }
136 | 
137 | 


--------------------------------------------------------------------------------
/thirdparty/_manifest_exclude:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/silverstripe/silverstripe-docsviewer/71d7345a3b29e857e49f73f245a08d10ea0fafaa/thirdparty/_manifest_exclude


--------------------------------------------------------------------------------
/thirdparty/highlight/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2006, Ivan Sagalaev
 2 | All rights reserved.
 3 | Redistribution and use in source and binary forms, with or without
 4 | modification, are permitted provided that the following conditions are met:
 5 | 
 6 |     * Redistributions of source code must retain the above copyright
 7 |       notice, this list of conditions and the following disclaimer.
 8 |     * Redistributions in binary form must reproduce the above copyright
 9 |       notice, this list of conditions and the following disclaimer in the
10 |       documentation and/or other materials provided with the distribution.
11 |     * Neither the name of highlight.js nor the names of its contributors 
12 |       may be used to endorse or promote products derived from this software 
13 |       without specific prior written permission.
14 | 
15 | THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
16 | EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 | DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
19 | DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 | ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 | 


--------------------------------------------------------------------------------
/thirdparty/highlight/README.md:
--------------------------------------------------------------------------------
  1 | # Highlight.js
  2 | 
  3 | [![Build Status](https://travis-ci.org/isagalaev/highlight.js.svg?branch=master)](https://travis-ci.org/isagalaev/highlight.js)
  4 | 
  5 | Highlight.js is a syntax highlighter written in JavaScript. It works in
  6 | the browser as well as on the server. It works with pretty much any
  7 | markup, doesn’t depend on any framework and has automatic language
  8 | detection.
  9 | 
 10 | ## Getting Started
 11 | 
 12 | The bare minimum for using highlight.js on a web page is linking to the
 13 | library along with one of the styles and calling
 14 | [`initHighlightingOnLoad`][1]:
 15 | 
 16 | ```html
 17 | <link rel="stylesheet" href="/path/to/styles/default.css">
 18 | <script src="/path/to/highlight.pack.js"></script>
 19 | <script>hljs.initHighlightingOnLoad();</script>
 20 | ```
 21 | 
 22 | This will find and highlight code inside of `<pre><code>` tags; it tries
 23 | to detect the language automatically. If automatic detection doesn’t
 24 | work for you, you can specify the language in the `class` attribute:
 25 | 
 26 | ```html
 27 | <pre><code class="html">...</code></pre>
 28 | ```
 29 | 
 30 | The list of supported language classes is available in the [class
 31 | reference][2].  Classes can also be prefixed with either `language-` or
 32 | `lang-`.
 33 | 
 34 | To disable highlighting altogether use the `nohighlight` class:
 35 | 
 36 | ```html
 37 | <pre><code class="nohighlight">...</code></pre>
 38 | ```
 39 | 
 40 | ## Custom Initialization
 41 | 
 42 | When you need a bit more control over the initialization of
 43 | highlight.js, you can use the [`highlightBlock`][3] and [`configure`][4]
 44 | functions. This allows you to control *what* to highlight and *when*.
 45 | 
 46 | Here’s an equivalent way to calling [`initHighlightingOnLoad`][1] using
 47 | jQuery:
 48 | 
 49 | ```javascript
 50 | $(document).ready(function() {
 51 |   $('pre code').each(function(i, block) {
 52 |     hljs.highlightBlock(block);
 53 |   });
 54 | });
 55 | ```
 56 | 
 57 | You can use any tags instead of `<pre><code>` to mark up your code. If
 58 | you don't use a container that preserve line breaks you will need to
 59 | configure highlight.js to use the `<br>` tag:
 60 | 
 61 | ```javascript
 62 | hljs.configure({useBR: true});
 63 | 
 64 | $('div.code').each(function(i, block) {
 65 |   hljs.highlightBlock(block);
 66 | });
 67 | ```
 68 | 
 69 | For other options refer to the documentation for [`configure`][4].
 70 | 
 71 | 
 72 | ## Web Workers
 73 | 
 74 | You can run highlighting inside a web worker to avoid freezing the browser
 75 | window while dealing with very big chunks of code.
 76 | 
 77 | In your main script:
 78 | 
 79 | ```javascript
 80 | addEventListener('load', function() {
 81 |   var code = document.querySelector('#code');
 82 |   var worker = new Worker('worker.js');
 83 |   worker.onmessage = function(event) { code.innerHTML = event.data; }
 84 |   worker.postMessage(code.textContent);
 85 | })
 86 | ```
 87 | 
 88 | In worker.js:
 89 | 
 90 | ```javascript
 91 | onmessage = function(event) {
 92 |   importScripts('<path>/highlight.pack.js');
 93 |   var result = self.hljs.highlightAuto(event.data);
 94 |   postMessage(result.value);
 95 | }
 96 | ```
 97 | 
 98 | 
 99 | ## Getting the Library
100 | 
101 | You can get highlight.js as a hosted, or custom-build, browser script or
102 | as a server module. Right out of the box the browser script supports
103 | both AMD and CommonJS, so if you wish you can use RequireJS or
104 | Browserify without having to build from source. The server module also
105 | works perfectly fine with Browserify, but there is the option to use a
106 | build specific to browsers rather than something meant for a server.
107 | Head over to the [download page][5] for all the options.
108 | 
109 | **Don't link to GitHub directly.** The library is not supposed to work straight
110 | from the source, it requires building. If none of the pre-packaged options
111 | work for you refer to the [building documentation][6].
112 | 
113 | **The CDN-hosted package doesn't have all the languages.** Otherwise it'd be
114 | too big. If you don't see the language you need in the ["Common" section][5],
115 | it can be added manually:
116 | 
117 | ```html
118 | <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.4.0/languages/go.min.js"></script>
119 | ```
120 | 
121 | **On Almond.** You need to use the optimizer to give the module a name. For
122 | example:
123 | 
124 | ```
125 | r.js -o name=hljs paths.hljs=/path/to/highlight out=highlight.js
126 | ```
127 | 
128 | 
129 | ## License
130 | 
131 | Highlight.js is released under the BSD License. See [LICENSE][7] file
132 | for details.
133 | 
134 | ## Links
135 | 
136 | The official site for the library is at <https://highlightjs.org/>.
137 | 
138 | Further in-depth documentation for the API and other topics is at
139 | <http://highlightjs.readthedocs.io/>.
140 | 
141 | Authors and contributors are listed in the [AUTHORS.en.txt][8] file.
142 | 
143 | [1]: http://highlightjs.readthedocs.io/en/latest/api.html#inithighlightingonload
144 | [2]: http://highlightjs.readthedocs.io/en/latest/css-classes-reference.html
145 | [3]: http://highlightjs.readthedocs.io/en/latest/api.html#highlightblock-block
146 | [4]: http://highlightjs.readthedocs.io/en/latest/api.html#configure-options
147 | [5]: https://highlightjs.org/download/
148 | [6]: http://highlightjs.readthedocs.io/en/latest/building-testing.html
149 | [7]: https://github.com/isagalaev/highlight.js/blob/master/LICENSE
150 | [8]: https://github.com/isagalaev/highlight.js/blob/master/AUTHORS.en.txt
151 | 


--------------------------------------------------------------------------------
/thirdparty/highlight/README.ru.md:
--------------------------------------------------------------------------------
  1 | # Highlight.js
  2 | 
  3 | Highlight.js — это инструмент для подсветки синтаксиса, написанный на JavaScript. Он работает
  4 | и в браузере, и на сервере. Он работает с практически любой HTML разметкой, не
  5 | зависит от каких-либо фреймворков и умеет автоматически определять язык.
  6 | 
  7 | 
  8 | ## Начало работы
  9 | 
 10 | Минимум, что нужно сделать для использования highlight.js на веб-странице — это
 11 | подключить библиотеку, CSS-стили и вызывать [`initHighlightingOnLoad`][1]:
 12 | 
 13 | ```html
 14 | <link rel="stylesheet" href="/path/to/styles/default.css">
 15 | <script src="/path/to/highlight.pack.js"></script>
 16 | <script>hljs.initHighlightingOnLoad();</script>
 17 | ```
 18 | 
 19 | Библиотека найдёт и раскрасит код внутри тегов `<pre><code>`, попытавшись
 20 | автоматически определить язык. Когда автоопределение не срабатывает, можно явно
 21 | указать язык в атрибуте class:
 22 | 
 23 | ```html
 24 | <pre><code class="html">...</code></pre>
 25 | ```
 26 | 
 27 | Список поддерживаемых классов языков доступен в [справочнике по классам][2].
 28 | Класс также можно предварить префиксами `language-` или `lang-`.
 29 | 
 30 | Чтобы отключить подсветку для какого-то блока, используйте класс `nohighlight`:
 31 | 
 32 | ```html
 33 | <pre><code class="nohighlight">...</code></pre>
 34 | ```
 35 | 
 36 | ## Инициализация вручную
 37 | 
 38 | Чтобы иметь чуть больше контроля за инициализацией подсветки, вы можете
 39 | использовать функции [`highlightBlock`][3] и [`configure`][4]. Таким образом
 40 | можно управлять тем, *что* и *когда* подсвечивать.
 41 | 
 42 | Вот пример инициализации, эквивалентной вызову [`initHighlightingOnLoad`][1], но
 43 | с использованием jQuery:
 44 | 
 45 | ```javascript
 46 | $(document).ready(function() {
 47 |   $('pre code').each(function(i, block) {
 48 |     hljs.highlightBlock(block);
 49 |   });
 50 | });
 51 | ```
 52 | 
 53 | Вы можете использовать любые теги разметки вместо `<pre><code>`. Если
 54 | используете контейнер, не сохраняющий переводы строк, вам нужно сказать
 55 | highlight.js использовать для них тег `<br>`:
 56 | 
 57 | ```javascript
 58 | hljs.configure({useBR: true});
 59 | 
 60 | $('div.code').each(function(i, block) {
 61 |   hljs.highlightBlock(block);
 62 | });
 63 | ```
 64 | 
 65 | Другие опции можно найти в документации функции [`configure`][4].
 66 | 
 67 | 
 68 | ## Web Workers
 69 | 
 70 | Подсветку можно запустить внутри web worker'а, чтобы окно
 71 | браузера не подтормаживало при работе с большими кусками кода.
 72 | 
 73 | В основном скрипте:
 74 | 
 75 | ```javascript
 76 | addEventListener('load', function() {
 77 |   var code = document.querySelector('#code');
 78 |   var worker = new Worker('worker.js');
 79 |   worker.onmessage = function(event) { code.innerHTML = event.data; }
 80 |   worker.postMessage(code.textContent);
 81 | })
 82 | ```
 83 | 
 84 | В worker.js:
 85 | 
 86 | ```javascript
 87 | onmessage = function(event) {
 88 |   importScripts('<path>/highlight.pack.js');
 89 |   var result = self.hljs.highlightAuto(event.data);
 90 |   postMessage(result.value);
 91 | }
 92 | ```
 93 | 
 94 | 
 95 | ## Установка библиотеки
 96 | 
 97 | Highlight.js можно использовать в браузере прямо с CDN хостинга или скачать
 98 | индивидуальную сборку, а также установив модуль на сервере. На
 99 | [странице загрузки][5] подробно описаны все варианты.
100 | 
101 | **Не подключайте GitHub напрямую.** Библиотека не предназначена для
102 | использования в виде исходного кода, а требует отдельной сборки. Если вам не
103 | подходит ни один из готовых вариантов, читайте [документацию по сборке][6].
104 | 
105 | **Файл на CDN содержит не все языки.** Иначе он будет слишком большого размера.
106 | Если нужного вам языка нет в [категории "Common"][5], можно дообавить его
107 | вручную:
108 | 
109 | ```html
110 | <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.4.0/languages/go.min.js"></script>
111 | ```
112 | 
113 | **Про Almond.** Нужно задать имя модуля в оптимизаторе, например:
114 | 
115 | ```
116 | r.js -o name=hljs paths.hljs=/path/to/highlight out=highlight.js
117 | ```
118 | 
119 | 
120 | ## Лицензия
121 | 
122 | Highlight.js распространяется под лицензией BSD. Подробнее читайте файл
123 | [LICENSE][7].
124 | 
125 | 
126 | ## Ссылки
127 | 
128 | Официальный сайт билиотеки расположен по адресу <https://highlightjs.org/>.
129 | 
130 | Более подробная документация по API и другим темам расположена на
131 | <http://highlightjs.readthedocs.io/>.
132 | 
133 | Авторы и контрибьюторы перечислены в файле [AUTHORS.ru.txt][8] file.
134 | 
135 | [1]: http://highlightjs.readthedocs.io/en/latest/api.html#inithighlightingonload
136 | [2]: http://highlightjs.readthedocs.io/en/latest/css-classes-reference.html
137 | [3]: http://highlightjs.readthedocs.io/en/latest/api.html#highlightblock-block
138 | [4]: http://highlightjs.readthedocs.io/en/latest/api.html#configure-options
139 | [5]: https://highlightjs.org/download/
140 | [6]: http://highlightjs.readthedocs.io/en/latest/building-testing.html
141 | [7]: https://github.com/isagalaev/highlight.js/blob/master/LICENSE
142 | [8]: https://github.com/isagalaev/highlight.js/blob/master/AUTHORS.ru.txt
143 | 


--------------------------------------------------------------------------------