"TYPO3 4.0.1: tx_indexedsearch_modfunc1 Class Reference", "datetime" => "Sat Dec 2 19:27:15 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

tx_indexedsearch_modfunc1 Class Reference

Inheritance diagram for tx_indexedsearch_modfunc1:

Inheritance graph
[legend]
Collaboration diagram for tx_indexedsearch_modfunc1:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 modMenu ()
 main ()
 drawTableOfIndexedPages ()
 indexed_info ($data, $firstColContent)
 printPhashRow ($row, $grouping=0, $extraGrListRows)
 printPhashRowHeader ()
 returnNumberOfColumns ()
 showDetailsForPhash ($phash)
 listWords ($ftrows, $header, $stopWordBoxes=FALSE, $page='')
 listMetaphoneStat ($ftrows, $header)
 linkWordDetails ($string, $wid)
 linkMetaPhoneDetails ($string, $metaphone)
 flagsMsg ($flags)
 showDetailsForWord ($wid)
 showDetailsForMetaphone ($metaphone)
 printRemoveIndexed ($phash, $alt)
 printReindex ($resultRow, $alt)
 linkDetails ($string, $phash)
 linkList ()
 showPageDetails ($string, $id)
 printExtraGrListRows ($extraGrListRows)
 printRootlineInfo ($row)
 makeItemTypeIcon ($it, $alt='')
 utf8_to_currentCharset ($string)
 reindexPhash ($phash, $pageId)
 getUidRootLineForClosestTemplate ($id)
 removeIndexedPhashRow ($phashList, $clearPageCache=1)
 getGrListEntriesForPhash ($phash, $gr_list)
 processStopWords ($stopWords)
 processPageKeywords ($pageKeywords, $pageUid)

Public Attributes

 $allPhashListed = array()
 $external_parsers = array()
 $iconFileNameCache = array()
 $indexerObj

Detailed Description

Definition at line 106 of file class.tx_indexedsearch_modfunc1.php.

Member Function Documentation

tx_indexedsearch_modfunc1::drawTableOfIndexedPages (   ) 
 

Produces a table with indexing information for each page.

Returns:
string HTML output

Definition at line 248 of file class.tx_indexedsearch_modfunc1.php.

References t3lib_div::fixed_lgd(), and t3lib_div::makeInstance().

tx_indexedsearch_modfunc1::flagsMsg (  $  flags  ) 
 

Creates message for flag value

Parameters:
integer Flags integer
Returns:
string Message string

Definition at line 846 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::getGrListEntriesForPhash (  $  phash,
$  gr_list
) 
 

Returns an array with gr_list records for a phash

Parameters:
integer phash integer to look up on
string gr_list string to filter OUT of the result (first occurence)
Returns:
array Array of records from index_grlist table

Definition at line 1314 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::getUidRootLineForClosestTemplate (  $  id  ) 
 

Get rootline for closest TypoScript template root. Algorithm same as used in Web > Template, Object browser

Parameters:
integer The page id to traverse rootline back from
Returns:
array Array where the root lines uid values are found.

Definition at line 1227 of file class.tx_indexedsearch_modfunc1.php.

References t3lib_div::makeInstance().

tx_indexedsearch_modfunc1::indexed_info (  $  data,
$  firstColContent
) 
 

Create information table row for a page regarding indexing information.

Parameters:
array Data array for this page
string HTML content for first column (page tree icon etc.)
Returns:
string HTML code. (table row)

Definition at line 299 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::linkDetails (  $  string,
$  phash
) 
 

Wraps input string in a link that will display details for the phash value set.

Parameters:
string String to wrap, possibly a title or so.
integer phash value to show details for
Returns:
string Wrapped string

Definition at line 1035 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::linkList (   ) 
 

Creates link back to listing

Returns:
string Link back to list

Definition at line 1044 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::linkMetaPhoneDetails (  $  string,
$  metaphone
) 
 

Wraps input string in a link to see more details for metaphone value

Parameters:
string String to wrap
integer Metaphone value
Returns:
string Wrapped string

Definition at line 836 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::linkWordDetails (  $  string,
$  wid
) 
 

Wraps input string in a link that will display details for the word. Eg. which other pages has the word, metaphone associations etc.

Parameters:
string String to wrap, possibly a title or so.
integer wid value to show details for
Returns:
string Wrapped string

Definition at line 824 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::listMetaphoneStat (  $  ftrows,
$  header
) 
 

Displays table of metaphone groups larger than 1

Parameters:
array Result from word selection (index_rel/index_words)
string Header string
Returns:
string HTML table

Definition at line 787 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::listWords (  $  ftrows,
$  header,
$  stopWordBoxes = FALSE,
$  page = ''
) 
 

Create table with list of words from $ftrows

Parameters:
array Array of records selected from index_rel/index_words
string Header string to show before table.
boolean If set, the stopWord checkboxes will be shown in the word list. Only for admins. (because it is a global setting, not per-site).
array The page record from which to load the keywords, if any.
Returns:
string HTML table

Definition at line 737 of file class.tx_indexedsearch_modfunc1.php.

References t3lib_div::trimExplode().

tx_indexedsearch_modfunc1::main (   ) 
 

Produces main content of the module

Returns:
string HTML output

Definition at line 144 of file class.tx_indexedsearch_modfunc1.php.

References t3lib_div::_GP(), t3lib_div::_POST(), t3lib_div::getUserObj(), t3lib_div::makeInstance(), processPageKeywords(), processStopWords(), and removeIndexedPhashRow().

