TYPO3 CMS  TYPO3_6-2
Public Member Functions | Public Attributes | Protected Attributes | List of all members
TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController Class Reference
Inheritance diagram for TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController:
TYPO3\CMS\Backend\Module\AbstractFunctionModule tx_indexedsearch_modfunc1

Public Member Functions

 __construct ()
 
 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='')
 
 reindexPhash ($phash, $pageId)
 
 getUidRootLineForClosestTemplate ($id)
 
 removeIndexedPhashRow ($phashList, $clearPageCache=1)
 
 getGrListEntriesForPhash ($phash, $gr_list)
 
 processStopWords ($stopWords)
 
 processPageKeywords ($pageKeywords, $pageUid)
 
- Public Member Functions inherited from TYPO3\CMS\Backend\Module\AbstractFunctionModule
 init (&$pObj, $conf)
 
 handleExternalFunctionValue ()
 
 incLocalLang ()
 
 checkExtObj ()
 
 extObjContent ()
 
 modMenu ()
 

Public Attributes

 $allPhashListed = array()
 
 $external_parsers = array()
 
 $iconFileNameCache = array()
 
 $indexerConfig = array()
 
 $enableMetaphoneSearch = FALSE
 
 $indexerObj
 
- Public Attributes inherited from TYPO3\CMS\Backend\Module\AbstractFunctionModule
 $pObj
 
 $thisPath = ''
 
 $localLangFile = 'locallang.php'
 
 $extClassConf
 
 $function_key = ''
 

Protected Attributes

 $maxListPerPage
 

Detailed Description

Indexing class for TYPO3 frontend

Author
Kasper Skårhøj kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om

Definition at line 25 of file IndexedPagesController.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::__construct ( )

Default constructor loads additional locallang

Definition at line 73 of file IndexedPagesController.php.

References $GLOBALS.

Member Function Documentation

◆ drawTableOfIndexedPages()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::drawTableOfIndexedPages ( )

Produces a table with indexing information for each page.

Returns
string HTML output
Todo:
Define visibility

Definition at line 190 of file IndexedPagesController.php.

