"TYPO3 4.0.1: user_wapversion Class Reference", "datetime" => "Sat Dec 2 19:27:30 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

user_wapversion Class Reference

List of all members.

Public Member Functions

 main_wapversion ($content, $conf)
 contentAbstract ()
 contentAll ($chunkLgd=850)
 cHeader ($str)
 cBodytext ($str, $start=0, $max=0)
 nl2br ($str)
 getContentResult ($table)
 bold ($str)
 paragraph ($str)
 line ($str)
 navLink ($str, $pointer)
 menuCurrentLevel ($indent)
 link ($str, $id, $deck='')
 cleanMenuArray ($menu)

Public Attributes

 $cObj
 $idx = 0

Detailed Description

Definition at line 129 of file wapversionLib.inc.

Member Function Documentation

user_wapversion::bold (  $  str  ) 
 

Simulates bold type - basically setting it in uppercase

Parameters:
string The string for format in "bold" (uppercase)
Returns:
string Processed output.

Definition at line 329 of file wapversionLib.inc.

Referenced by cHeader(), and contentAbstract().

user_wapversion::cBodytext (  $  str,
$  start = 0,
$  max = 0
) 
 

Formats the bodytext for a content element

Parameters:
string The bodytext content
integer Position where to start in the bodytext stream. If larger than zero a prefix, "...", is prepended.
integer Max length
Returns:
string Prepared content
See also:
contentAll()

Definition at line 291 of file wapversionLib.inc.

References t3lib_div::fixed_lgd(), and nl2br().

Referenced by contentAll().

user_wapversion::cHeader (  $  str  ) 
 

Formats the header for a content element

Parameters:
string Header value to format
Returns:
string Returns the formatted version, stripped from tags and htmlspecialchar()'ed
See also:
contentAll()

Definition at line 277 of file wapversionLib.inc.

References bold().

user_wapversion::cleanMenuArray (  $  menu  ) 
 

Cleaning up the menu array returned from sys_page->getMenu(). Removing page types with doktype "5" (not in menu)

Parameters:
array Menu item array
Returns:
array New menu item array with doktype-5 elements removed.

Definition at line 421 of file wapversionLib.inc.

Referenced by menuCurrentLevel().

user_wapversion::contentAbstract (   ) 
 

Getting abstract of the first content elements header and bodytext for the menu

Returns:
string WML string

Definition at line 200 of file wapversionLib.inc.

References bold(), t3lib_div::fixed_lgd(), and getContentResult().

Referenced by main_wapversion().

user_wapversion::contentAll (  $  chunkLgd = 850  ) 
 

Returns all page content, but in an array where the content is divided into chunks or a max length (for WAP clients with limited memory capabilities) Content is then displayed using the pointer value found in $GLOBALS['TSFE']->idParts[1], see main_wapversion()

Parameters:
integer Max length of each content chunk
Returns:
array Array with the page content divided into chucks WML code (default length equals $chunkLgd; 850)
See also:
main_wapversion()

Definition at line 217 of file wapversionLib.inc.

References $idx, cBodytext(), and getContentResult().

Referenced by main_wapversion().

user_wapversion::getContentResult (  $  table  ) 
 

Selects all records from $table having the current page id as PID (records belonging to that page) Used to select content elements from "tt_content"

Parameters:
string A tablename found in $TCA
Returns:
pointer A database resource pointer

Definition at line 314 of file wapversionLib.inc.

Referenced by contentAbstract(), and contentAll().

user_wapversion::line (  $  str  ) 
 

Adds a linebreak character to the end of $str

Parameters:
string The string/line
Returns:
string The input string with '
' prepended

Definition at line 349 of file wapversionLib.inc.

user_wapversion::link (  $  str,
$  id,
$  deck = ''
) 
 

Creates a link around the input string to another page/deck Used to create menus

Parameters:
string The string to be wrapped in tags
integer The page id to link to
string The deck name, if any
Returns:
string String wrapped in tags
See also:
menuCurrentLevel()

Definition at line 405 of file wapversionLib.inc.

Referenced by menuCurrentLevel().

user_wapversion::main_wapversion (  $  content,
$  conf
) 
 

Main function, called from TypoScript

Parameters:
string Empty, ignore.
array TypoScript properties for this content object/function call
Returns:
string WML content

Definition at line 141 of file wapversionLib.inc.

References contentAbstract(), contentAll(), t3lib_div::intInRange(), t3lib_div::makeInstanceClassName(), menuCurrentLevel(), navLink(), and paragraph().

user_wapversion::menuCurrentLevel (  $  indent  ) 
 

Creates a menu for the current pagelevel. Navigation is both a path-menu (rootline) and a menu of current page subpages.

Parameters:
string Indentation prefix string per menu item.
Returns:
string A paragraph with the menu items inside.

Definition at line 370 of file wapversionLib.inc.

References cleanMenuArray(), link(), and paragraph().

Referenced by main_wapversion().

user_wapversion::navLink (  $  str,
$  pointer
) 
 

Creates a navigation link to the next part of the page content!

Parameters:
string The link text
integer The pointer value
Returns:
string The input string, linked with the pointer value to the current page.

Definition at line 360 of file wapversionLib.inc.

Referenced by main_wapversion().

user_wapversion::nl2br (  $  str  ) 
 

Local version of ml2br(). Replaces linebreaks with
tags.

Parameters:
string The input string to process
Returns:
string The processed value returned.

Definition at line 303 of file wapversionLib.inc.

Referenced by cBodytext().

user_wapversion::paragraph (  $  str  ) 
 

Wraps a string in

... tags

Parameters:
string The input string
Returns:
string The wrapped string

Definition at line 339 of file wapversionLib.inc.

Referenced by main_wapversion(), and menuCurrentLevel().

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