tx_indexedsearch_modfunc1::makeItemTypeIcon (  $  it,
$  alt = ''
) 
 

Return icon for file extension

Parameters:
string File extension / item type
string Title attribute value in icon.
Returns:
string tag for icon

Definition at line 1116 of file class.tx_indexedsearch_modfunc1.php.

References t3lib_div::getFileAbsFileName().

tx_indexedsearch_modfunc1::modMenu (   ) 
 

Initialize menu array internally

Returns:
void

Definition at line 120 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::printExtraGrListRows (  $  extraGrListRows  ) 
 

Prints the gr_lists attached to a indexed entry.

Parameters:
array Array of index_grlist records
Returns:
string HTML code.

Definition at line 1065 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::printPhashRow (  $  row,
$  grouping = 0,
$  extraGrListRows
) 
 

Render a single row of information about a indexing entry.

Parameters:
array Row from query (combined phash table with sections etc).
boolean Set if grouped to previous result; the icon of the element is not shown again.
array Array of index_grlist records.
Returns:
array Array of table rows.
See also:
indexed_info()

Definition at line 386 of file class.tx_indexedsearch_modfunc1.php.

References t3lib_div::fixed_lgd_cs(), and t3lib_div::implodeArrayForUrl().

tx_indexedsearch_modfunc1::printPhashRowHeader (   ) 
 

Creates the header row for the table

Returns:
string HTML string (table row)

Definition at line 527 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::printReindex (  $  resultRow,
$  alt
) 
 

Button for re-indexing of documents

Parameters:
array phash table result row.
string Title attribute text for icon
Returns:
string HTML content; Icon wrapped in link.

Definition at line 1020 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::printRemoveIndexed (  $  phash,
$  alt
) 
 

Creates icon which clears indexes for a certain list of phash values.

Parameters:
string List of phash integers
string Alt-text for the garbage bin icon.
Returns:
string HTML img-tag with link around.

Definition at line 1007 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::printRootlineInfo (  $  row  ) 
 

Print path for indexing

Parameters:
array Result row with content from index_section
Returns:
string Rootline information

Definition at line 1082 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::processPageKeywords (  $  pageKeywords,
$  pageUid
) 
 

Setting / Unsetting keywords in page header

Parameters:
array Page keywords as keys in array with value 0 or 1 for set or unset.
integer The page uid of the header where the keywords are to be set.
Returns:
void

Definition at line 1354 of file class.tx_indexedsearch_modfunc1.php.

References t3lib_BEfunc::getRecord(), t3lib_div::makeInstance(), and t3lib_div::trimExplode().

Referenced by main().

tx_indexedsearch_modfunc1::processStopWords (  $  stopWords  ) 
 

Setting / Unsetting stopwords

Parameters:
array Array of stop-words WIDs with 0/1 to set / unset
Returns:
void

Definition at line 1334 of file class.tx_indexedsearch_modfunc1.php.

Referenced by main().

tx_indexedsearch_modfunc1::reindexPhash (  $  phash,
$  pageId
) 
 

Re-indexing files/records attached to a page.

Parameters:
integer Phash value
integer The page uid for the section record (file/url could appear more than one place you know...)
Returns:
string HTML content

Definition at line 1173 of file class.tx_indexedsearch_modfunc1.php.

References t3lib_div::makeInstance(), and t3lib_div::view_array().

tx_indexedsearch_modfunc1::removeIndexedPhashRow (  $  phashList,
$  clearPageCache = 1
) 
 

Removes ALL data regarding a certain list of indexed phash-row

Parameters:
string List of phash integers
boolean If set, page cache is cleared as well.
Returns:
void

Definition at line 1270 of file class.tx_indexedsearch_modfunc1.php.

References t3lib_div::trimExplode().

Referenced by main().

tx_indexedsearch_modfunc1::returnNumberOfColumns (   ) 
 

Returns the number of columns depending on display type of list

Returns:
integer Number of columns in list:

Definition at line 582 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::showDetailsForMetaphone (  $  metaphone  ) 
 

Show details for metaphone value

Parameters:
integer Metaphone integer hash
Returns:
string HTML content

Definition at line 936 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::showDetailsForPhash (  $  phash  ) 
 

Showing details for a particular phash row

Parameters:
integer phash value to display details for.
Returns:
string HTML content

Definition at line 618 of file class.tx_indexedsearch_modfunc1.php.

References t3lib_BEfunc::getRecord(), and t3lib_div::view_array().

tx_indexedsearch_modfunc1::showDetailsForWord (  $  wid  ) 
 

Show details for words

Parameters:
integer Word ID (wid)
Returns:
string HTML content

Definition at line 877 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::showPageDetails (  $  string,
$  id
) 
 

Wraps input string in a link that will display details for the phash value set.

Parameters:
string String to wrap, possibly a title or so.
integer phash value to show details for
Returns:
string Wrapped string

Definition at line 1055 of file class.tx_indexedsearch_modfunc1.php.

tx_indexedsearch_modfunc1::utf8_to_currentCharset (  $  string  ) 
 

Converts the input string from utf-8 to the backend charset.

Parameters:
string String to convert (utf-8)
Returns:
string Converted string (backend charset if different from utf-8)

Definition at line 1141 of file class.tx_indexedsearch_modfunc1.php.

The documentation for this class was generated from the following file: