Maarch Framework 3/Developer handbook/Full Text

De Maarch // Wiki.

Aller à : Navigation, rechercher
Warning.gif Cette section du wiki est en cours de restructuration et de rédaction. Nous nous excusons pour la gêne occasionnée.
This section of the wiki is under heavy restructuring and writing. We're sorry for the inconvenience.

Sommaire

Summary

Installation

Quick Install

The tables for this module are defined in the file full_text/sql/structure/ directory depending on your database engine, and the mimimal data in the full_text/sql/data/ directory.

To load the module just add these lines in the apps config.xml file in the <MODULES> section :

<MODULES>
   <moduleid>full_text</moduleid>
   <comment>_FULL_TEXT</comment>
</MODULES>

Make sure the service is active (the <loaded> tag is set to true in full_text/xml/config.xml).

Settings

Each document collection that need to be indexed in full text must be associated with a configuration file in full_text/xml.

Here is a generic config file, modify it accordingly to your environment.

<?xml version="1.0" encoding="utf-8"?>
<ROOT>
	<CONFIG>
		<BASE_DIRECTORY>/path/to/maarch_v3/modules/full_text/</BASE_DIRECTORY><!-- Path to the module 
                                                                                           full_text -->
		<INDEX_FILE_DIRECTORY>/path/to/collection/index</INDEX_FILE_DIRECTORY><!-- Path to the directory where 
                                                                 the index files for this collection are stored -->
		<LOCATION>localhost</LOCATION> <!-- Database server address -->
		<DATABASETYPE>MYSQL</DATABASETYPE> <!-- Database engine -->
		<DATABASE_PORT>3306</DATABASE_PORT> <!-- Port of the database server -->
		<DATABASE>maarch_v3</DATABASE> <!-- Database name -->
		<USER_NAME>root</USER_NAME> <!-- Database username -->
		<PASSWORD></PASSWORD> <!-- Database password -->
		<TABLE_NAME>res_x</TABLE_NAME> <!-- Resource table in db for this collection -->
		<FULLTEXT_COLUMN_NAME>fulltext_result</FULLTEXT_COLUMN_NAME> <!-- Field in the resource table where
                                                                                  full text results are stored -->
		<MAARCH_TOOLS_PATH>/path/to/maarch_v3/apps/APP_NAME/tools/</MAARCH_TOOLS_PATH> <!-- Path to the tools
                                                                                        directory of your apps. -->
		<MAX_BATCH_SIZE>10</MAX_BATCH_SIZE>
	</CONFIG>
</ROOT>

Provided Services

This module doesn't provide any service.

Customisation

Language