Public Member Functions | |
| main ($content, $conf) | |
| initialize () | |
| getSearchWords ($defOp) | |
| procSearchWordsByLexer ($SWArr) | |
| doSearch ($sWArr) | |
| getResultRows ($sWArr, $freeIndexUid=-1) | |
| getResultRows_SQLpointer ($sWArr, $freeIndexUid=-1) | |
| getDisplayResults ($sWArr, $resData, $freeIndexUid=-1) | |
| compileResult ($resultRows, $freeIndexUid=-1) | |
| getPhashList ($sWArr) | |
| execPHashListQuery ($wordSel, $plusQ='') | |
| sectionTableWhere () | |
| mediaTypeWhere () | |
| languageWhere () | |
| freeIndexUidWhere ($freeIndexUid) | |
| execFinalQuery ($list, $freeIndexUid=-1) | |
| checkResume ($row) | |
| isDescending ($inverse=FALSE) | |
| writeSearchStat ($sWArr, $count, $pt) | |
| makeSearchForm ($optValues) | |
| renderSelectBoxValues ($value, $optValues) | |
| printRules () | |
| printResultSectionLinks () | |
| makeSectionHeader ($id, $sectionTitleLinked, $countResultRows) | |
| printResultRow ($row, $headerOnly=0) | |
| pi_list_browseresults ($showResultCount=1, $addString='', $addPart='', $freeIndexUid=-1) | |
| prepareResultRowTemplateData ($row, $headerOnly) | |
| tellUsWhatIsSeachedFor ($sWArr) | |
| wrapSW ($str) | |
| renderSelectBox ($name, $value, $optValues) | |
| makePointerSelector_link ($str, $p, $freeIndexUid) | |
| makeItemTypeIcon ($it, $alt='', $specRowConf) | |
| makeRating ($row) | |
| makeDescription ($row, $noMarkup=0, $lgd=180) | |
| markupSWpartsOfString ($str) | |
| makeTitle ($row) | |
| makeInfo ($row, $tmplArray) | |
| getSpecialConfigForRow ($row) | |
| makeLanguageIndication ($row) | |
| makeAccessIndication ($id) | |
| linkPage ($id, $str, $row=array(), $markUpSwParams=array()) | |
| getRootLine ($id, $pathMP='') | |
| getFirstSysDomainRecordForPage ($id) | |
| getPathFromPageId ($id, $pathMP='') | |
| getMenu ($id) | |
| multiplePagesType ($item_type) | |
| utf8_to_currentCharset ($str) | |
| & | hookRequest ($functionName) |
Public Attributes | |
| $prefixId = 'tx_indexedsearch' | |
| $scriptRelPath = 'pi/class.tx_indexedsearch.php' | |
| $extKey = 'indexed_search' | |
| $join_pages = 0 | |
| $defaultResultNumber = 10 | |
| $operator_translate_table | |
| $wholeSiteIdList = 0 | |
| $sWArr = array() | |
| $optValues = array() | |
| $firstRow = Array() | |
| $cache_path = array() | |
| $cache_rl = array() | |
| $fe_groups_required = array() | |
| $domain_records = array() | |
| $wSelClauses = array() | |
| $resultSections = array() | |
| $external_parsers = array() | |
| $iconFileNameCache = array() | |
| $lexerObj | |
| $templateCode | |
| $hiddenFieldList = 'ext, type, defOp, media, order, group, lang, desc, results' | |
Definition at line 123 of file class.tx_indexedsearch.php.
| tx_indexedsearch::main | ( | $ | content, | |
| $ | conf | |||
| ) |
Main function, called from TypoScript as a USER_INT object.
| string | Content input, ignore (just put blank string) | |
| array | TypoScript configuration of the plugin! |
Definition at line 169 of file class.tx_indexedsearch.php.
| tx_indexedsearch::initialize | ( | ) |
Initialize internal variables, especially selector box values for the search form and search words
Definition at line 201 of file class.tx_indexedsearch.php.
| tx_indexedsearch::getSearchWords | ( | $ | defOp | ) |
Splits the search word input into an array where each word is represented by an array with key "sword" holding the search word and key "oper" holds the SQL operator (eg. AND, OR)
Only words with 2 or more characters are accepted Max 200 chars total Space is used to split words, "" can be used search for a whole string (not indexed search then) AND, OR and NOT are prefix words, overruling the default operator +/|/- equals AND, OR and NOT as operators. All search words are converted to lowercase.
$defOp is the default operator. 1=OR, 0=AND
| boolean | If true, the default operator will be OR, not AND |
Definition at line 414 of file class.tx_indexedsearch.php.
| tx_indexedsearch::procSearchWordsByLexer | ( | $ | SWArr | ) |
Post-process the search word array so it will match the words that was indexed (including case-folding if any) If any words are splitted into multiple words (eg. CJK will be!) the operator of the main word will remain.
| array | Search word array |
Definition at line 448 of file class.tx_indexedsearch.php.
| tx_indexedsearch::doSearch | ( | $ | sWArr | ) |
Performs the search, the display and writing stats
| array | Search words in array, see ->getSearchWords() for details |
Definition at line 492 of file class.tx_indexedsearch.php.
| tx_indexedsearch::getResultRows | ( | $ | sWArr, | |
| $ | freeIndexUid = -1 | |||
| ) |
Get search result rows / data from database. Returned as data in array.
| array | Search word array | |
| integer | Pointer to which indexing configuration you want to search in. -1 means no filtering. 0 means only regular indexed content. |
Definition at line 550 of file class.tx_indexedsearch.php.
| tx_indexedsearch::getResultRows_SQLpointer | ( | $ | sWArr, | |
| $ | freeIndexUid = -1 | |||
| ) |
Gets a SQL result pointer to traverse for the search records.
| array | Search words | |
| integer | Pointer to which indexing configuration you want to search in. -1 means no filtering. 0 means only regular indexed content. |
Definition at line 624 of file class.tx_indexedsearch.php.
| tx_indexedsearch::getDisplayResults | ( | $ | sWArr, | |
| $ | resData, | |||
| $ | freeIndexUid = -1 | |||
| ) |
Compiles the HTML display of the incoming array of result rows.
| array | Search words array (for display of text describing what was searched for) | |
| array | Array with result rows, count, first row. | |
| integer | Pointer to which indexing configuration you want to search in. -1 means no filtering. 0 means only regular indexed content. |
Definition at line 648 of file class.tx_indexedsearch.php.
| tx_indexedsearch::compileResult | ( | $ | resultRows, | |
| $ | freeIndexUid = -1 | |||
| ) |
Takes the array with resultrows as input and returns the result-HTML-code Takes the "group" var into account: Makes a "section" or "flat" display.
| array | Result rows | |
| integer | Pointer to which indexing configuration you want to search in. -1 means no filtering. 0 means only regular indexed content. |
Definition at line 700 of file class.tx_indexedsearch.php.
| tx_indexedsearch::getPhashList | ( | $ | sWArr | ) |
Returns a COMPLETE list of phash-integers matching the search-result composed of the search-words in the sWArr array. The list of phash integers are unsorted and should be used for subsequent selection of index_phash records for display of the result.
| array | Search word array |
Definition at line 802 of file class.tx_indexedsearch.php.
| tx_indexedsearch::execPHashListQuery | ( | $ | wordSel, | |
| $ | plusQ = '' | |||
| ) |
Returns a query which selects the search-word from the word/rel tables.
| string | WHERE clause selecting the word from phash | |
| string | Additional AND clause in the end of the query. |
Definition at line 903 of file class.tx_indexedsearch.php.
| tx_indexedsearch::sectionTableWhere | ( | ) |
Returns AND statement for selection of section in database. (rootlevel 0-2 + page_id)
Definition at line 923 of file class.tx_indexedsearch.php.
| tx_indexedsearch::mediaTypeWhere | ( | ) |
Returns AND statement for selection of media type
Definition at line 970 of file class.tx_indexedsearch.php.
| tx_indexedsearch::languageWhere | ( | ) |
Returns AND statement for selection of langauge
Definition at line 995 of file class.tx_indexedsearch.php.
| tx_indexedsearch::freeIndexUidWhere | ( | $ | freeIndexUid | ) |
Where-clause for free index-uid value.
| integer | Free Index UID value to limit search to. |
Definition at line 1007 of file class.tx_indexedsearch.php.
| tx_indexedsearch::execFinalQuery | ( | $ | list, | |
| $ | freeIndexUid = -1 | |||
| ) |
Execute final query, based on phash integer list. The main point is sorting the result in the right order.
| string | List of phash integers which match the search. | |
| integer | Pointer to which indexing configuration you want to search in. -1 means no filtering. 0 means only regular indexed content. |
Definition at line 1048 of file class.tx_indexedsearch.php.
| tx_indexedsearch::checkResume | ( | $ | row | ) |
Checking if the resume can be shown for the search result (depending on whether the rights are OK) ? Should it also check for gr_list "0,-1"?
| array | Result row array. |
Definition at line 1191 of file class.tx_indexedsearch.php.
| tx_indexedsearch::isDescending | ( | $ | inverse = FALSE |
) |
Returns "DESC" or "" depending on the settings of the incoming highest/lowest result order (piVars['desc']
| boolean | If true, inverse the order which is defined by piVars['desc'] |
Definition at line 1238 of file class.tx_indexedsearch.php.
| tx_indexedsearch::writeSearchStat | ( | $ | sWArr, | |
| $ | count, | |||
| $ | pt | |||
| ) |
Write statistics information to database for the search operation
| array | Search Word array | |
| integer | Number of hits | |
| integer | Milliseconds the search took |
Definition at line 1252 of file class.tx_indexedsearch.php.
| tx_indexedsearch::makeSearchForm | ( | $ | optValues | ) |
Make search form HTML
| array | Value/Labels pairs for search form selector boxes. |
Definition at line 1304 of file class.tx_indexedsearch.php.
| tx_indexedsearch::renderSelectBoxValues | ( | $ | value, | |
| $ | optValues | |||
| ) |
Function, rendering selector box values.
| string | Current value | |
| array | Array with the options as key=>value pairs |
Definition at line 1458 of file class.tx_indexedsearch.php.
| tx_indexedsearch::printRules | ( | ) |
Print the searching rules
Definition at line 1477 of file class.tx_indexedsearch.php.
| tx_indexedsearch::printResultSectionLinks | ( | ) |
Returns the anchor-links to the sections inside the displayed result rows.
Definition at line 1496 of file class.tx_indexedsearch.php.
| tx_indexedsearch::makeSectionHeader | ( | $ | id, | |
| $ | sectionTitleLinked, | |||
| $ | countResultRows | |||
| ) |
Returns the section header of the search result.
| string | ID for the section (used for anchor link) | |
| string | Section title with linked wrapped around | |
| integer | Number of results in section |
Definition at line 1530 of file class.tx_indexedsearch.php.
| tx_indexedsearch::printResultRow | ( | $ | row, | |
| $ | headerOnly = 0 | |||
| ) |
This prints a single result row, including a recursive call for subrows.
| array | Search result row | |
| integer | 1=Display only header (for sub-rows!), 2=nothing at all |
Definition at line 1551 of file class.tx_indexedsearch.php.
| tx_indexedsearch::pi_list_browseresults | ( | $ | showResultCount = 1, |
|
| $ | addString = '', |
|||
| $ | addPart = '', |
|||
| $ | freeIndexUid = -1 | |||
| ) |
Returns a results browser
| boolean | Show result count | |
| string | String appended to "displaying results..." notice. | |
| string | String appended after section "displaying results..." | |
| string | List of integers pointing to free indexing configurations to search. -1 represents no filtering, 0 represents TYPO3 pages only, any number above zero is a uid of an indexing configuration! |
Definition at line 1620 of file class.tx_indexedsearch.php.
| tx_indexedsearch::prepareResultRowTemplateData | ( | $ | row, | |
| $ | headerOnly | |||
| ) |
Preparing template data for the result row output
| array | Result row | |
| boolean | If set, display only header of result (for sub-results) |
Definition at line 1708 of file class.tx_indexedsearch.php.
| tx_indexedsearch::tellUsWhatIsSeachedFor | ( | $ | sWArr | ) |
Returns a string that tells which search words are searched for.
| array | Array of search words |
Definition at line 1762 of file class.tx_indexedsearch.php.
| tx_indexedsearch::wrapSW | ( | $ | str | ) |
Wraps the search words in the search-word list display (from ->tellUsWhatIsSeachedFor())
| string | search word to wrap (in local charset!) |
Definition at line 1796 of file class.tx_indexedsearch.php.
| tx_indexedsearch::renderSelectBox | ( | $ | name, | |
| $ | value, | |||
| $ | optValues | |||
| ) |
Makes a selector box
| string | Name of selector box | |
| string | Current value | |
| array | Array of options in the selector box (value => label pairs) |
Definition at line 1808 of file class.tx_indexedsearch.php.
| tx_indexedsearch::makePointerSelector_link | ( | $ | str, | |
| $ | p, | |||
| $ | freeIndexUid | |||
| ) |
Used to make the link for the result-browser. Notice how the links must resubmit the form after setting the new pointer-value in a hidden formfield.
| string | String to wrap in tag | |
| integer | Pointer value | |
| string | List of integers pointing to free indexing configurations to search. -1 represents no filtering, 0 represents TYPO3 pages only, any number above zero is a uid of an indexing configuration! |
Definition at line 1832 of file class.tx_indexedsearch.php.
| tx_indexedsearch::makeItemTypeIcon | ( | $ | it, | |
| $ | alt = '', |
|||
| $ | specRowConf | |||
| ) |
Return icon for file extension
| string | File extension / item type | |
| string | Title attribute value in icon. | |
| array | TypoScript configuration specifically for search result. |
Definition at line 1847 of file class.tx_indexedsearch.php.
| tx_indexedsearch::makeRating | ( | $ | row | ) |
Return the rating-HTML code for the result row. This makes use of the $this->firstRow
| array | Result row array |
Definition at line 1889 of file class.tx_indexedsearch.php.
| tx_indexedsearch::makeDescription | ( | $ | row, | |
| $ | noMarkup = 0, |
|||
| $ | lgd = 180 | |||
| ) |
Returns the resume for the search-result.
| array | Search result row | |
| boolean | If noMarkup is false, then the index_fulltext table is used to select the content of the page, split it with regex to display the search words in the text. | |
| integer | String length |
Definition at line 1933 of file class.tx_indexedsearch.php.
| tx_indexedsearch::markupSWpartsOfString | ( | $ | str | ) |
Marks up the search words from $this->sWarr in the $str with a color.
| string | Text in which to find and mark up search words. This text is assumed to be UTF-8 like the search words internally is. |
Definition at line 1964 of file class.tx_indexedsearch.php.
| tx_indexedsearch::makeTitle | ( | $ | row | ) |
Returns the title of the search result row
| array | Result row |
Definition at line 2044 of file class.tx_indexedsearch.php.
| tx_indexedsearch::makeInfo | ( | $ | row, | |
| $ | tmplArray | |||
| ) |
Returns the info-string in the bottom of the result-row display (size, dates, path)
| array | Result row | |
| array | Template array to modify |
Definition at line 2068 of file class.tx_indexedsearch.php.
| tx_indexedsearch::getSpecialConfigForRow | ( | $ | row | ) |
Returns configuration from TypoScript for result row based on ID / location in page tree!
| array | Result row |
Definition at line 2100 of file class.tx_indexedsearch.php.
| tx_indexedsearch::makeLanguageIndication | ( | $ | row | ) |
Returns the HTML code for language indication.
| array | Result row |
Definition at line 2124 of file class.tx_indexedsearch.php.
| tx_indexedsearch::makeAccessIndication | ( | $ | id | ) |
Returns the HTML code for the locking symbol. NOTICE: Requires a call to ->getPathFromPageId() first in order to work (done in ->makeInfo() by calling that first)
| integer | Page id for which to find answer |
Definition at line 2167 of file class.tx_indexedsearch.php.
| tx_indexedsearch::linkPage | ( | $ | id, | |
| $ | str, | |||
| $ | row = array(), |
|||
| $ | markUpSwParams = array() | |||
| ) |
Links the $str to page $id
| integer | Page id | |
| string | Title String to link | |
| array | Result row | |
| array | Additional parameters for marking up seach words |
Definition at line 2182 of file class.tx_indexedsearch.php.
| tx_indexedsearch::getRootLine | ( | $ | id, | |
| $ | pathMP = '' | |||
| ) |
Returns the path to the page $id
| integer | Page ID | |
| string | MP variable content. |
Definition at line 2229 of file class.tx_indexedsearch.php.
| tx_indexedsearch::getFirstSysDomainRecordForPage | ( | $ | id | ) |
Gets the first sys_domain record for the page, $id
| integer | Page id |
Definition at line 2244 of file class.tx_indexedsearch.php.
| tx_indexedsearch::getPathFromPageId | ( | $ | id, | |
| $ | pathMP = '' | |||
| ) |
Returns the path to the page $id
| integer | Page ID | |
| string | MP variable content |
Definition at line 2257 of file class.tx_indexedsearch.php.
| tx_indexedsearch::getMenu | ( | $ | id | ) |
Return the menu of pages used for the selector.
| integer | Page ID for which to return menu |
Definition at line 2309 of file class.tx_indexedsearch.php.
| tx_indexedsearch::multiplePagesType | ( | $ | item_type | ) |
Returns if an item type is a multipage item type
| string | Item type |
Definition at line 2328 of file class.tx_indexedsearch.php.
| tx_indexedsearch::utf8_to_currentCharset | ( | $ | str | ) |
Converts the input string from utf-8 to the backend charset.
| string | String to convert (utf-8) |
Definition at line 2338 of file class.tx_indexedsearch.php.
| & tx_indexedsearch::hookRequest | ( | $ | functionName | ) |
Returns an object reference to the hook object if any
| string | Name of the function you want to call / hook key |
Definition at line 2348 of file class.tx_indexedsearch.php.