TYPO3 CMS  TYPO3_6-2
Public Member Functions | Public Attributes | Protected Attributes | List of all members
TYPO3\CMS\Backend\Tree\View\PagePositionMap Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Tree\View\PagePositionMap:
ext_posMap ext_posMap ext_posMap_pages ext_posMap_tt_content t3lib_positionMap

Public Member Functions

 __construct ($pageTreeClassName=NULL)
 
 JSimgFunc ($prefix='')
 
 boldTitle ($t_code, $dat, $id)
 
 onClickEvent ($pid, $newPagePID)
 
 insertlabel ()
 
 linkPageTitle ($str, $rec)
 
 checkNewPageInPid ($pid)
 
 getModConfig ($pid)
 
 insertQuadLines ($codes, $allBlank=FALSE)
 
 printContentElementColumns ($pid, $moveUid, $colPosList, $showHidden, $R_URI)
 
 printRecordMap ($lines, $colPosArray, $pid=0)
 
 wrapColumnHeader ($str, $vv)
 
 insertPositionIcon ($row, $vv, $kk, $moveUid, $pid)
 
 onClickInsertRecord ($row, $vv, $moveUid, $pid, $sys_lang=0)
 
 wrapRecordHeader ($str, $row)
 
 getRecordHeader ($row)
 
 wrapRecordTitle ($str, $row)
 

Public Attributes

 $moveOrCopy = 'move'
 
 $dontPrintPageInsertIcons = 0
 
 $backPath = ''
 
 $depth = 2
 
 $cur_sys_language
 
 $R_URI = ''
 
 $elUid = ''
 
 $moveUid = ''
 
 $getModConfigCache = array()
 
 $checkNewPageCache = array()
 
 $l_insertNewPageHere = 'insertNewPageHere'
 
 $l_insertNewRecordHere = 'insertNewRecordHere'
 
 $modConfigStr = 'mod.web_list.newPageWiz'
 

Protected Attributes

 $pageTreeClassName = 'localPageTree'
 

Detailed Description

Position map class - generating a page tree / content element list which links for inserting (copy/move) of records. Used for pages / tt_content element wizards of various kinds.

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

Definition at line 28 of file PagePositionMap.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::__construct (   $pageTreeClassName = NULL)

Constructor allowing to set pageTreeImplementation

Parameters
string$pageTreeClassName

Definition at line 116 of file PagePositionMap.php.

