gnh1201/seeddms-code
1
0
Fork 0
mirror of https://git.code.sf.net/p/seeddms/code synced 2025-05-12 20:51:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add more documentation

Browse Source
This commit is contained in:
Uwe Steinmann 2023-01-04 14:32:52 +01:00
parent 722b5dfba5
commit a80702e7b8
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
inc/inc.ClassFulltextService.php
View File

@ -7,17 +7,27 @@
* @license GPL 2 * @license GPL 2
* @version @version@ * @version @version@
* @author Uwe Steinmann <uwe@steinmann.cx> * @author Uwe Steinmann <uwe@steinmann.cx>
* @copyright Copyright (C) 2016 Uwe Steinmann * @copyright Copyright (C) 2021-2023 Uwe Steinmann
* @version Release: @package_version@ * @version Release: @package_version@
*/ */
/** /**
* Implementation of fulltext service * Implementation of fulltext service
* *
* The fulltext service is wrapper around single services for a full text
* search. Such a service can be based on Solr, SQlite, etc. It implements
* three major methods:
* IndexedDocument() for creating an instance of an indexed document
* Indexer() for creating an instance of the index
* Search() fro creating an instance of a search frontend
*
* Though this class can manage more than one service, it will only
* use the first one.
*
* @category DMS * @category DMS
* @package SeedDMS * @package SeedDMS
* @author Uwe Steinmann <uwe@steinmann.cx> * @author Uwe Steinmann <uwe@steinmann.cx>
* @copyright Copyright (C) 2016 Uwe Steinmann * @copyright Copyright (C) 2021-2023 Uwe Steinmann
* @version Release: @package_version@ * @version Release: @package_version@
*/ */
class SeedDMS_FulltextService { class SeedDMS_FulltextService {
@ -136,7 +146,7 @@ class SeedDMS_FulltextService {
/** /**
* Returns callback function to convert a document into plain text * Returns callback function to convert a document into plain text
* *
* This variant just uses the text previewer which * This variant uses the text previewer which
* caches the converted document * caches the converted document
*/ */
public function getConversionWithPreviewCallback() { /* {{{ */ public function getConversionWithPreviewCallback() { /* {{{ */
@ -162,7 +172,7 @@ class SeedDMS_FulltextService {
} /* }}} */ } /* }}} */
/** /**
* Return an indexable document from the given document or folder * Return an indexable document based on the given document or folder
* *
* @param SeedDMS_Core_Document|SeedDMS_Core_Folder $object document or folder * @param SeedDMS_Core_Document|SeedDMS_Core_Folder $object document or folder
* to be indexed * to be indexed
@ -183,7 +193,7 @@ class SeedDMS_FulltextService {
/** /**
* Returns an instance of the indexer * Returns an instance of the indexer
* *
* The indexer provides access to fulltext index. It allows to add and * The indexer provides access to the fulltext index. It allows to add and
* get documents. * get documents.
* *
* @return object instance of class specified in 'Indexer' * @return object instance of class specified in 'Indexer'