Solutions Open Source

Référence de la classe tx_cms_layout

Graphe d'héritage de tx_cms_layout:

Inheritance graph
[légende]
Graphe de collaboration de tx_cms_layout:

Collaboration graph
[légende]

Liste de tous les membres

Fonctions membres publiques

 getTable ($table, $id)
 getTable_pages ($id)
 getTable_tt_content ($id)
 getTable_fe_users ($id)
 getTable_sys_note ($id)
 getTable_tt_board ($id)
 getTable_tt_address ($id)
 getTable_tt_links ($id)
 getTable_tt_guest ($id)
 getTable_tt_news ($id)
 getTable_tt_calender ($id)
 getTable_tt_products ($id)
 makeOrdinaryList ($table, $id, $fList, $icon=0, $addWhere='')
 dataFields ($fieldArr, $table, $row, $out=array())
 headerFields ($fieldArr, $table, $out=array())
 pages_getTree ($theRows, $pid, $qWhere, $treeIcons, $depth)
 pages_drawItem ($row, $fieldArr)
 tt_content_drawColHeader ($colName, $editParams, $newParams)
 tt_content_drawHeader ($row, $space=0, $disableMoveAndNewButtons=FALSE, $langMode=FALSE)
 tt_content_drawItem ($row, $isRTE=FALSE)
 getNonTranslatedTTcontentUids ($defLanguageCount, $id, $lP)
 newLanguageButton ($defLanguageCount, $lP)
 infoGif ($infoArr)
 newContentElementOnClick ($id, $colPos, $sys_language)
 linkEditContent ($str, $row)
 linkRTEbutton ($row)
 languageSelector ($id)
 getResult ($result)
 tt_board_getTree ($theRows, $parent, $pid, $qWhere, $treeIcons)
 tt_board_drawItem ($table, $row, $re)
 numberOfRecords ($table, $pid)
 renderText ($input)
 getIcon ($table, $row)
 getProcessedValue ($table, $fieldList, $row, &$info)
 isDisabled ($table, $row)
 wordWrapper ($content, $max=50, $char='-')
 noEditIcon ($label='noEditItems')
 cleanTableNames ()
 isRTEforField ($table, $row, $field)
 getSpecConfForField ($table, $row, $field)
 getPageInfoBox ($rec, $edit=0)
 getTableMenu ($id)
 strip_tags ($content, $fillEmptyContent=false)

Attributs publics

 $stat_select_field = 'page_id'
 $stat_codes = array()
 $pI_showUser = 0
 $pI_showStat = 1
 $nextThree = 3
 $pages_noEditColumns = 0
 $option_showBigButtons = 1
 $option_newWizard = 1
 $ext_function = 0
 $doEdit = 1
 $agePrefixes = ' min| hrs| days| yrs'
 $externalTables = array()
 $descrTable
 $defLangBinding = FALSE
 $tt_contentConfig
 $allowedTableNames = array()
 $activeTables = array()
 $tt_contentData
 $CType_labels = array()
 $itemLabels = array()

Documentation des fonctions membres

tx_cms_layout::getTable ( $  table,
$  id 
)

Adds the code of a single table

Paramètres:
string Table name
integer Current page id
Renvoie:
string HTML for listing.

tx_cms_layout::getTable_pages ( $  id  ) 

Renders records from the pages table from page id (Used to get information about the page tree content by "Web>Info"!)

Paramètres:
integer Page id
Renvoie:
string HTML for the listing

tx_cms_layout::getTable_tt_content ( $  id  ) 

Renders Content Elements from the tt_content table from page id

Paramètres:
integer Page id
Renvoie:
string HTML for the listing

tx_cms_layout::getTable_fe_users ( $  id  ) 

Renders Frontend Users from the fe_users table from page id

Paramètres:
integer Page id
Renvoie:
string HTML for the listing

tx_cms_layout::getTable_sys_note ( $  id  ) 

Renders records from the sys_notes table from page id NOTICE: Requires the sys_note extension to be loaded.

Paramètres:
integer Page id
Renvoie:
string HTML for the listing

tx_cms_layout::getTable_tt_board ( $  id  ) 

Renders records from the tt_board table from page id NOTICE: Requires the tt_board extension to be loaded.

Paramètres:
integer Page id
Renvoie:
string HTML for the listing

tx_cms_layout::getTable_tt_address ( $  id  ) 

Renders address records from the tt_address table from page id NOTICE: Requires the tt_address extension to be loaded.

Paramètres:
integer Page id
Renvoie:
string HTML for the listing

tx_cms_layout::getTable_tt_links ( $  id  ) 

