Docs For Class atkUI
Atk API home Class tree Element index

Todo list

Packages: » atk Classes: skel- » atkAppSuite utils » atkAbstractFrame » atkActionListener » atkClassFinder » atkClassLoader » atkDataHolder » atkDebugger » atkDirectoryTraverser » atkEventLog » atkFileUtils » atkFrame » atkFrameSet » atkIpUtils » atkJSON » atkMail » atkMailer » atkMessageQueue » atkmlsplitter » atkNavigator » atkRootFrameset » atkSelector » atkString » atkStringParser » atkTableRenderer » atkTableRendererGrouped » atkTextMarker » atkTmpFile » atkTriggerListener » atkYAML » atkZip » browserInfo » listenerTest » simplevisitor » testNode » test_atkactionlistener » test_atkclassloader » test_atkcolumnconfig » test_atkDirectoryTraverser » test_atklistattribute » test_atkStringParser » test_atkTextMarker general » atkConfig » atkController » atkDataNode » atkErrorHandlerBase » atkFileEditor » atkLanguage » atkMailErrorHandler » atkMetaNode » atkMockNode » atkNode » atkNodeValidator » atkSessionStore » atkTreeNode » atkWizardBase » atkZendPlatformErrorHandler » clsTbsDataSource » clsTbsLocator » clsTinyButStrong » clsTinyButStrongOOo » FCKeditor » getSupportedLanguagesCollector » layout » node » sql_whereclause_blacklist_checker » test » tree » triggerNode fixture » atkAbstractFixtureLoader » atkFixtureManager » atkPHPFixtureLoader » atkYAMLFixtureLoader testcases » atkAbstractSearchHandler » DateAttributeWrapper » dummyTagAttribute » Stub_atkNew » test_atkattributeedithandler » test_atkBoolAttribute » test_atkCalculatorAttribute » test_atkcolorpickerattribute » test_atkDataGrid » test_atkdatanode » test_atkDateAttribute » test_atkFileAttribute » test_atkfrontcontroller » test_atkiputils » test_atkManyToOneRelation » test_atknode » test_atkRelation » test_atktagattribute » test_atkwizard » test_tabs » uriPartsFrontControllerMock ui » atkActionBoxBuilder » atkDialog » atkIndexPage » atkOutput » atkPage » atkPageBuilder » atkTheme » atkThemeCompiler » atkUI handlers » atkActionHandler » atkAddHandler » atkAddOrCopyHandler » atkAdminHandler » atkAttributeEditHandler » atkCopyHandler » atkDeleteHandler » atkDocumentHandler » atkEditCopyHandler » atkEditHandler » atkExportHandler » atkFeedbackHandler » atkFileExport » atkImportHandler » atkMultiSelectHandler » atkMultiUpdatehandler » atkSaveHandler » atkSearchHandler » atkSelectHandler » atkSmartSearchHandler » atkUpdatehandler » atkViewEditBase » atkViewHandler » atkXmlHandler » test_atkimporthandler attributes » atkAggregatedColumn » atkAttribute » atkBoolAttribute » atkCalculatorAttribute » atkCaptchaAttribute » atkColorPickerAttribute » atkCountryAttribute » atkCreatedByAttribute » atkCreateStampAttribute » atkCurrencyAttribute » atkDateAttribute » atkDateTimeAttribute » atkDocumentAttribute » atkDummyAttribute » atkDurationAttribute » atkEmailAttribute » atkExpressionAttribute » atkFckAttribute » atkFieldSet » atkFileAttribute » atkFileWriterAttribute » atkFlagAttribute » atkFormatAttribute » atkFuzzySearchAttribute » atkHtmlAttribute » atkIpAttribute » atkListAttribute » atkLiveTextPreview » atkMlAttribute » atkMlHtmlAttribute » atkMlNumberAttribute » atkMlSelectorAttribute » atkMlTextAttribute » atkMlWrapper » atkMultipleFileAttribute » atkMultiSelectAttribute » atkNumberAttribute » atkParserAttribute » atkPasswordAttribute » atkProfileAttribute » atkRadioAttribute » atkRadioDetailsAttribute » atkRowCounter » atkStateAttribute » atkTabbedPane » atkTagAttribute » atkTextAttribute » atkTimeAttribute » atkTimeZoneAttribute » atkToolbar » atkUpdatedByAttribute » atkUpdateStampAttribute » atkUrlAttribute » atkWeekdayAttribute » atkWysiwygAttribute » test_atkattribute » test_atkmultiselectattribute » test_atktextattribute datatypes » atkArrayDt » atkDataType » atkStringDt » atkTime subpackage » atkAttributeTestCase security » atkBajusEncryption » atkBase64Encryption » atkEncryption » atkMockSecurityManager » atkOpenSSLEncryption » atkSecurityListener » atkSecurityManager » atkUrlVault » auth_config » auth_db » auth_imap » auth_interface » auth_ldap » auth_none » auth_pop3 » auth_server » auth_sspi » test_atkMockSecurityManager » test_atkUrlVault cache » atkCache » atkCache_apc » atkCache_eaccelerator » atkCache_file » atkCache_memcache » atkCache_var » atkCache_xcache » atkCache_zp_disk » atkCache_zp_output » atkCache_zp_shm » test_atkcache_apc » test_atkcache_eaccelerator » test_atkcache_file » test_atkcache_memcache » test_atkcache_var » test_atkcache_xcache » test_atkcache_zp_disk » test_atkcache_zp_output » test_atkcache_zp_shm test » ArrayHtmlReporter » ArrayTextReporter » atkCacheTestCase » atkPHPUnitTestCaseCollector » atkPluginTestCase » atkSimpleTestTestCaseCollector » atkTestCase » atkTestCaseCollector » atkTestReporter » atkTestSuite » atkTestTraverser » test_atkMockNode » test_atktestcase » test_atktools » Test_DbConfigs » test_sql_whereclause_blacklist_checker » test_tabsecurity » test_triggers db » atkClusterDb » atkClusterDDL » atkClusterQuery » atkDb » atkDDL » atkMockDb » atkMockDDL » atkMockQuery » atkMsSqlDb » atkMsSqlDDL » atkMssqlQuery » atkMysqlDb » atkMysqlDDL » atkMysqliDb » atkMysqliDDL » atkMysqliQuery » atkMysqlQuery » atkOci8Db » atkOci8DDL » atkOci8Query » atkOci9Db » atkOci9DDL » atkOci9Query » atkOci805Db » atkOci805Query » atkPgsqlDb » atkPgsqlDDL » atkPgsqlQuery » atkQuery » test_atkdb recordlist » atkColumnConfig » atkCSVRecordList » atkCustomRecordList » atkExcelCSVRecordList » atkHTMLRecordList » atkPrintableRecordList » atkRecordList » atkRecordlistCache » atkTotalizer console » atkConsoleController menu » atkcookmenu » atkDhtmlMenu » atkDropdownMenu » atkFramesMenu » atkMenu » atkmenuinterface » atkModernMenu » atkOutlookMenu » atkPlainMenu datagrid » atkDataGrid » atkDGComponent » atkDGEditControl » atkDGEvent » atkDGIndex » atkDGLimit » atkDGList » atkDGNoRecordsFound » atkDGPaginator » atkDGRenderer » atkDGSummary lock » atkDbLock » atkLock filters » atkDistinctFilter » atkFilter » atkGroupByFilter document » atkDocumentWriter » atkDocxWriter » atkOpenDocumentWriter meta » atkDutchMetaGrammar » atkMetaAttributeModifier » atkMetaCompiler » atkMetaGrammar » atkMetaPolicy » mod_meta relations » atkExtendableShuttleRelation » atkManyBoolRelation » atkManyToManyListRelation » atkManyToManyRelation » atkManyToManySelectRelation » atkManyToOneRelation » atkManyToOneTreeRelation » atkMatrixRelation » atkOneToManyRelation » atkOneToManyRelationSessionGridHandler » atkOneToOneRelation » atkRelation » atkSecureRelation » atkShuttleControl » atkShuttleFilter » atkShuttleRelation front » atkFrontController » atkFrontControllerBridge keyboard » atkKeyboard meta-relations » atkMetaExtendableShuttleRelation » atkMetaManyBoolRelation » atkMetaManyToManyListRelation » atkMetaManyToManySelectRelation » atkMetaManyToOneRelation » atkMetaOneToManyRelation » atkMetaOneToOneRelation » atkMetaShuttleRelation modules » atkModule » mod_test interface » atkServer » atkSoapServer session » atkSessionManager » atkState wizard » atkWizard » AtkWizardActionLoader » atkWizardPanel attribute » test_atkcurrencyattribute » test_atknumberattribute
Interfaces: datagrid » atkDGListener interface » atkServerInterface
Files: general » adodb-time.inc.php » atknodetools.inc » atktools.inc » atktreetools.inc » basexml.php » class.atkconfig.inc » class.atkcontroller.inc » class.atkdatanode.inc » class.atkerrorhandlerbase.inc » class.atkfileeditor.inc » class.atklanguage.inc » class.atkmailerrorhandler.inc » class.atkmetanode.inc » class.atkmocknode.inc » class.atknode.inc » class.atknodevalidator.inc » class.atksessionstore.inc » class.atktreenode.inc » class.atkwizardbase.inc » class.atkzendplatformerrorhandler.inc » class.layout.inc » class.nodename.inc » class.sql_whereclause_blacklist_checker.inc » class.test.inc » class.test_sql_whereclause_blacklist_checker.inc » class.test_triggers.inc » commands.php » config.modules.inc » config.php » connector.php » console.php » db2yaml.php » defaultconfig.inc.php » fckeditor.php » fckeditor_php4.php » fckeditor_php5.php » io.php » module.inc » phpcompat.php » server.php » spellchecker.php » table2yaml.php » tbsooo_class.php » tbs_class.php » upload.php » util.php » version.inc attribute » class.test_atkcurrencyattribute.inc » class.test_atknumberattribute.inc attributes » class.atkaggregatedcolumn.inc » class.atkattribute.inc » class.atkboolattribute.inc » class.atkcalculatorattribute.inc » class.atkcaptchaattribute.inc » class.atkcolorpickerattribute.inc » class.atkcountryattribute.inc » class.atkcreatedbyattribute.inc » class.atkcreatestampattribute.inc » class.atkcurrencyattribute.inc » class.atkdateattribute.inc » class.atkdatetimeattribute.inc » class.atkdocumentattribute.inc » class.atkdummyattribute.inc » class.atkdurationattribute.inc » class.atkemailattribute.inc » class.atkexpressionattribute.inc » class.atkfckattribute.inc » class.atkfieldset.inc » class.atkfileattribute.inc » class.atkfilewriterattribute.inc » class.atkflagattribute.inc » class.atkformatattribute.inc » class.atkfuzzysearchattribute.inc » class.atkhtmlattribute.inc » class.atkipattribute.inc » class.atklistattribute.inc » class.atklivetextpreview.inc » class.atkmlattribute.inc » class.atkmlhtmlattribute.inc » class.atkmlnumberattribute.inc » class.atkmlselectorattribute.inc » class.atkmltextattribute.inc » class.atkmlwrapper.inc » class.atkmultiplefileattribute.inc » class.atkmultiselectattribute.inc » class.atknumberattribute.inc » class.atkparserattribute.inc » class.atkpasswordattribute.inc » class.atkprofileattribute.inc » class.atkradioattribute.inc » class.atkradiodetailsattribute.inc » class.atkrowcounter.inc » class.atkstateattribute.inc » class.atktabbedpane.inc » class.atktagattribute.inc » class.atktextattribute.inc » class.atktimeattribute.inc » class.atktimezoneattribute.inc » class.atktoolbar.inc » class.atkupdatedbyattribute.inc » class.atkupdatestampattribute.inc » class.atkurlattribute.inc » class.atkweekdayattribute.inc » class.atkwysiwygattribute.inc » class.test_atkattribute.inc » class.test_atkmultiselectattribute.inc » class.test_atktextattribute.inc attributes-- » property_accessor.php cache » class.atkcache.inc » class.atkcache_apc.inc » class.atkcache_eaccelerator.inc » class.atkcache_file.inc » class.atkcache_memcache.inc » class.atkcache_var.inc » class.atkcache_xcache.inc » class.atkcache_zp_disk.inc » class.atkcache_zp_output.inc » class.atkcache_zp_shm.inc » class.test_atkcache_apc.inc » class.test_atkcache_eaccelerator.inc » class.test_atkcache_file.inc » class.test_atkcache_memcache.inc » class.test_atkcache_var.inc » class.test_atkcache_xcache.inc » class.test_atkcache_zp_disk.inc » class.test_atkcache_zp_output.inc » class.test_atkcache_zp_shm.inc console » class.atkconsolecontroller.inc datagrid » class.atkdatagrid.inc » class.atkdgcomponent.inc » class.atkdgeditcontrol.inc » class.atkdgevent.inc » class.atkdgindex.inc » class.atkdglimit.inc » class.atkdglist.inc » class.atkdglistener.inc » class.atkdgnorecordsfound.inc » class.atkdgpaginator.inc » class.atkdgrenderer.inc » class.atkdgsummary.inc datatypes » class.atkarraydt.inc » class.atkdatatype.inc » class.atkstringdt.inc » class.atktimedt.inc db » class.atkclusterdb.inc » class.atkclusterddl.inc » class.atkclusterquery.inc » class.atkdb.inc » class.atkddl.inc » class.atkmockdb.inc » class.atkmockddl.inc » class.atkmockquery.inc » class.atkmssqldb.inc » class.atkmssqlddl.inc » class.atkmssqlquery.inc » class.atkmysqldb.inc » class.atkmysqlddl.inc » class.atkmysqlidb.inc » class.atkmysqliddl.inc » class.atkmysqliquery.inc » class.atkmysqlquery.inc » class.atkoci8db.inc » class.atkoci8ddl.inc » class.atkoci8query.inc » class.atkoci9db.inc » class.atkoci9ddl.inc » class.atkoci9query.inc » class.atkoci805db.inc » class.atkoci805query.inc » class.atkpgsqldb.inc » class.atkpgsqlddl.inc » class.atkpgsqlquery.inc » class.atkquery.inc » class.test_atkdb.inc document » class.atkdocumentwriter.inc » class.atkdocxwriter.inc » class.atkopendocumentwriter.inc filters » class.atkdistinctfilter.inc » class.atkfilter.inc » class.atkgroupbyfilter.inc fixture » class.atkabstractfixtureloader.inc » class.atkfixturemanager.inc » class.atkphpfixtureloader.inc » class.atkyamlfixtureloader.inc front » class.atkfrontcontroller.inc » class.atkfrontcontrollerbridge.inc handlers » class.atkactionhandler.inc » class.atkaddhandler.inc » class.atkaddorcopyhandler.inc » class.atkadminhandler.inc » class.atkattributeedithandler.inc » class.atkcopyhandler.inc » class.atkdeletehandler.inc » class.atkdocumenthandler.inc » class.atkeditcopyhandler.inc » class.atkedithandler.inc » class.atkexporthandler.inc » class.atkfeedbackhandler.inc » class.atkfileexport.inc » class.atkimporthandler.inc » class.atkmultiselecthandler.inc » class.atkmultiupdatehandler.inc » class.atksavehandler.inc » class.atksearchhandler.inc » class.atkselecthandler.inc » class.atksmartsearchhandler.inc » class.atkupdatehandler.inc » class.atkvieweditbase.inc » class.atkviewhandler.inc » class.atkxmlhandler.inc » class.test_atkimporthandler.inc include » autoload.inc » basics.inc » compatibility.inc » configs.inc » debugging.inc » errorhandler.inc » globals.inc » initial.inc » security.inc interface » class.atkserver.inc » class.atksoapserver.inc » interface.atkserverinterface.inc javascript » class.atkmultilanguage.js.php » class.atkprofileattribute.js.php » dhtml_tabs.js.php keyboard » class.atkkeyboard.inc lock » class.atkdblock.inc » class.atklock.inc » lock.php lock-- » lock.js.php menu » atkmenutools.inc » class.atkcookmenu.inc » class.atkdhtmlmenu.inc » class.atkdropdownmenu.inc » class.atkframesmenu.inc » class.atkmenu.inc » class.atkmenuinterface.inc » class.atkmodernmenu.inc » class.atkoutlookmenu.inc » class.atkplainmenu.inc meta » class.atkdutchmetagrammar.inc » class.atkmetaattributemodifier.inc » class.atkmetacompiler.inc » class.atkmetagrammar.inc » class.atkmetapolicy.inc » module.inc meta-relations » class.atkmetaextendableshuttlerelation.inc » class.atkmetamanyboolrelation.inc » class.atkmetamanytomanylistrelation.inc » class.atkmetamanytomanyselectrelation.inc » class.atkmetamanytoonerelation.inc » class.atkmetaonetomanyrelation.inc » class.atkmetaonetoonerelation.inc » class.atkmetashuttlerelation.inc modules » class.atkmodule.inc modules-- » atkmoduletools.inc popups » colorpicker.inc recordlist » class.atkcolumnconfig.inc » class.atkcsvrecordlist.inc » class.atkcustomrecordlist.inc » class.atkexcelcsvrecordlist.inc » class.atkhtmlrecordlist.inc » class.atkprintablerecordlist.inc » class.atkrecordlist.inc » class.atkrecordlistcache.inc » class.atktotalizer.inc relations » class.atkextendableshuttlerelation.inc » class.atkmanyboolrelation.inc » class.atkmanytomanylistrelation.inc » class.atkmanytomanyrelation.inc » class.atkmanytomanyselectrelation.inc » class.atkmanytoonerelation.inc » class.atkmanytoonetreerelation.inc » class.atkmatrixrelation.inc » class.atkonetomanyrelation.inc » class.atkonetoonerelation.inc » class.atkrelation.inc » class.atksecurerelation.inc » class.atkshuttlecontrol.inc » class.atkshuttlefilter.inc » class.atkshuttlerelation.inc security » class.atkbajusencryption.inc » class.atkbase64encryption.inc » class.atkencryption.inc » class.atkmocksecuritymanager.inc » class.atkopensslencryption.inc » class.atksecuritylistener.inc » class.atksecuritymanager.inc » class.atkurlvault.inc » class.auth_config.inc » class.auth_db.inc » class.auth_imap.inc » class.auth_interface.inc » class.auth_ldap.inc » class.auth_none.inc » class.auth_pop3.inc » class.auth_server.inc » class.auth_sspi.inc » class.test_atkmocksecuritymanager.inc » class.test_atkurlvault.inc session » class.atksessionmanager.inc » class.atkstate.inc skel » app.php » atk.inc » config.inc.php » debugger.php » dispatch.php » include.php » index.php » menu.php » test.php » top.php » welcome.php skel- » atkappsuite.php subpackage » class.atkattributetestcase.inc test » class.atkcachetestcase.inc » class.atkphpunittestcasecollector.inc » class.atkplugintestcase.inc » class.atksimpletesttestcasecollector.inc » class.atktestcase.inc » class.atktestcasecollector.inc » class.atktestreporter.inc » class.atktestsuite.inc » class.atktesttraverser.inc » class.test_atkmocknode.inc » class.test_atktestcase.inc » class.test_atktools.inc » class.test_dbconfigs.inc » class.test_tabsecurity.inc testcases » class.atkabstractsearchhandler.inc » class.stub_atknew.inc » class.test_atkattributeedithandler.inc » class.test_atkboolattribute.inc » class.test_atkcalculatorattribute.inc » class.test_atkcolorpickerattribute.inc » class.test_atkdatagrid.inc » class.test_atkdatanode.inc » class.test_atkdateattribute.inc » class.test_atkfileattribute.inc » class.test_atkfrontcontroller.inc » class.test_atkiputils.inc » class.test_atkmanytoonerelation.inc » class.test_atknode.inc » class.test_atkrelation.inc » class.test_atktagattribute.inc » class.test_atkwizard.inc » class.test_tabs.inc themes » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc ui » block.atknavigator.php » block.atknavigatorinfo.php » class.atkactionboxbuilder.inc » class.atkdialog.inc » class.atkindexpage.inc » class.atkoutput.inc » class.atkpage.inc » class.atkpagebuilder.inc » class.atktheme.inc » class.atkthemecompiler.inc » class.atkui.inc » function.atkconfig.php » function.atkdatefield.php » function.atkdispatchfile.php » function.atkfrontcontroller.php » function.atkloadscript.php » function.atkmessages.php » function.atkmoduledir.php » function.atkscript.php » function.atkstyle.php » function.atktext.php » function.atkthemeicon.php » function.atkthemeimg.php » function.stacktrace.php » modifier.atkjson.php » modifier.atkvardump.php » resource.string.php » resource.theme.php » resource.ui.php utils » atkbrowsertools.inc » class.atkactionlistener.inc » class.atkclassloader.inc » class.atkdataholder.inc » class.atkdebugger.inc » class.atkdirectorytraverser.inc » class.atkeventlog.inc » class.atkfileutils.inc » class.atkframeset.inc » class.atkiputils.inc » class.atkjson.inc » class.atkmail.inc » class.atkmailer.inc » class.atkmessagequeue.inc » class.atkmlsplitter.inc » class.atknavigator.inc » class.atkselector.inc » class.atkstring.inc » class.atkstringparser.inc » class.atktablerenderer.inc » class.atktablerenderergrouped.inc » class.atktextmarker.inc » class.atktmpfile.inc » class.atktriggerlistener.inc » class.atkyaml.inc » class.atkzip.inc » class.test_atkactionlistener.inc » class.test_atkclassloader.inc » class.test_atkcolumnconfig.inc » class.test_atkdirectorytraverser.inc » class.test_atklistattribute.inc » class.test_atkstringparser.inc » class.test_atktextmarker.inc » help.inc wizard » class.atkwizard.inc » class.atkwizardactionloader.inc » class.atkwizardpanel.inc
Home  ->  Documentation home  ->  Atk index  ->  Docs For Class atkUI [ package: atk ]

