Solutions Open Source

Référence de la classe localRecordList

Graphe d'héritage de localRecordList:

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

Collaboration graph
[légende]

Liste de tous les membres

Fonctions membres publiques

 writeTop ($row)
 getTable ($table, $id, $rowlist)
 renderListRow ($table, $row, $cc, $titleCol, $thumbsCol, $indent=0)
 renderListHeader ($table, $currentIdList)
 makeControl ($table, $row)
 makeClip ($table, $row)
 makeRef ($table, $uid)
 makeLocalizationPanel ($table, $row)
 fieldSelectBox ($table, $formFields=1)
 linkClipboardHeaderIcon ($string, $table, $cmd, $warning='')
 clipNumPane ()
 addSortLink ($code, $field, $table)
 recPath ($pid)
 showNewRecLink ($table)
 makeReturnUrl ()
 initCSV ()
 addToCSV ($row, $table)
 setCsvRow ($csvRow)
 outputCSV ($prefix)

Attributs publics

 $alternateBgColors = FALSE
 $allowedNewTables = array()
 $newWizards = FALSE
 $dontShowClipControlPanels = FALSE
 $showClipboard = FALSE
 $noControlPanels = FALSE
 $clickMenuEnabled = TRUE
 $pageRow = array()
 $csvLines = array()
 $csvOutput = FALSE
 $clipObj
 $CBnames = array()
 $duplicateStack = array()

Documentation des fonctions membres

localRecordList::writeTop ( $  row  ) 

Writes the top of the full listing

Paramètres:
array Current page record
Renvoie:
void (Adds content to internal variable, $this->HTMLcode)

localRecordList::getTable ( $  table,
$  id,
$  rowlist 
)

Creates the listing of records from a single table

Paramètres:
string Table name
integer Page id
string List of fields to show in the listing. Pseudo fields will be added including the record header.
Renvoie:
string HTML table with the listing for the record.

localRecordList::renderListRow ( $  table,
$  row,
$  cc,
$  titleCol,
$  thumbsCol,
$  indent = 0 
)

Rendering a single row for the list

Paramètres:
string Table name
array Current record
integer Counter, counting for each time an element is rendered (used for alternating colors)
string Table field (column) where header value is found
string Table field (column) where (possible) thumbnails can be found
integer Indent from left.
Renvoie:
string Table row for the element private
Voir également:
getTable()

localRecordList::renderListHeader ( $  table,
$  currentIdList 
)

Rendering the header row for a table

Paramètres:
string Table name
array Array of the currectly displayed uids of the table
Renvoie:
string Header table row private
Voir également:
getTable()

localRecordList::makeControl ( $  table,
$  row 
)

Creates the control panel for a single record in the listing.

Paramètres:
string The table
array The record for which to make the control panel.
Renvoie:
string HTML table with the control panel (unless disabled)

localRecordList::makeClip ( $  table,
$  row 
)

Creates the clipboard panel for a single record in the listing.

Paramètres:
string The table
array The record for which to make the clipboard panel.
Renvoie:
string HTML table with the clipboard panel (unless disabled)

localRecordList::makeRef ( $  table,
$  uid 
)

Make reference count

Paramètres:
string Table name
integer UID of record
Renvoie:
string HTML-table

localRecordList::makeLocalizationPanel ( $  table,
$  row 
)

Creates the localization panel

Paramètres:
string The table
array The record for which to make the localization panel.
Renvoie:
array Array with key 0/1 with content for column 1 and 2

localRecordList::fieldSelectBox ( $  table,
$  formFields = 1 
)

Create the selector box for selecting fields to display from a table:

Paramètres:
string Table name
boolean If true, form-fields will be wrapped around the table.
Renvoie:
string HTML table with the selector box (name: displayFields['.$table.'][])

localRecordList::linkClipboardHeaderIcon ( $  string,
$  table,
$  cmd,
$  warning = '' 
)

Creates a link around $string. The link contains an onclick action which submits the script with some clipboard action. Currently, this is used for setting elements / delete elements.

Paramètres:
string The HTML content to link (image/text)
string Table name
string Clipboard command (eg. "setCB" or "delete")
string Warning text, if any ("delete" uses this for confirmation)
Renvoie:
string tag wrapped link.

localRecordList::clipNumPane (  ) 

Returns true if a numeric clipboard pad is selected/active

Renvoie:
boolean

localRecordList::addSortLink ( $  code,
$  field,
$  table 
)

Creates a sort-by link on the input string ($code). It will automatically detect if sorting should be ascending or descending depending on $this->sortRev. Also some fields will not be possible to sort (including if single-table-view is disabled).

Paramètres:
string The string to link (text)
string The fieldname represented by the title ($code)
string Table name
Renvoie:
string Linked $code variable

localRecordList::recPath ( $  pid  ) 

Returns the path for a certain pid The result is cached internally for the session, thus you can call this function as much as you like without performance problems.

Paramètres:
integer The page id for which to get the path
Renvoie:
string The path.

localRecordList::showNewRecLink ( $  table  ) 

Returns true if a link for creating new records should be displayed for $table

Paramètres:
string Table name
Renvoie:
boolean

localRecordList::makeReturnUrl (  ) 

Creates the "&returnUrl" parameter for links - this is used when the script links to other scripts and passes its own URL with the link so other scripts can return to the listing again. Uses REQUEST_URI as value.

Renvoie:
string

localRecordList::initCSV (  ) 

Initializes internal csvLines array with the header of field names

Renvoie:
void

localRecordList::addToCSV ( $  row,
$  table 
)

Adds the content of input array $row to the CSV list:

Paramètres:
array Record array, from which the values of fields found in $this->fieldArray will be listed in the CSV output.
string Table name
Renvoie:
void

localRecordList::setCsvRow ( $  csvRow  ) 

Adds input row of values to the internal csvLines array as a CSV formatted line

Paramètres:
array Array with values to be listed.
Renvoie:
void

localRecordList::outputCSV ( $  prefix  ) 

Compiles the internal csvLines array to a csv-string and outputs it to the browser. This function exits!

Paramètres:
string Filename prefix:
Renvoie:
void EXITS php execusion!

Documentation des données membres

localRecordList::$alternateBgColors = FALSE

localRecordList::$allowedNewTables = array()

localRecordList::$newWizards = FALSE

localRecordList::$dontShowClipControlPanels = FALSE

localRecordList::$showClipboard = FALSE

localRecordList::$noControlPanels = FALSE

localRecordList::$clickMenuEnabled = TRUE

localRecordList::$pageRow = array()

localRecordList::$csvLines = array()

localRecordList::$csvOutput = FALSE

Réimplémentée à partir de recordList.

localRecordList::$clipObj

localRecordList::$CBnames = array()

localRecordList::$duplicateStack = array()

Réimplémentée à partir de recordList.

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