tslib_pibase Class Reference

Inheritance diagram for tslib_pibase:

List of all members.

Public Member Functions
	tslib_pibase ()
	pi_setPiVarDefaults ()
	pi_getPageLink ($id, $target='', $urlParameters=array())
	pi_linkToPage ($str, $id, $target='', $urlParameters=array())
	pi_linkTP ($str, $urlParameters=array(), $cache=0, $altPageId=0)
	pi_linkTP_keepPIvars ($str, $overrulePIvars=array(), $cache=0, $clearAnyway=0, $altPageId=0)
	pi_linkTP_keepPIvars_url ($overrulePIvars=array(), $cache=0, $clearAnyway=0, $altPageId=0)
	pi_list_linkSingle ($str, $uid, $cache=FALSE, $mergeArr=array(), $urlOnly=FALSE, $altPageId=0)
	pi_openAtagHrefInJSwindow ($str, $winName='', $winParams='width=670, height=500, status=0, menubar=0, scrollbars=1, resizable=1')
	pi_list_browseresults ($showResultCount=1, $tableParams='', $wrapArr=array(), $pointerName='pointer', $hscText=TRUE, $forceOutput=FALSE)
	pi_list_searchBox ($tableParams='')
	pi_list_modeSelector ($items=array(), $tableParams='')
	pi_list_makelist ($res, $tableParams='')
	pi_list_row ($c)
	pi_list_header ()
	pi_getClassName ($class)
	pi_classParam ($class, $addClasses='')
	pi_wrapInBaseClass ($str)
	pi_getEditPanel ($row='', $tablename='', $label='', $conf=Array())
	pi_getEditIcon ($content, $fields, $title='', $row='', $tablename='', $oConf=array())
	pi_getLL ($key, $alt='', $hsc=FALSE)
	pi_loadLL ()
	pi_list_query ($table, $count=0, $addWhere='', $mm_cat='', $groupBy='', $orderBy='', $query='', $returnQueryArray=FALSE)
	pi_exec_query ($table, $count=0, $addWhere='', $mm_cat='', $groupBy='', $orderBy='', $query='')
	pi_getRecord ($table, $uid, $checkPage=0)
	pi_getPidList ($pid_list, $recursive=0)
	pi_prependFieldsWithTable ($table, $fieldList)
	pi_getCategoryTableContents ($table, $pid, $whereClause='', $groupBy='', $orderBy='', $limit='')
	pi_isOnlyFields ($fList, $lowerThan=-1)
	pi_autoCache ($inArray)
	pi_RTEcssText ($str)
	pi_initPIflexForm ($field='pi_flexform')
	pi_getFFvalue ($T3FlexForm_array, $fieldName, $sheet='sDEF', $lang='lDEF', $value='vDEF')
	pi_getFFvalueFromSheetArray ($sheetArray, $fieldNameArr, $value)
Public Attributes
	$cObj
	$prefixId
	$scriptRelPath
	$extKey
	$piVars
	$internal
	$LOCAL_LANG = Array()
	$LOCAL_LANG_charset = Array()
	$LOCAL_LANG_loaded = 0
	$LLkey = 'default'
	$altLLkey = ''
	$LLtestPrefix = ''
	$LLtestPrefixAlt = ''
	$pi_isOnlyFields = 'mode,pointer'
	$pi_alwaysPrev = 0
	$pi_lowerThan = 5
	$pi_moreParams = ''
	$pi_listFields = '*'
	$pi_autoCacheFields = array()
	$pi_autoCacheEn = 0
	$pi_USER_INT_obj = FALSE
	$pi_checkCHash = FALSE
	$conf = Array()
	$pi_EPtemp_cObj
	$pi_tmpPageId = 0

---

Detailed Description

Definition at line 121 of file class.tslib_pibase.php.

---

Member Function Documentation

tslib_pibase::pi_autoCache

(

$

inArray

)

Returns true if the array $inArray contains only values allowed to be cached based on the configuration in $this->pi_autoCacheFields Used by ->pi_linkTP_keepPIvars This is an advanced form of evaluation of whether a URL should be cached or not.

Parameters:

array

An array with piVars values to evaluate

Returns:

boolean Returns true (1) if conditions are met.

See also:

pi_linkTP_keepPIvars()