Class: atkUI

Source Location: /ui/class.atkui.inc

Class atkUI

Property Summary

Smarty   $m_smarty   Smarty instance, initialised by constructor
atkTheme   $m_theme   atkTheme instance, initialised by constructor

[ Top ]

Method Summary

atkUI   atkUI()   atkUi constructor, initialises Smarty and atkTheme instance
atkUI   &getInstance()   get a singleton instance of the atkUi class.
String   getWizardTitle()   This function returns a suitable title text for an Wizardpanel.
String   nodeTitle()   This function returns a suitable title text for an action.
String   render()   Renders the given template.
String   renderAction()   Renders action templates
void   renderBox()   Renders a box with Smarty template.
string   renderDialog()   Renders the insides of a dialog.
void   renderList()   Renders a list template
string   renderPhp()   Render PHP-based template.
string   renderSmarty()   Render Smarty-based template.
String   renderTabs()   Renders a tabulated template
String   renderTop()   Renders top template
String   stylePath()   This function returns a complete themed path for a given stylesheet.
String   templatePath()   This function returns a complete themed path for a given template.
String   title()   Return the title to render

[ Top ]

Properties

Smarty   $m_smarty = NULL [line 32]

Smarty instance, initialised by constructor

API Tags:
Access:  private


[ Top ]
atkTheme   $m_theme = NULL [line 39]