References TYPO3\CMS\Backend\Tree\View\PagePositionMap\$depth, TYPO3\CMS\Backend\Tree\View\PagePositionMap\$pageTreeClassName, TYPO3\CMS\Backend\Tree\View\PagePositionMap\$R_URI, TYPO3\CMS\Backend\Tree\View\PagePositionMap\checkNewPageInPid(), TYPO3\CMS\Backend\Tree\View\PagePositionMap\insertQuadLines(), TYPO3\CMS\Backend\Tree\View\PagePositionMap\JSimgFunc(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Backend\Tree\View\PagePositionMap\onClickEvent().

Member Function Documentation

◆ boldTitle()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::boldTitle (   $t_code,
  $dat,
  $id 
)

Wrap $t_code in bold IF the $dat uid matches $id

Parameters
string$t_codeTitle string
array$datInfomation array with record array inside.
integer$idThe current id.
Returns
string The title string.
Todo:
Define visibility

Definition at line 252 of file PagePositionMap.php.

◆ checkNewPageInPid()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::checkNewPageInPid (   $pid)

Checks if the user has permission to created pages inside of the $pid page. Uses caching so only one regular lookup is made - hence you can call the function multiple times without worrying about performance.

Parameters
integer$pidPage id for which to test.
Returns
boolean
Todo:
Define visibility

Definition at line 312 of file PagePositionMap.php.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\__construct().

◆ getModConfig()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::getModConfig (   $pid)

Returns module configuration for a pid.

Parameters
integer$pidPage id for which to get the module configuration.
Returns
array The properties of teh module configuration for the page id.
See also
onClickEvent()
Todo:
Define visibility

Definition at line 328 of file PagePositionMap.php.

◆ getRecordHeader()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::getRecordHeader (   $row)

Create record header (includes teh record icon, record title etc.)

Parameters
array$rowRecord row.
Returns
string HTML
Todo:
Define visibility

Definition at line 556 of file PagePositionMap.php.

◆ insertlabel()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::insertlabel ( )

Get label, htmlspecialchars()'ed

Returns
string The localized label for "insert new page here
Todo:
Define visibility

Definition at line 288 of file PagePositionMap.php.

◆ insertPositionIcon()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::insertPositionIcon (   $row,
  $vv,
  $kk,
  $moveUid,
  $pid 
)

Creates a linked position icon.

Parameters
mixed$rowElement row. If this is an array the link will cause an insert after this content element, otherwise the link will insert at the first position in the column
string$vvColumn position value.
integer$kkColumn key.
integer$moveUidMove uid
integer$pidPID value.
Returns
string
Todo:
Define visibility

Definition at line 501 of file PagePositionMap.php.

◆ insertQuadLines()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::insertQuadLines (   $codes,
  $allBlank = FALSE 
)

Insert half/quad lines.

Parameters
string$codesKeywords for which lines to insert.
boolean$allBlankIf TRUE all lines are just blank clear.gifs
Returns
string HTML content.
Todo:
Define visibility

Definition at line 344 of file PagePositionMap.php.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\__construct().

◆ JSimgFunc()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::JSimgFunc (   $prefix = '')

Creates the JavaScritp for insert new-record rollover image

Parameters
string$prefixInsert record image prefix.
Returns
string <script> section
Todo:
Define visibility

Definition at line 221 of file PagePositionMap.php.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\__construct().

◆ linkPageTitle()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::linkPageTitle (   $str,
  $rec 
)

Wrapping page title.

Parameters
string$strPage title.
array$recPage record (?)
Returns
string Wrapped title.
Todo:
Define visibility

Definition at line 300 of file PagePositionMap.php.

◆ onClickEvent()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::onClickEvent (   $pid,
  $newPagePID 
)

Creates the onclick event for the insert-icons.

TSconfig mod.web_list.newPageWiz.overrideWithExtension may contain an extension which provides a module to be used instead of the normal create new page wizard.

Parameters
integer$pidThe pid.
integer$newPagePIDNew page id.
Returns
string Onclick attribute content
Todo:
Define visibility

Definition at line 270 of file PagePositionMap.php.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\__construct().

◆ onClickInsertRecord()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::onClickInsertRecord (   $row,
  $vv,
  $moveUid,
  $pid,
  $sys_lang = 0 
)

Create on-click event value.

Parameters
mixed$rowThe record. If this is not an array with the record data the insert will be for the first position in the column
string$vvColumn position value.
integer$moveUidMove uid
integer$pidPID value.
integer$sys_langSystem language (not used currently)
Returns
string
Todo:
Define visibility

Definition at line 525 of file PagePositionMap.php.

◆ printContentElementColumns()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::printContentElementColumns (   $pid,
  $moveUid,
  $colPosList,
  $showHidden,
  $R_URI 
)

Creates HTML for inserting/moving content elements.

Parameters
integer$pidpage id onto which to insert content element.
integer$moveUidMove-uid (tt_content element uid?)
string$colPosListList of columns to show
boolean$showHiddenIf not set, then hidden/starttime/endtime records are filtered out.
string$R_URIRequest URI
Returns
string HTML
Todo:
Define visibility

Definition at line 373 of file PagePositionMap.php.

◆ printRecordMap()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::printRecordMap (   $lines,
  $colPosArray,
  $pid = 0 
)

Creates the table with the content columns

Parameters
array$linesArray with arrays of lines for each column
array$colPosArrayColumn position array
integer$pidThe id of the page
Returns
string HTML
Todo:
Define visibility

Definition at line 403 of file PagePositionMap.php.

◆ wrapColumnHeader()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::wrapColumnHeader (   $str,
  $vv 
)

Wrapping the column header

Parameters
string$strHeader value
string$vvColumn info.
Returns
string
See also
printRecordMap()
Todo:
Define visibility

Definition at line 485 of file PagePositionMap.php.

◆ wrapRecordHeader()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::wrapRecordHeader (   $str,
  $row 
)

Wrapping the record header (from getRecordHeader())

Parameters
string$strHTML content
array$rowRecord array.
Returns
string HTML content
Todo:
Define visibility

Definition at line 545 of file PagePositionMap.php.

◆ wrapRecordTitle()

TYPO3\CMS\Backend\Tree\View\PagePositionMap::wrapRecordTitle (   $str,
  $row 
)

Wrapping the title of the record.

Parameters
string$strThe title value.
array$rowThe record row.
Returns
string Wrapped title string.
Todo:
Define visibility

Definition at line 570 of file PagePositionMap.php.

Member Data Documentation

◆ $backPath

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$backPath = ''
Todo:
Define visibility

Definition at line 44 of file PagePositionMap.php.

◆ $checkNewPageCache

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$checkNewPageCache = array()
Todo:
Define visibility

Definition at line 86 of file PagePositionMap.php.

◆ $cur_sys_language

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$cur_sys_language
Todo:
Define visibility

Definition at line 56 of file PagePositionMap.php.

◆ $depth

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$depth = 2
Todo:
Define visibility

Definition at line 50 of file PagePositionMap.php.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\__construct().

◆ $dontPrintPageInsertIcons

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$dontPrintPageInsertIcons = 0
Todo:
Define visibility

Definition at line 39 of file PagePositionMap.php.

◆ $elUid

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$elUid = ''
Todo:
Define visibility

Definition at line 69 of file PagePositionMap.php.

◆ $getModConfigCache

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$getModConfigCache = array()
Todo:
Define visibility

Definition at line 81 of file PagePositionMap.php.

◆ $l_insertNewPageHere

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$l_insertNewPageHere = 'insertNewPageHere'
Todo:
Define visibility

Definition at line 92 of file PagePositionMap.php.

◆ $l_insertNewRecordHere

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$l_insertNewRecordHere = 'insertNewRecordHere'
Todo:
Define visibility

Definition at line 97 of file PagePositionMap.php.

◆ $modConfigStr

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$modConfigStr = 'mod.web_list.newPageWiz'
Todo:
Define visibility

Definition at line 102 of file PagePositionMap.php.

◆ $moveOrCopy

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$moveOrCopy = 'move'
Todo:
Define visibility

Definition at line 34 of file PagePositionMap.php.

◆ $moveUid

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$moveUid = ''
Todo:
Define visibility

Definition at line 75 of file PagePositionMap.php.

◆ $pageTreeClassName

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$pageTreeClassName = 'localPageTree'
protected

Definition at line 109 of file PagePositionMap.php.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\__construct().

◆ $R_URI

TYPO3\CMS\Backend\Tree\View\PagePositionMap::$R_URI = ''
Todo:
Define visibility

Definition at line 63 of file PagePositionMap.php.

Referenced by TYPO3\CMS\Backend\Tree\View\PagePositionMap\__construct().