Class flSearchIndexer

flSearchIndexer Class

Class to index and manage search data.

flSearch

Extended by

flSearchIndexer

Package: fusionLib
Copyright: Copyright (c) 2008 - 2016 fusionLib. All rights reserved.
Located at system/libs/Search/flSearchIndexer.php

Methods summary

`protected integer`	# `createPath( string\|array $path )` Create a missing path. Create a missing path. Parameters `$path` The path to create. Returns integer The ID of the last node added or false.
`public integer`	# `addDocument( string\|array $path, string $name, string $accessPerm = '', string $publishedAt = null )` Add a new document to the given path. Add a new document to the given path. Parameters `$path` The location to add the new document in. `$name` The name of the document to add. `$accessPerm` The access permission for the document. `$publishedAt` The time the document was published. Returns integer The ID of the new document or false if failed.
`public boolean`	# `deleteDocument( string\|array $path )` Delete the document and all child documents. Delete the document and all child documents. Parameters `$path` The page of the document to delete. Returns boolean true if the document was deleted; else false.
`public boolean`	# `moveDocument( string\|array $src, string\|array $dst )` Move a document to a new location in the tree. Move a document to a new location in the tree. Parameters `$src` The source path including the document to move. `$dst` The destination path to move the document into. Returns boolean true if the document was moved; else false.
`public boolean`	# `renameDocument( string\|array $path, string $name )` Rename a document. Rename a document. Parameters `$path` The path to the document to rename. `$name` The new name of the document. Returns boolean true if the document was renamed; else false.
`public boolean`	# `setDocumentAccess( string\|array $path, string $accessPerm )` Set the access permission of a document. Set the access permission of a document. Parameters `$path` The path to the document to rename. `$accessPerm` The access permission. Returns boolean true if the document was updated; else false.
`public boolean`	# `setDocumentPublishedAt( string\|array $path, string $publishedAt )` Set the published at time of a document. Set the published at time of a document. Parameters `$path` The path to the document to rename. `$publishedAt` The time the document was published. Returns boolean true if the document was updated; else false.
`public`	# `dropDocumentIndex( string\|array $path )` Drop index for the document. Drop index for the document. Parameters `$path` Path to the document to drop the index of.
`public`	# `dropDocumentTags( string\|array $path )` Drop tags for the document. Parameters `$path` Path to the document to drop the tags of.
`public`	# `clearIndex( boolean $clearDocs = false )` Clears all index and word data from the database. Clears all index and word data from the database. Parameters `$clearDocs` If true documents are cleared; false to just clear words, tags and index.
`public boolean`	# `indexDocument( string\|array $path, array $text, string $accessPerm = '', float $docBoost = 1.0 )` Index the document text. Index the document text. Unknown fields are ignored. Parameters `$path` The path to the document being indexed. `$text` Array of fields holding the raw UTF-8 HTML content to index. `$accessPerm` The access permission for the document. `$docBoost` Boost value to apply to the document to artificially increase it's rank in results. Returns boolean true if the document was indexed else false.
`public boolean`	# `tagDocument( string\|array $path, string\|array $tags, string $accessPerm = '' )` Record document tags. Record document tags. Parameters `$path` The path to the document being indexed. `$tags` Array of tags or string of comma separated tags. `$accessPerm` The access permission for the document. Returns boolean true if the document was tagged else false.

Methods inherited from flSearch

__construct(), find(), removeStopWords()

Properties summary

`protected array`	`$fieldCache` List of field names to ids. List of field names to ids.	# `null`

Properties inherited from flSearch

$db, $docs, $maxWordLen, $minWordLen, $stemmer, $stopWords, $tableBase