Definition at line 1335 of file class.tslib_pibase.php.

Referenced by pi_linkTP_keepPIvars().

tslib_pibase::pi_classParam	(	$	class,
		$	addClasses = ''
	)

Returns the class-attribute with the correctly prefixed classname Using pi_getClassName()

Parameters:

string	The class name(s) (suffix) - separate multiple classes with commas
string	Additional class names which should not be prefixed - separate multiple classes with commas

Returns:

string A "class" attribute with value and a single space char before it.

See also:

pi_getClassName()

Definition at line 774 of file class.tslib_pibase.php.

tslib_pibase::pi_exec_query	(	$	table,
		$	count = 0,
		$	addWhere = '',
		$	mm_cat = '',
		$	groupBy = '',
		$	orderBy = '',
		$	query = ''
	)

Executes a standard SELECT query for listing of records based on standard input vars from the 'browser' ($this->internal['results_at_a_time'] and $this->piVars['pointer']) and 'searchbox' ($this->piVars['sword'] and $this->internal['searchFieldList']) Set $count to 1 if you wish to get a count(*) query for selecting the number of results. Notice that the query will use $this->conf['pidList'] and $this->conf['recursive'] to generate a PID list within which to search for records.

Parameters:

string	The table name to make the query for.
boolean	If set, you will get a "count(*)" query back instead of field selecting
string	Additional WHERE clauses (should be starting with " AND ....")
mixed	If an array, then it must contain the keys "table", "mmtable" and (optionally) "catUidList" defining a table to make a MM-relation to in the query (based on fields uid_local and uid_foreign). If not array, the query will be a plain query looking up data in only one table.
string	If set, this is added as a " GROUP BY ...." part of the query.
string	If set, this is added as a " ORDER BY ...." part of the query. The default is that an ORDER BY clause is made based on $this->internal['orderBy'] and $this->internal['descFlag'] where the orderBy field must be found in $this->internal['orderByList']
string	If set, this is taken as the first part of the query instead of what is created internally. Basically this should be a query starting with "FROM [table] WHERE ... AND ...". The $addWhere clauses and all the other stuff is still added. Only the tables and PID selecting clauses are bypassed. May be deprecated in the future!

Returns:

pointer SQL result pointer

Definition at line 1131 of file class.tslib_pibase.php.

tslib_pibase::pi_getCategoryTableContents	(	$	table,
		$	pid,
		$	whereClause = '',
		$	groupBy = '',
		$	orderBy = '',
		$	limit = ''
	)

Will select all records from the "category table", $table, and return them in an array.

Parameters:

string	The name of the category table to select from.
integer	The page from where to select the category records.
string	Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
string	Optional GROUP BY field(s), if none, supply blank string.
string	Optional ORDER BY field(s), if none, supply blank string.
string	Optional LIMIT value ([begin,]max), if none, supply blank string.

Returns:

array The array with the category records in.

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

tslib_pibase::pi_getClassName

(

$

class

)

Returns a class-name prefixed with $this->prefixId and with all underscores substituted to dashes (-)

Parameters:

string

The class name (or the END of it since it will be prefixed by $this->prefixId.'-')

Returns:

string The combined class name (with the correct prefix)

Definition at line 761 of file class.tslib_pibase.php.

tslib_pibase::pi_getEditIcon	(	$	content,
		$	fields,
		$	title = '',
		$	row = '',
		$	tablename = '',
		$	oConf = array()
	)

Adds edit-icons to the input content. tslib_cObj::editIcons used for rendering

Parameters:

string	HTML content to add icons to. The icons will be put right after the last content part in the string (that means before the ending series of HTML tags)
string	The list of fields to edit when the icon is clicked.
string	Title for the edit icon.
array	Table record row
string	Table name
array	Conf array

Returns:

string The processed content

See also:

tslib_cObj::editIcons()

Definition at line 890 of file class.tslib_pibase.php.

tslib_pibase::pi_getEditPanel	(	$	row = '',
		$	tablename = '',
		$	label = '',
		$	conf = Array()
	)

Returns the Backend User edit panel for the $row from $tablename

Parameters:

array	Record array.
string	Table name
string	A label to show with the panel.
array	TypoScript parameters to pass along to the EDITPANEL content Object that gets rendered. The property "allow" WILL get overridden/set though.

Returns:

string Returns false/blank if no BE User login and of course if the panel is not shown for other reasons. Otherwise the HTML for the panel (a table).

See also:

tslib_cObj::EDITPANEL()

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

tslib_pibase::pi_getFFvalue	(	$	T3FlexForm_array,
		$	fieldName,
		$	sheet = 'sDEF',
		$	lang = 'lDEF',
		$	value = 'vDEF'
	)

Return value from somewhere inside a FlexForm structure

Parameters:

array	FlexForm data
string	Field name to extract. Can be given like "test/el/2/test/el/field_templateObject" where each part will dig a level deeper in the FlexForm data.
string	Sheet pointer, eg. "sDEF"
string	Language pointer, eg. "lDEF"
string	Value pointer, eg. "vDEF"

Returns:

string The content.

Definition at line 1405 of file class.tslib_pibase.php.

Referenced by tx_felogin_pi1\flexFormValue(), and tx_cssstyledcontent_pi1\render_table().

tslib_pibase::pi_getFFvalueFromSheetArray	(	$	sheetArray,
		$	fieldNameArr,
		$	value
	)

Returns part of $sheetArray pointed to by the keys in $fieldNameArray

Parameters:

array	Multidimensiona array, typically FlexForm contents
array	Array where each value points to a key in the FlexForms content - the input array will have the value returned pointed to by these keys. All integer keys will not take their integer counterparts, but rather traverse the current position in the array an return element number X (whether this is right behavior is not settled yet...)
string	Value for outermost key, typ. "vDEF" depending on language.

Returns:

mixed The value, typ. string. private

See also:

pi_getFFvalue()

Definition at line 1422 of file class.tslib_pibase.php.

tslib_pibase::pi_getLL	(	$	key,
		$	alt = '',
		$	hsc = FALSE
	)

Returns the localized label of the LOCAL_LANG key, $key Notice that for debugging purposes prefixes for the output values can be set with the internal vars ->LLtestPrefixAlt and ->LLtestPrefix

Parameters:

string	The key from the LOCAL_LANG array for which to return the value.
string	Alternative string to return IF no value is found set for the key, neither for the local language nor the default.
boolean	If true, the output label is passed through htmlspecialchars()

Returns:

string The value from LOCAL_LANG.

Definition at line 937 of file class.tslib_pibase.php.

Referenced by tx_felogin_pi1\changePassword(), tx_indexedsearch\compileResult(), tx_indexedsearch\doSearch(), tx_felogin_pi1\generateAndSendHash(), tx_indexedsearch\getDisplayResults(), tx_felogin_pi1\getDisplayText(), tx_indexedsearch\initialize(), tx_felogin_pi1\main(), tx_indexedsearch\makeSearchForm(), tx_indexedsearch\makeSectionHeader(), tx_indexedsearch\pi_list_browseresults(), tx_indexedsearch\printResultRow(), tx_indexedsearch\printResultSectionLinks(), tx_indexedsearch\printRules(), tx_felogin_pi1\showForgot(), tx_felogin_pi1\showLogin(), tx_felogin_pi1\showLogout(), tx_indexedsearch\tellUsWhatIsSeachedFor(), and tx_felogin_pi1\validateRedirectUrl().

tslib_pibase::pi_getPageLink	(	$	id,
		$	target = '',
		$	urlParameters = array()
	)

Get URL to some page. Returns the URL to page $id with $target and an array of additional url-parameters, $urlParameters Simple example: $this->pi_getPageLink(123) to get the URL for page-id 123.

The function basically calls $this->cObj->getTypoLink_URL()

Parameters:

integer	Page id
string	Target value to use. Affects the &type-value of the URL, defaults to current.
array	Additional URL parameters to set (key/value pairs)

Returns:

string The resulting URL

See also:

pi_linkToPage()

Definition at line 271 of file class.tslib_pibase.php.

Referenced by tx_felogin_pi1\changePassword(), tx_felogin_pi1\generateAndSendHash(), tx_indexedsearch\getSearchFormActionURL(), tx_indexedsearch\makeSearchForm(), and tx_felogin_pi1\processRedirect().

tslib_pibase::pi_getPidList	(	$	pid_list,
		$	recursive = 0
	)

Returns a commalist of page ids for a query (eg. 'WHERE pid IN (...)')

Parameters:

string	$pid_list	is a comma list of page ids (if empty current page is used)
integer	$recursive	is an integer >=0 telling how deep to dig for pids under each entry in $pid_list

Returns:

string List of PID values (comma separated)

Definition at line 1221 of file class.tslib_pibase.php.

Referenced by tx_felogin_pi1\main(), and tx_felogin_pi1\mergeflexFormValuesIntoConf().

tslib_pibase::pi_getRecord	(	$	table,
		$	uid,
		$	checkPage = 0
	)

Returns the row $uid from $table (Simply calling $GLOBALS['TSFE']->sys_page->checkRecord())

Parameters:

string	The table name
integer	The uid of the record from the table
boolean	If $checkPage is set, it's required that the page on which the record resides is accessible

Returns:

array If record is found, an array. Otherwise false.

Definition at line 1210 of file class.tslib_pibase.php.

Referenced by tx_felogin_pi1\changePassword().

tslib_pibase::pi_initPIflexForm

(

$

field = 'pi_flexform'

)

Converts $this->cObj->data['pi_flexform'] from XML string to flexForm array.

Parameters:

string

Field name to convert

Returns:

void

Definition at line 1387 of file class.tslib_pibase.php.

Referenced by tx_felogin_pi1\main(), and tx_cssstyledcontent_pi1\render_table().

tslib_pibase::pi_isOnlyFields	(	$	fList,
		$	lowerThan = -1
	)

Returns true if the piVars array has ONLY those fields entered that is set in the $fList (commalist) AND if none of those fields value is greater than $lowerThan field if they are integers. Notice that this function will only work as long as values are integers.

Parameters:

string	List of fields (keys from piVars) to evaluate on
integer	Limit for the values.

Returns:

boolean Returns true (1) if conditions are met.

Definition at line 1315 of file class.tslib_pibase.php.

tslib_pibase::pi_linkToPage	(	$	str,
		$	id,
		$	target = '',
		$	urlParameters = array()
	)

Link a string to some page. Like pi_getPageLink() but takes a string as first parameter which will in turn be wrapped with the URL including target attribute Simple example: $this->pi_linkToPage('My link', 123) to get something like My link (or My link if simulateStaticDocuments is set)

Parameters:

string	The content string to wrap in tags
integer	Page id
string	Target value to use. Affects the &type-value of the URL, defaults to current.
array	Additional URL parameters to set (key/value pairs)

Returns:

string The input string wrapped in tags with the URL and target set.

See also:

pi_getPageLink(), tslib_cObj::getTypoLink()

Definition at line 287 of file class.tslib_pibase.php.

tslib_pibase::pi_linkTP	(	$	str,
		$	urlParameters = array(),
		$	cache = 0,
		$	altPageId = 0
	)

Link string to the current page. Returns the $str wrapped in -tags with a link to the CURRENT page, but with $urlParameters set as extra parameters for the page.

Parameters:

string	The content string to wrap in tags
array	Array with URL parameters as key/value pairs. They will be "imploded" and added to the list of parameters defined in the plugins TypoScript property "parent.addParams" plus $this->pi_moreParams.
boolean	If $cache is set (0/1), the page is asked to be cached by a &cHash value (unless the current plugin using this class is a USER_INT). Otherwise the no_cache-parameter will be a part of the link.
integer	Alternative page ID for the link. (By default this function links to the SAME page!)

Returns:

string The input string wrapped in tags

See also:

pi_linkTP_keepPIvars(), tslib_cObj::typoLink()

Definition at line 302 of file class.tslib_pibase.php.

References $conf, and $GLOBALS.

Referenced by pi_linkTP_keepPIvars(), and pi_list_linkSingle().

tslib_pibase::pi_linkTP_keepPIvars	(	$	str,
		$	overrulePIvars = array(),
		$	cache = 0,
		$	clearAnyway = 0,
		$	altPageId = 0
	)

Link a string to the current page while keeping currently set values in piVars. Like pi_linkTP, but $urlParameters is by default set to $this->piVars with $overrulePIvars overlaid. This means any current entries from this->piVars are passed on (except the key "DATA" which will be unset before!) and entries in $overrulePIvars will OVERRULE the current in the link.

Parameters:

string	The content string to wrap in tags
array	Array of values to override in the current piVars. Contrary to pi_linkTP the keys in this array must correspond to the real piVars array and therefore NOT be prefixed with the $this->prefixId string. Further, if a value is a blank string it means the piVar key will not be a part of the link (unset)
boolean	If $cache is set, the page is asked to be cached by a &cHash value (unless the current plugin using this class is a USER_INT). Otherwise the no_cache-parameter will be a part of the link.
boolean	If set, then the current values of piVars will NOT be preserved anyways... Practical if you want an easy way to set piVars without having to worry about the prefix, "tx_xxxxx[]"
integer	Alternative page ID for the link. (By default this function links to the SAME page!)

Returns:

string The input string wrapped in tags

See also:

pi_linkTP()

Definition at line 325 of file class.tslib_pibase.php.

References $piVars, $res, t3lib_div\array_merge_recursive_overrule(), pi_autoCache(), and pi_linkTP().

Referenced by pi_linkTP_keepPIvars_url(), and pi_list_linkSingle().

tslib_pibase::pi_linkTP_keepPIvars_url	(	$	overrulePIvars = array(),
		$	cache = 0,
		$	clearAnyway = 0,
		$	altPageId = 0
	)

Get URL to the current page while keeping currently set values in piVars. Same as pi_linkTP_keepPIvars but returns only the URL from the link.

Parameters:

array	See pi_linkTP_keepPIvars
boolean	See pi_linkTP_keepPIvars
boolean	See pi_linkTP_keepPIvars
integer	See pi_linkTP_keepPIvars

Returns:

string The URL ($this->cObj->lastTypoLinkUrl)

See also:

pi_linkTP_keepPIvars()

Definition at line 349 of file class.tslib_pibase.php.

References pi_linkTP_keepPIvars().

tslib_pibase::pi_list_browseresults	(	$	showResultCount = 1,
		$	tableParams = '',
		$	wrapArr = array(),
		$	pointerName = 'pointer',
		$	hscText = TRUE,
		$	forceOutput = FALSE
	)

Returns a results browser. This means a bar of page numbers plus a "previous" and "next" link. For each entry in the bar the piVars "pointer" will be pointing to the "result page" to show. Using $this->piVars['pointer'] as pointer to the page to display. Can be overwritten with another string ($pointerName) to make it possible to have more than one pagebrowser on a page) Using $this->internal['res_count'], $this->internal['results_at_a_time'] and $this->internal['maxPages'] for count number, how many results to show and the max number of pages to include in the browse bar. Using $this->internal['dontLinkActivePage'] as switch if the active (current) page should be displayed as pure text or as a link to itself Using $this->internal['showFirstLast'] as switch if the two links named "<< First" and "LAST >>" will be shown and point to the first or last page. Using $this->internal['pagefloat']: this defines were the current page is shown in the list of pages in the Pagebrowser. If this var is an integer it will be interpreted as position in the list of pages. If its value is the keyword "center" the current page will be shown in the middle of the pagelist. Using $this->internal['showRange']: this var switches the display of the pagelinks from pagenumbers to ranges f.e.: 1-5 6-10 11-15... instead of 1 2 3... Using $this->pi_isOnlyFields: this holds a comma-separated list of fieldnames which - if they are among the GETvars - will not disable caching for the page with pagebrowser.

The third parameter is an array with several wraps for the parts of the pagebrowser. The following elements will be recognized: disabledLinkWrap, inactiveLinkWrap, activeLinkWrap, browseLinksWrap, showResultsWrap, showResultsNumbersWrap, browseBoxWrap.