References $BACK_PATH, $GLOBALS, TYPO3\CMS\Backend\Utility\IconUtility\getIcon(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitlePrep(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\indexed_info(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\printPhashRowHeader(), and TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\showPageDetails().

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\main().

◆ flagsMsg()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::flagsMsg (   $flags)

Creates message for flag value

Parameters
integerFlags integer
Returns
string Message string
Todo:
Define visibility

Definition at line 653 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\listWords().

◆ getGrListEntriesForPhash()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::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
Todo:
Define visibility

Definition at line 1013 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\indexed_info().

◆ getUidRootLineForClosestTemplate()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::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.
Todo:
Define visibility

Definition at line 938 of file IndexedPagesController.php.

◆ indexed_info()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::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)
Todo:
Define visibility

Definition at line 229 of file IndexedPagesController.php.

References $GLOBALS, TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\getGrListEntriesForPhash(), TYPO3\CMS\Backend\Utility\BackendUtility\getModuleUrl(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\printPhashRow(), and TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\returnNumberOfColumns().

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\drawTableOfIndexedPages().

◆ linkDetails()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::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
Todo:
Define visibility

Definition at line 785 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\printPhashRow().

◆ linkList()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::linkList ( )

Creates link back to listing

Returns
string Link back to list
Todo:
Define visibility

Definition at line 795 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\showDetailsForPhash().

◆ linkMetaPhoneDetails()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::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
Todo:
Define visibility

Definition at line 642 of file IndexedPagesController.php.

◆ linkWordDetails()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::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
Todo:
Define visibility

Definition at line 630 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\listWords().

◆ listMetaphoneStat()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::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
Todo:
Define visibility

Definition at line 595 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\showDetailsForPhash().

◆ listWords()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::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
Todo:
Define visibility

Definition at line 551 of file IndexedPagesController.php.

References TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\flagsMsg(), TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\linkWordDetails(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\showDetailsForPhash().

◆ main()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::main ( )

Produces main content of the module

Returns
string HTML output
Todo:
Define visibility

Definition at line 107 of file IndexedPagesController.php.

References $GLOBALS, $TYPO3_CONF_VARS, TYPO3\CMS\Core\Utility\GeneralUtility\_GET(), TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Core\Utility\GeneralUtility\_POST(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\drawTableOfIndexedPages(), TYPO3\CMS\Backend\Utility\BackendUtility\getFuncMenu(), TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\processPageKeywords(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\processStopWords(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\reindexPhash(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\removeIndexedPhashRow(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\showDetailsForMetaphone(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\showDetailsForPhash(), and TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\showDetailsForWord().

◆ makeItemTypeIcon()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::makeItemTypeIcon (   $it,
  $alt = '' 
)

Return icon for file extension

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

Definition at line 867 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\printPhashRow().

◆ modMenu()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::modMenu ( )

Initialize menu array internally

Returns
void
Todo:
Define visibility

Definition at line 83 of file IndexedPagesController.php.

◆ printExtraGrListRows()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::printExtraGrListRows (   $extraGrListRows)

Prints the gr_lists attached to a indexed entry.

Parameters
arrayArray of index_grlist records
Returns
string HTML code.
Todo:
Define visibility

Definition at line 818 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\printPhashRow().

◆ printPhashRow()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::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()
Todo:
Define visibility

Definition at line 301 of file IndexedPagesController.php.

References $GLOBALS, TYPO3\CMS\Backend\Utility\BackendUtility\dateTimeAge(), TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs(), TYPO3\CMS\Core\Utility\GeneralUtility\formatSize(), TYPO3\CMS\Core\Utility\GeneralUtility\implodeArrayForUrl(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\linkDetails(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\makeItemTypeIcon(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\printExtraGrListRows(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\printReindex(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\printRemoveIndexed(), and TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\printRootlineInfo().

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\indexed_info().

◆ printPhashRowHeader()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::printPhashRowHeader ( )

Creates the header row for the table

Returns
string HTML string (table row)
Todo:
Define visibility

Definition at line 413 of file IndexedPagesController.php.

References TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\printRemoveIndexed().

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\drawTableOfIndexedPages().

◆ printReindex()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::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.
Todo:
Define visibility

Definition at line 771 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\printPhashRow().

◆ printRemoveIndexed()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::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.
Todo:
Define visibility

Definition at line 759 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\printPhashRow(), and TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\printPhashRowHeader().

◆ printRootlineInfo()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::printRootlineInfo (   $row)

Print path for indexing

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

Definition at line 835 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\printPhashRow().

◆ processPageKeywords()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::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
Todo:
Define visibility

Definition at line 1054 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\main().

◆ processStopWords()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::processStopWords (   $stopWords)

Setting / Unsetting stopwords

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

Definition at line 1034 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\main().

◆ reindexPhash()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::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
Todo:
Define visibility

Definition at line 897 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\main().

◆ removeIndexedPhashRow()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::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
Todo:
Define visibility

Definition at line 970 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\main().

◆ returnNumberOfColumns()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::returnNumberOfColumns ( )

Returns the number of columns depending on display type of list

Returns
integer Number of columns in list:
Todo:
Define visibility

Definition at line 465 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\indexed_info().

◆ showDetailsForMetaphone()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::showDetailsForMetaphone (   $metaphone)

Show details for metaphone value

Parameters
integerMetaphone integer hash
Returns
string HTML content
Todo:
Define visibility

Definition at line 715 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\main().

◆ showDetailsForPhash()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::showDetailsForPhash (   $phash)

Showing details for a particular phash row

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

Definition at line 490 of file IndexedPagesController.php.

References $GLOBALS, TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\linkList(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\listMetaphoneStat(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\listWords(), and TYPO3\CMS\Core\Utility\DebugUtility\viewArray().

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\main().

◆ showDetailsForWord()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::showDetailsForWord (   $wid)

Show details for words

Parameters
integerWord ID (wid)
Returns
string HTML content
Todo:
Define visibility

Definition at line 671 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\main().

◆ showPageDetails()

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::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
Todo:
Define visibility

Definition at line 807 of file IndexedPagesController.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\drawTableOfIndexedPages().

Member Data Documentation

◆ $allPhashListed

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::$allPhashListed = array()
Todo:
Define visibility

Definition at line 31 of file IndexedPagesController.php.

◆ $enableMetaphoneSearch

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::$enableMetaphoneSearch = FALSE
Todo:
Define visibility

Definition at line 55 of file IndexedPagesController.php.

◆ $external_parsers

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::$external_parsers = array()
Todo:
Define visibility

Definition at line 37 of file IndexedPagesController.php.

◆ $iconFileNameCache

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::$iconFileNameCache = array()
Todo:
Define visibility

Definition at line 43 of file IndexedPagesController.php.

◆ $indexerConfig

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::$indexerConfig = array()
Todo:
Define visibility

Definition at line 49 of file IndexedPagesController.php.

◆ $indexerObj

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::$indexerObj

Definition at line 63 of file IndexedPagesController.php.

◆ $maxListPerPage

TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController::$maxListPerPage
protected

Default number of list entries per page

Definition at line 68 of file IndexedPagesController.php.