Renders link records from the tt_links table from page id NOTICE: Requires the tt_links extension to be loaded.

Paramètres:
integer Page id
Renvoie:
string HTML for the listing

tx_cms_layout::getTable_tt_guest ( $  id  ) 

Renders link records from the tt_links table from page id NOTICE: Requires the tt_links extension to be loaded.

Paramètres:
integer Page id
Renvoie:
string HTML for the listing

tx_cms_layout::getTable_tt_news ( $  id  ) 

Renders news items from the tt_news table from page id NOTICE: Requires the tt_news extension to be loaded.

Paramètres:
integer Page id
Renvoie:
string HTML for the listing

tx_cms_layout::getTable_tt_calender ( $  id  ) 

Renders calender elements link records from the tt_calender table from page id NOTICE: Requires the tt_calender extension to be loaded.

Paramètres:
integer Page id
Renvoie:
string HTML for the listing

tx_cms_layout::getTable_tt_products ( $  id  ) 

Renders shopping elements from the tt_products table from page id NOTICE: Requires the tt_products extension to be loaded.

Paramètres:
integer Page id
Renvoie:
string HTML for the listing

tx_cms_layout::makeOrdinaryList ( $  table,
$  id,
$  fList,
$  icon = 0,
$  addWhere = '' 
)

Creates a standard list of elements from a table.

Paramètres:
string Table name
integer Page id.
string Comma list of fields to display
boolean If true, icon is shown
string Additional WHERE-clauses.
Renvoie:
string HTML table

tx_cms_layout::dataFields ( $  fieldArr,
$  table,
$  row,
$  out = array() 
)

Adds content to all data fields in $out array

Paramètres:
array Array of fields to display. Each field name has a special feature which is that the field name can be specified as more field names. Eg. "field1,field2;field3". Field 2 and 3 will be shown in the same cell of the table separated by
while field1 will have its own cell.
string Table name
array Record array
array Array to which the data is added
Renvoie:
array $out array returned after processing.
Voir également:
makeOrdinaryList()

tx_cms_layout::headerFields ( $  fieldArr,
$  table,
$  out = array() 
)

Header fields made for the listing of records

Paramètres:
array Field names
string The table name
array Array to which the headers are added.
Renvoie:
array $out returned after addition of the header fields.
Voir également:
makeOrdinaryList()

tx_cms_layout::pages_getTree ( $  theRows,
$  pid,
$  qWhere,
$  treeIcons,
$  depth 
)

Adds pages-rows to an array, selecting recursively in the page tree.

Paramètres:
array Array which will accumulate page rows
integer Pid to select from
string Query-where clause
string Prefixed icon code.
integer Depth (decreasing)
Renvoie:
array $theRows, but with added rows.

tx_cms_layout::pages_drawItem ( $  row,
$  fieldArr 
)

Adds a list item for the pages-rendering

Paramètres:
array Record array
array Field list
Renvoie:
string HTML for the item

tx_cms_layout::tt_content_drawColHeader ( $  colName,
$  editParams,
$  newParams 
)

Draw header for a content element column:

Paramètres:
string Column name
string Edit params (Syntax: &edit[...] for alt_doc.php)
string New element params (Syntax: &edit[...] for alt_doc.php)
Renvoie:
string HTML table

tx_cms_layout::tt_content_drawHeader ( $  row,
$  space = 0,
$  disableMoveAndNewButtons = FALSE,
$  langMode = FALSE 
)

Draw the header for a single tt_content element

Paramètres:
array Record array
integer Amount of pixel space above the header.
boolean If set the buttons for creating new elements and moving up and down are not shown.
boolean If set, we are in language mode and flags will be shown for languages
Renvoie:
string HTML table with the record header.

tx_cms_layout::tt_content_drawItem ( $  row,
$  isRTE = FALSE 
)

Draws the preview content for a content element

Paramètres:
string Content element
boolean Set if the RTE link can be created.
Renvoie:
string HTML

tx_cms_layout::getNonTranslatedTTcontentUids ( $  defLanguageCount,
$  id,
$  lP 
)

Filters out all tt_content uids which are already translated so only non-translated uids is left. Selects across columns, but within in the same PID. Columns are expect to be the same for translations and original but this may be a conceptual error (?)

Paramètres:
array Numeric array with uids of tt_content elements in the default language
integer Page pid
integer Sys language UID
Renvoie:
array Modified $defLanguageCount

tx_cms_layout::newLanguageButton ( $  defLanguageCount,
$  lP 
)

Creates button which is used to create copies of records..