If $wrapArr['showResultsNumbersWrap'] is set, the formatting string is expected to hold template markers (###FROM###, ###TO###, ###OUT_OF###, ###FROM_TO###, ###CURRENT_PAGE###, ###TOTAL_PAGES###) otherwise the formatting string is expected to hold sprintf-markers (s) for from, to, outof (in that sequence)

Parameters:

integer	determines how the results of the pagerowser will be shown. See description below
string	Attributes for the table tag which is wrapped around the table cells containing the browse links
array	Array with elements to overwrite the default $wrapper-array.
string	varname for the pointer.
boolean	enable htmlspecialchars() for the pi_getLL function (set this to FALSE if you want f.e use images instead of text for links like 'previous' and 'next').
boolean	forces the output of the page browser if you set this option to "true" (otherwise it's only drawn if enough entries are available)

Returns:

string Output HTML-Table, wrapped in

-tags with a class attribute (if $wrapArr is not passed,

Definition at line 449 of file class.tslib_pibase.php.

tslib_pibase::pi_list_header

(

)

Returns a list header row. (Dummy) Notice: This function should ALWAYS be defined in the extension class of the plugin since it is directly concerned with the specific layout of the listing for your plugins purpose.

Returns:

string HTML output, a table row with a class attribute set

Definition at line 730 of file class.tslib_pibase.php.

tslib_pibase::pi_list_linkSingle	(	$	str,
		$	uid,
		$	cache = FALSE,
		$	mergeArr = array(),
		$	urlOnly = FALSE,
		$	altPageId = 0
	)

Wraps the $str in a link to a single display of the record (using piVars[showUid]) Uses pi_linkTP for the linking

Parameters:

string	The content string to wrap in tags
integer	UID of the record for which to display details (basically this will become the value of [showUid]
boolean	See pi_linkTP_keepPIvars
array	Array of values to override in the current piVars. Same as $overrulePIvars in pi_linkTP_keepPIvars
boolean	If true, only the URL is returned, not a full link
integer	Alternative page ID for the link. (By default this function links to the SAME page!)

Returns:

string The input string wrapped in tags

See also:

pi_linkTP(), pi_linkTP_keepPIvars()

Definition at line 367 of file class.tslib_pibase.php.

References pi_linkTP(), and pi_linkTP_keepPIvars().

tslib_pibase::pi_list_makelist	(	$	res,
		$	tableParams = ''
	)

Returns the list of items based on the input SQL result pointer For each result row the internal var, $this->internal['currentRow'], is set with the row returned. $this->pi_list_header() makes the header row for the list $this->pi_list_row() is used for rendering each row Notice that these two functions are typically ALWAYS defined in the extension class of the plugin since they are directly concerned with the specific layout for that plugins purpose.

Parameters:

pointer	Result pointer to a SQL result which can be traversed.
string	Attributes for the table tag which is wrapped around the table rows containing the list

Returns:

string Output HTML, wrapped in

-tags with a class attribute

See also:

pi_list_row(), pi_list_header()

Definition at line 683 of file class.tslib_pibase.php.

tslib_pibase::pi_list_modeSelector	(	$	items = array(),
		$	tableParams = ''
	)

Returns a mode selector; a little menu in a table normally put in the top of the page/list.

Parameters:

array	Key/Value pairs for the menu; keys are the piVars[mode] values and the "values" are the labels for them.
string	Attributes for the table tag which is wrapped around the table cells containing the menu

Returns:

string Output HTML, wrapped in

-tags with a class attribute

Definition at line 646 of file class.tslib_pibase.php.

tslib_pibase::pi_list_query	(	$	table,
		$	count = 0,
		$	addWhere = '',
		$	mm_cat = '',
		$	groupBy = '',
		$	orderBy = '',
		$	query = '',
		$	returnQueryArray = FALSE
	)

Makes a standard query for listing of records based on standard input vars from the 'browser' ($this->internal['results_at_a_time'] and $this->piVars['pointer']) and 'searchbox' ($this->piVars['sword'] and $this->internal['searchFieldList']) Set $count to 1 if you wish to get a count(*) query for selecting the number of results. Notice that the query will use $this->conf['pidList'] and $this->conf['recursive'] to generate a PID list within which to search for records.

Parameters:

string	See pi_exec_query()
boolean	See pi_exec_query()
string	See pi_exec_query()
mixed	See pi_exec_query()
string	See pi_exec_query()
string	See pi_exec_query()
string	See pi_exec_query()
boolean	If set, the function will return the query not as a string but array with the various parts.

Returns:

mixed The query build. private

Deprecated:

since TYPO3 3.6, this function will be removed in TYPO3 4.5, use pi_exec_query() instead!

Todo:

Deprecated but still used in the Core!

Definition at line 1038 of file class.tslib_pibase.php.

tslib_pibase::pi_list_row

(

$

c

)

Returns a list row. Get data from $this->internal['currentRow']; (Dummy) Notice: This function should ALWAYS be defined in the extension class of the plugin since it is directly concerned with the specific layout of the listing for your plugins purpose.

Parameters:

integer

Row counting. Starts at 0 (zero). Used for alternating class values in the output rows.

Returns:

string HTML output, a table row with a class attribute set (alternative based on odd/even rows)

Definition at line 718 of file class.tslib_pibase.php.

tslib_pibase::pi_list_searchBox

(

$

tableParams = ''

)

Returns a Search box, sending search words to piVars "sword" and setting the "no_cache" parameter as well in the form. Submits the search request to the current REQUEST_URI

Parameters:

string

Attributes for the table tag which is wrapped around the table cells containing the search box

Returns:

string Output HTML, wrapped in

-tags with a class attribute

Definition at line 615 of file class.tslib_pibase.php.

tslib_pibase::pi_loadLL

(

)

Loads local-language values by looking for a "locallang.php" file in the plugin class directory ($this->scriptRelPath) and if found includes it. Also locallang values set in the TypoScript property "_LOCAL_LANG" are merged onto the values found in the "locallang.php" file.

Returns:

void

Definition at line 961 of file class.tslib_pibase.php.

Referenced by tx_felogin_pi1\main(), and tx_indexedsearch\main().

tslib_pibase::pi_openAtagHrefInJSwindow	(	$	str,
		$	winName = '',
		$	winParams = 'width=670,
		height	= 500,
		status	= 0,
		menubar	= 0,
		scrollbars	= 1,
		resizable	= 1'
	)

Will change the href value from in the input string and turn it into an onclick event that will open a new window with the URL

Parameters:

string	The string to process. This should be a string already wrapped/including a tag which will be modified to contain an onclick handler. Only the attributes "href" and "onclick" will be left.
string	Window name for the pop-up window
string	Window parameters, see the default list for inspiration

Returns:

string The processed input string, modified IF a tag was found

Definition at line 395 of file class.tslib_pibase.php.

References $GLOBALS, and t3lib_div\get_tag_attributes().

tslib_pibase::pi_prependFieldsWithTable	(	$	table,
		$	fieldList
	)

Having a comma list of fields ($fieldList) this is prepended with the $table.'.' name

Parameters:

string	Table name to prepend
string	List of fields where each element will be prepended with the table name given.

Returns:

string List of fields processed.

Definition at line 1251 of file class.tslib_pibase.php.

tslib_pibase::pi_RTEcssText

(

$

str

)

Will process the input string with the parseFunc function from tslib_cObj based on configuration set in "lib.parseFunc_RTE" in the current TypoScript template. This is useful for rendering of content in RTE fields where the transformation mode is set to "ts_css" or so. Notice that this requires the use of "css_styled_content" to work right.

Parameters:

string

The input text string to process

Returns:

string The processed string

See also:

tslib_cObj::parseFunc()

Definition at line 1365 of file class.tslib_pibase.php.

tslib_pibase::pi_setPiVarDefaults

(

)

If internal TypoScript property "_DEFAULT_PI_VARS." is set then it will merge the current $this->piVars array onto these default values.

Returns:

void

Definition at line 234 of file class.tslib_pibase.php.

References t3lib_div\array_merge_recursive_overrule().

Referenced by tx_felogin_pi1\main(), and tx_indexedsearch\main().

tslib_pibase::pi_wrapInBaseClass

(

$

str

)

Wraps the input string in a

tag with the class attribute set to the prefixId. All content returned from your plugins should be returned through this function so all content from your plugin is encapsulated in a

-tag nicely identifying the content of your plugin.

Parameters:

string

HTML content to wrap in the div-tags with the "main class" of the plugin

Returns:

string HTML content wrapped, ready to return to the parent object.

Definition at line 792 of file class.tslib_pibase.php.

Referenced by tx_felogin_pi1\main(), and tx_indexedsearch\main().

tslib_pibase::tslib_pibase

(

)

Class Constructor (true constructor) Initializes $this->piVars if $this->prefixId is set to any value Will also set $this->LLkey based on the config.language setting.

Returns:

void

Definition at line 208 of file class.tslib_pibase.php.

References $GLOBALS, and t3lib_div\_GPmerged().

---

Member Data Documentation

tslib_pibase::$altLLkey = ''

Definition at line 151 of file class.tslib_pibase.php.

tslib_pibase::$cObj

Reimplemented in tx_rtehtmlarea_pi3.

Definition at line 129 of file class.tslib_pibase.php.

tslib_pibase::$conf = Array()

Should normally be set in the main function with the TypoScript content passed to the method.

$conf[LOCAL_LANG][key] is reserved for Local Language overrides. $conf[userFunc] / $conf[includeLibs] reserved for setting up the USER / USER_INT object. See TSref

Reimplemented in tx_cssstyledcontent_pi1, and tx_rtehtmlarea_pi3.

Definition at line 173 of file class.tslib_pibase.php.

Referenced by tx_felogin_pi1\main(), tx_indexedsearch\main(), and pi_linkTP().

tslib_pibase::$extKey

Reimplemented in tx_indexedsearch, tx_cssstyledcontent_pi1, tx_rtehtmlarea_pi3, and tx_felogin_pi1.

Definition at line 132 of file class.tslib_pibase.php.

tslib_pibase::$internal

Initial value:

 Array( 
        'res_count' => 0,       
        'results_at_a_time' => 20,  
        'maxPages' => 10,       
        'currentRow' => Array(),    
        'currentTable' => '',       
    )

Definition at line 139 of file class.tslib_pibase.php.

tslib_pibase::$LLkey = 'default'

Definition at line 150 of file class.tslib_pibase.php.

tslib_pibase::$LLtestPrefix = ''

Definition at line 152 of file class.tslib_pibase.php.

tslib_pibase::$LLtestPrefixAlt = ''

Definition at line 153 of file class.tslib_pibase.php.

tslib_pibase::$LOCAL_LANG = Array()

Definition at line 147 of file class.tslib_pibase.php.

tslib_pibase::$LOCAL_LANG_charset = Array()

Definition at line 148 of file class.tslib_pibase.php.

tslib_pibase::$LOCAL_LANG_loaded = 0

Definition at line 149 of file class.tslib_pibase.php.

tslib_pibase::$pi_alwaysPrev = 0

Definition at line 156 of file class.tslib_pibase.php.

tslib_pibase::$pi_autoCacheEn = 0

Definition at line 162 of file class.tslib_pibase.php.

tslib_pibase::$pi_autoCacheFields = array()

Definition at line 161 of file class.tslib_pibase.php.

tslib_pibase::$pi_checkCHash = FALSE

Reimplemented in tx_felogin_pi1.

Definition at line 165 of file class.tslib_pibase.php.

tslib_pibase::$pi_EPtemp_cObj

Definition at line 176 of file class.tslib_pibase.php.

tslib_pibase::$pi_isOnlyFields = 'mode,pointer'

Definition at line 155 of file class.tslib_pibase.php.

tslib_pibase::$pi_listFields = '*'

Definition at line 159 of file class.tslib_pibase.php.

tslib_pibase::$pi_lowerThan = 5

Definition at line 157 of file class.tslib_pibase.php.

tslib_pibase::$pi_moreParams = ''

Definition at line 158 of file class.tslib_pibase.php.

tslib_pibase::$pi_tmpPageId = 0

Definition at line 177 of file class.tslib_pibase.php.

tslib_pibase::$pi_USER_INT_obj = FALSE

Reimplemented in tx_felogin_pi1.

Definition at line 164 of file class.tslib_pibase.php.

tslib_pibase::$piVars

Initial value:

 Array (    
        'pointer' => '',        
        'mode' => '',           
        'sword' => '',          
        'sort' => '',           
    )

Definition at line 133 of file class.tslib_pibase.php.

Referenced by tx_felogin_pi1\getPageLink(), and pi_linkTP_keepPIvars().

tslib_pibase::$prefixId

Reimplemented in tx_indexedsearch, tx_cssstyledcontent_pi1, tx_rtehtmlarea_pi3, and tx_felogin_pi1.

Definition at line 130 of file class.tslib_pibase.php.

tslib_pibase::$scriptRelPath

Reimplemented in tx_indexedsearch, tx_cssstyledcontent_pi1, tx_rtehtmlarea_pi3, and tx_felogin_pi1.

Definition at line 131 of file class.tslib_pibase.php.

---

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

• typo3/sysext/cms/tslib/class.tslib_pibase.php