atkTheme instance, initialised by constructor

API Tags:
Access:  private


[ Top ]

Methods

Constructor atkUI  [line 44]

  atkUI atkUI( )

atkUi constructor, initialises Smarty and atkTheme instance



[ Top ]
getInstance  [line 55]

  atkUI &getInstance( )

get a singleton instance of the atkUi class.



[ Top ]
getWizardTitle  [line 369]

  String getWizardTitle( String $wizard, String $panel, [String $action = NULL]  )

This function returns a suitable title text for an Wizardpanel.

Example: echo $ui->title("departmentwizard", "employee", "add"); might return: 'Departmen wizard - Add employees - Step 2 of 3'

Parameters:
String   $wizard:  the wizard object
String   $panel:  the panel object
String   $action:  the atk action that we are trying execute in the panel

API Tags:
Return:  the title for this wizardpanel


[ Top ]
nodeTitle  [line 315]

  String nodeTitle( atkNode $node, [String $action = NULL], [bool $actiononly = false]  )

This function returns a suitable title text for an action.

Example: echo $ui->title("users", "employee", "edit"); might return: 'Edit an existing employee'

Parameters:
atkNode   $node:  the node to get the title from
String   $action:  the action that we are trying to find a title for
bool   $actiononly:  wether or not to return a name of the node if we couldn't find a specific title

API Tags:
Return:  the title for the action


[ Top ]
render  [line 176]

  String render( String $name, [array $vars = array()], [String $module = ""]  )

Renders the given template.

If the name ends with ".php" PHP will be used to render the template. If the name ends with ".tpl" and a file with the extension ".tpl.php" exists PHP will be used, otherwise Smarty will be used to render the template.

Parameters:
String   $name:  the name of the template to render
array   $vars:  the variables with which to render the template
String   $module:  the name of the module requesting to render a template

API Tags:
Return:  rendered template
Access:  public


[ Top ]
renderAction  [line 76]

  String renderAction( String $action, array $vars, [string $module = ""]  )

Renders action templates

Currently only the view action is implemented

Parameters:
String   $action:  the action for which to render the template
array   $vars:  the template variables
string   $module:  the name of the module requesting to render a template

API Tags:
Return:  the rendered template


[ Top ]
renderBox  [line 125]

  void renderBox( array $vars, [string $name = ""], [string $module = ""]  )

Renders a box with Smarty template.

Call with a $name variable to provide a better default than "box.tpl".

For instance, calling renderBox($smartyvars, "menu") will make it search for a menu.tpl first and use that if it's available, otherwise it will just use box.tpl

Parameters:
array   $vars:  the variables for the template
string   $name:  The name of the template
string   $module:  the name of the module requesting to render a template


[ Top ]
renderDialog  [line 141]

  string renderDialog( array $vars, [string $module = ""]  )

Renders the insides of a dialog.

Parameters:
array   $vars:  template variables
string   $module:  the name of the module requesting to render a template

API Tags:
Return:  rendered dialog


[ Top ]
renderList  [line 94]

  void renderList( String $action, array $vars, [string $module = ""]  )

Renders a list template

Parameters:
String   $action:  not used (deprecated?)
array   $vars:  the variables with which to parse the list template
string   $module:  the name of the module requesting to render a template


[ Top ]
renderPhp  [line 203]

  string renderPhp( string $path, array $vars  )

Render PHP-based template.

Parameters:
string   $path:  template path
array   $vars:  template variables

API Tags:
Return:  rendered template
Access:  private


[ Top ]
renderSmarty  [line 221]

  string renderSmarty( string $path, array $vars  )

Render Smarty-based template.

Parameters:
string   $path:  template path
array   $vars:  template variables

API Tags:
Return:  rendered template
Access:  private


[ Top ]
renderTabs  [line 153]

  String renderTabs( array $vars, [string $module = ""]  )

Renders a tabulated template

Registers some scriptcode too when the tabtype is set to dhtml

Parameters:
array   $vars:  the variables with which to render the template
string   $module:  the name of the module requesting to render a template