Paramètres:
array Numeric array with uids of tt_content elements in the default language
integer Sys language UID
Renvoie:
string "Copy languages" button, if available.

tx_cms_layout::infoGif ( $  infoArr  ) 

Returns an icon, which has its title attribute set to a massive amount of information about the element.

Paramètres:
array Array where values are human readable output of field values (not htmlspecialchars()'ed though). The values are imploded by a linebreak.
Renvoie:
string HTML img tag if applicable.

tx_cms_layout::newContentElementOnClick ( $  id,
$  colPos,
$  sys_language 
)

Creates onclick-attribute content for a new content element

Paramètres:
integer Page id where to create the element.
integer Preset: Column position value
integer Preset: Sys langauge value
Renvoie:
string String for onclick attribute.
Voir également:
getTable_tt_content()

tx_cms_layout::linkEditContent ( $  str,
$  row 
)

Will create a link on the input string and possible a big button after the string which links to editing in the RTE Used for content element content displayed so the user can click the content / "Edit in Rich Text Editor" button

Paramètres:
string String to link. Must be prepared for HTML output.
array The row.
Renvoie:
string If the whole thing was editable ($this->doEdit) $str is return with link around. Otherwise just $str.
Voir également:
getTable_tt_content()

tx_cms_layout::linkRTEbutton ( $  row  ) 

Adds a button to edit the row in RTE wizard

Paramètres:
array The row of tt_content element
Renvoie:
string Button to click if you want to edit in RTE wizard.

tx_cms_layout::languageSelector ( $  id  ) 

Make selector box for creating new translation in a language Displays only languages which are not yet present for the current page.

Paramètres:
integer Page id for which to create a new language (pages_language_overlay record)
Renvoie:
string <select> HTML element (if there were items for the box anyways...)
Voir également:
getTable_tt_content()

tx_cms_layout::getResult ( $  result  ) 

Traverse the result pointer given, adding each record to array and setting some internal values at the same time.

Paramètres:
pointer SQL result pointer for select query.
Renvoie:
array The selected rows returned in this array.

tx_cms_layout::tt_board_getTree ( $  theRows,
$  parent,
$  pid,
$  qWhere,
$  treeIcons 
)

Traverses recursively a branch in a message board.

Paramètres:
array Array of rows (build up recursively)
integer tt_content parent uid
integer Page id
string Additional query part.
string HTML content to prefix items with (to draw the proper tree-graphics)
Renvoie:
array $theRows, but with added content

tx_cms_layout::tt_board_drawItem ( $  table,
$  row,
$  re 
)

Adds an element to the tt_board listing:

Paramètres:
string Table name
array The record row
string Reply count, if applicable.
Renvoie:
string Return content of element (table row)

tx_cms_layout::numberOfRecords ( $  table,
$  pid 
)

Counts and returns the number of records on the page with $pid

Paramètres:
string Table name
integer Page id
Renvoie:
integer Number of records.

tx_cms_layout::renderText ( $  input  ) 

Processing of larger amounts of text (usually from RTE/bodytext fields) with word wrapping etc.

Paramètres:
string Input string
Renvoie:
string Output string

tx_cms_layout::getIcon ( $  table,
$  row 
)

Creates the icon image tag for record from table and wraps it in a link which will trigger the click menu.

Paramètres:
string Table name
array Record array
string Record title (NOT USED)
Renvoie:
string HTML for the icon

tx_cms_layout::getProcessedValue ( $  table,
$  fieldList,
$  row,
&$  info 
)

Creates processed values for all fieldnames in $fieldList based on values from $row array. The result is 'returned' through $info which is passed as a reference

Paramètres:
string Table name
string Commalist of fields.
array Record from which to take values for processing.
array Array to which the processed values are added.
Renvoie:
void

tx_cms_layout::isDisabled ( $  table,
$  row 
)

Returns true, if the record given as parameters is NOT visible based on hidden/starttime/endtime (if available)

Paramètres:
string Tablename of table to test
array Record row.
Renvoie:
boolean Returns true, if disabled.

tx_cms_layout::wordWrapper ( $  content,
$  max = 50,
$  char = ' -' 
)

Will perform "word-wrapping" on the input string. What it does is to split by space or linebreak, then find any word longer than $max and if found, a hyphen is inserted. Works well on normal texts, little less well when HTML is involved (since much HTML will have long strings that will be broken).

Paramètres:
string Content to word-wrap.
integer Max number of chars in a word before it will be wrapped.
string Character to insert when wrapping.
Renvoie:
string Processed output.

tx_cms_layout::noEditIcon ( $  label = 'noEditItems'  ) 

Returns icon for "no-edit" of a record. Basically, the point is to signal that this record could have had an edit link if the circumstances were right. A placeholder for the regular edit icon...

Paramètres:
string Label key from LOCAL_LANG
Renvoie:
string IMG tag for icon.

tx_cms_layout::cleanTableNames (  ) 

Function, which fills in the internal array, $this->allowedTableNames with all tables to which the user has access. Also a set of standard tables (pages, static_template, sys_filemounts, etc...) are filtered out. So what is left is basically all tables which makes sense to list content from.

Renvoie:
void

tx_cms_layout::isRTEforField ( $  table,
$  row,
$  field 
)

Checking if the RTE is available/enabled for a certain table/field and if so, it returns true. Used to determine if the RTE button should be displayed.

Paramètres:
string Table name
array Record row (needed, if there are RTE dependencies based on other fields in the record)
string Field name
Renvoie:
boolean Returns true if the rich text editor would be enabled/available for the field name specified.

tx_cms_layout::getSpecConfForField ( $  table,
$  row,
$  field 
)

Returns "special" configuration from the "types" configuration in TCA for the record given by tablename/fieldname. Used by isRTEforField() in the process of finding whether a field has RTE enabled or not.

Paramètres:
string Table name
array Record array
string Field name
Renvoie:
array Spec. conf (if available) private
Voir également:
isRTEforField()

tx_cms_layout::getPageInfoBox ( $  rec,
$  edit = 0 
)

Creates an info-box for the current page (identified by input record).

Paramètres:
array Page record
boolean If set, there will be shown an edit icon, linking to editing of the page properties.
Renvoie:
string HTML for the box.

tx_cms_layout::getTableMenu ( $  id  ) 

Creates a menu of the tables that can be listed by this function Only tables which has records on the page will be included. Notice: The function also fills in the internal variable $this->activeTables with icon/titles.

Paramètres:
integer Page id from which we are listing records (the function will look up if there are records on the page)
Renvoie:
string HTML output.

tx_cms_layout::strip_tags ( $  content,
$  fillEmptyContent = false 
)

Enhancement for the strip_tags function that provides the feature to fill in empty tags. Example <link email@hostname.com></link> is accepted by TYPO3 but would not displayed in the Backend otherwise.

Paramètres:
string Input string
boolean If true, empty tags will be filled with the first attribute of the tag before.
Renvoie:
string Input string with all HTML and PHP tags stripped

Documentation des données membres

tx_cms_layout::$stat_select_field = 'page_id'

tx_cms_layout::$stat_codes = array()

tx_cms_layout::$pI_showUser = 0

tx_cms_layout::$pI_showStat = 1

tx_cms_layout::$nextThree = 3

tx_cms_layout::$pages_noEditColumns = 0

tx_cms_layout::$option_showBigButtons = 1

tx_cms_layout::$option_newWizard = 1

tx_cms_layout::$ext_function = 0

tx_cms_layout::$doEdit = 1

tx_cms_layout::$agePrefixes = ' min| hrs| days| yrs'

tx_cms_layout::$externalTables = array()

tx_cms_layout::$descrTable

tx_cms_layout::$defLangBinding = FALSE

tx_cms_layout::$tt_contentConfig

Valeur initiale :

 Array (
                'showInfo' => 1,                                        // Boolean: Display info-marks or not
                'showCommands' => 1,                            // Boolean: Display up/down arrows and edit icons for tt_content records
                'showCommands_info' => 1,                       // Boolean: Displays infoGif with the command buttons
                'single' => 1,                                          // Boolean: If set, the content of column(s) $this->tt_contentConfig['showSingleCol'] is shown in the total width of the page
                'showSingleCol' => 0,                           // The column(s) to show if single mode (under each other)
                'languageCols' => 0,
                'languageMode' => 0,
                'languageColsPointer' => 0,
                'showHidden' => 1,                                      // Displays hidden records as well
                'sys_language_uid' => 0,                        // Which language
                'cols' => '1,0,2,3'                                     // The order of the rows: Default is left(1), Normal(0), right(2), margin(3)
        )

tx_cms_layout::$allowedTableNames = array()

tx_cms_layout::$activeTables = array()

tx_cms_layout::$tt_contentData

Valeur initiale :

 Array(
                'nextThree' => Array(),
                'prev' => Array(),
                'next' => Array()
        )

tx_cms_layout::$CType_labels = array()

tx_cms_layout::$itemLabels = array()

La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Fri Aug 31 11:43:35 2007 pour OBLADY - Typo3 API v4.1.2 par  doxygen 1.5.3