TYPO3 API  SVNRelease
Public Member Functions | Public Attributes
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 94 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 243 of file class.tx_indexedsearch_modfunc1.php.

References $BACK_PATH, $GLOBALS, t3lib_BEfunc\getRecordTitlePrep(), indexed_info(), t3lib_div\makeInstance(), printPhashRowHeader(), and showPageDetails().

Referenced by main().

tx_indexedsearch_modfunc1::flagsMsg ( flags)

Creates message for flag value

Parameters:
integerFlags integer
Returns:
string Message string

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

Referenced by listWords().

tx_indexedsearch_modfunc1::getGrListEntriesForPhash ( phash,
gr_list 
)

Returns an array with gr_list records for a phash

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

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

Referenced by indexed_info().

tx_indexedsearch_modfunc1::getUidRootLineForClosestTemplate ( id)

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

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

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

tx_indexedsearch_modfunc1::indexed_info ( data,
firstColContent 
)

Create information table row for a page regarding indexing information.

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

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

References $GLOBALS, $res, $row, getGrListEntriesForPhash(), printPhashRow(), and returnNumberOfColumns().

Referenced by drawTableOfIndexedPages().

tx_indexedsearch_modfunc1::linkDetails ( string,
phash 
)

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

Parameters:
stringString to wrap, possibly a title or so.
integerphash value to show details for
Returns:
string Wrapped string

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

Referenced by printPhashRow().

tx_indexedsearch_modfunc1::linkList ( )

Creates link back to listing

Returns:
string Link back to list

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

Referenced by showDetailsForPhash().

tx_indexedsearch_modfunc1::linkMetaPhoneDetails ( string,
metaphone 
)

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

Parameters:
stringString to wrap
integerMetaphone value
Returns:
string Wrapped string

Definition at line 838 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:
stringString to wrap, possibly a title or so.
integerwid value to show details for
Returns:
string Wrapped string

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

Referenced by listWords().

tx_indexedsearch_modfunc1::listMetaphoneStat ( ftrows,
header 
)

Displays table of metaphone groups larger than 1

Parameters:
arrayResult from word selection (index_rel/index_words)
stringHeader string
Returns:
string HTML table

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

Referenced by showDetailsForPhash().

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

Create table with list of words from $ftrows

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

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

References $row, flagsMsg(), t3lib_div\getIndpEnv(), linkWordDetails(), t3lib_div\trimExplode(), and utf8_to_currentCharset().

Referenced by showDetailsForPhash().

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

Return icon for file extension

Parameters:
stringFile extension / item type
stringTitle attribute value in icon.
Returns:
string tag for icon

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

tx_indexedsearch_modfunc1::modMenu ( )

Initialize menu array internally

Returns:
void

Reimplemented from t3lib_extobjbase.

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

tx_indexedsearch_modfunc1::printExtraGrListRows ( extraGrListRows)

Prints the gr_lists attached to a indexed entry.

Parameters:
arrayArray of index_grlist records
Returns:
string HTML code.

Definition at line 1067 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:
arrayRow from query (combined phash table with sections etc).
booleanSet if grouped to previous result; the icon of the element is not shown again.
arrayArray 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 $GLOBALS, $row, t3lib_div\fixed_lgd_cs(), t3lib_div\implodeArrayForUrl(), linkDetails(), printRemoveIndexed(), and utf8_to_currentCharset().

Referenced by indexed_info().

tx_indexedsearch_modfunc1::printPhashRowHeader ( )

Creates the header row for the table

Returns:
string HTML string (table row)

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

Referenced by drawTableOfIndexedPages().

tx_indexedsearch_modfunc1::printReindex ( resultRow,
alt 
)

Button for re-indexing of documents

Parameters:
arrayphash table result row.
stringTitle attribute text for icon
Returns:
string HTML content; Icon wrapped in link.

Definition at line 1022 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:
stringList of phash integers
stringAlt-text for the garbage bin icon.
Returns:
string HTML img-tag with link around.

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

Referenced by printPhashRow().

tx_indexedsearch_modfunc1::printRootlineInfo ( row)

Print path for indexing

Parameters:
arrayResult row with content from index_section
Returns:
string Rootline information

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

tx_indexedsearch_modfunc1::processPageKeywords ( pageKeywords,
pageUid 
)

Setting / Unsetting keywords in page header

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

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

Referenced by main().

tx_indexedsearch_modfunc1::processStopWords ( stopWords)

Setting / Unsetting stopwords

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

Definition at line 1343 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:
integerPhash value
integerThe page uid for the section record (file/url could appear more than one place you know...)
Returns:
string HTML content

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

Referenced by main().

tx_indexedsearch_modfunc1::removeIndexedPhashRow ( phashList,
clearPageCache = 1 
)

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

Parameters:
stringList of phash integers
booleanIf set, page cache is cleared as well.
Returns:
void

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

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 585 of file class.tx_indexedsearch_modfunc1.php.

Referenced by indexed_info().

tx_indexedsearch_modfunc1::showDetailsForMetaphone ( metaphone)

Show details for metaphone value

Parameters:
integerMetaphone integer hash
Returns:
string HTML content

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

Referenced by main().

tx_indexedsearch_modfunc1::showDetailsForPhash ( phash)

Showing details for a particular phash row

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

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

References $content, $GLOBALS, $row, t3lib_BEfunc\getRecord(), linkList(), listMetaphoneStat(), listWords(), utf8_to_currentCharset(), and t3lib_div\view_array().

Referenced by main().

tx_indexedsearch_modfunc1::showDetailsForWord ( wid)

Show details for words

Parameters:
integerWord ID (wid)
Returns:
string HTML content

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

Referenced by main().

tx_indexedsearch_modfunc1::showPageDetails ( string,
id 
)

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

Parameters:
stringString to wrap, possibly a title or so.
integerphash value to show details for
Returns:
string Wrapped string

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

Referenced by drawTableOfIndexedPages().

tx_indexedsearch_modfunc1::utf8_to_currentCharset ( string)

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

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

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

Referenced by listWords(), printPhashRow(), and showDetailsForPhash().


Member Data Documentation

tx_indexedsearch_modfunc1::$allPhashListed = array()

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

tx_indexedsearch_modfunc1::$external_parsers = array()

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

tx_indexedsearch_modfunc1::$iconFileNameCache = array()

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

tx_indexedsearch_modfunc1::$indexerObj

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


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