API Tags:
Return:  the rendered template


[ Top ]
renderTop  [line 106]

  String renderTop( array $vars, [string $module = ""]  )

Renders top template

Parameters:
array   $vars:  the variables for the template
string   $module:  the name of the module requesting to render a template

API Tags:
Return:  with the rendered box
Deprecated:  Use renderBox($vars, "top") instead


[ Top ]
stylePath  [line 284]

  String stylePath( String $style, [String $module = ""]  )

This function returns a complete themed path for a given stylesheet.

This is a convenience method, which calls the stylePath method on the theme instance.

Parameters:
String   $style:  The filename (without path) of the stylesheet for which you want to complete the path.
String   $module:  the name of the module requesting the style path

API Tags:
Return:  the path of the style


[ Top ]
templatePath  [line 263]

  String templatePath( String $template, [String $module = ""]  )

This function returns a complete themed path for a given template.

This is a convenience method, which calls the tplPath method on the theme instance. However, if the template name contains a '/', we assume the full template path is already given and we simply return it.

Parameters:
String   $template:  The filename (without path) of the template for which you want to complete the path.
String   $module:  The name of the module requesting to render a template

API Tags:
Return:  the template path


[ Top ]
title  [line 299]

  String title( String $module, String $nodetype, [String $action = null], [bool $actiononly = false]  )

Return the title to render

Parameters:
String   $module:  the module in which to look
String   $nodetype:  the nodetype of the action
String   $action:  the action that we are trying to find a title for
bool   $actiononly:  wether or not to return a name of the node if we couldn't find a specific title

API Tags:
Return:  the title for the action


[ Top ]
Home | About | Contact