phpDocumentor openbiz.bin
[ class tree: openbiz.bin ] [ index: openbiz.bin ] [ all elements ]

Class: Resource

Source Location: /Resource.php

Class Resource

Class Overview
Method Summary
string   GetCssUrl()   Get CSS URL
string   GetImageUrl()   Get image URL
string   GetJsUrl()   Get JavaScript(JS) URL
string   GetLibFileWithPath()   Get openbiz library php file path by searching modules/package, /bin/package and /bin
string   GetMessage()   Get message from CONSTANT, translate and format it
Smarty   GetSmartyTemplate()   Get smarty template
string   GetTplFileWithPath()   Get openbiz template file path by searching modules/package, /templates
array   &GetXmlArray()   Get Xml Array.
string   GetXmlFileWithPath()   Get Xml file with path
Zend_View   GetZendTemplate()   Get Zend Template
mixed   LoadMessage()   Load message from file

[ Top ]
Methods
GetCssUrl  [line 89]

  string GetCssUrl( )

Get CSS URL


API Tags:
Static:  
Access:  public


[ Top ]
GetImageUrl  [line 70]

  string GetImageUrl( )

Get image URL


API Tags:
Static:  
Access:  public


[ Top ]
GetJsUrl  [line 107]

  string GetJsUrl( )

Get JavaScript(JS) URL


API Tags:
Static:  
Access:  public


[ Top ]
GetLibFileWithPath  [line 280]

  string GetLibFileWithPath( string $className, [mixed $packageName = ""]  )

Get openbiz library php file path by searching modules/package, /bin/package and /bin

Parameters:
string   $className: 

API Tags:
Return:  php library file path
Static:  
Access:  public


[ Top ]
GetMessage  [line 55]

  string GetMessage( string $msgId, [array $params = array()]  )

Get message from CONSTANT, translate and format it

Parameters:
string   $msgId:  ID if constant
array   $params:  parameter for format (use vsprintf)

API Tags:
Static:  
Access:  public


[ Top ]
GetSmartyTemplate  [line 119]

  Smarty GetSmartyTemplate( )

Get smarty template


API Tags:
Return:  smarty object
Static:  
Access:  public


[ Top ]
GetTplFileWithPath  [line 211]

  string GetTplFileWithPath( mixed $templateFile, mixed $packageName, string $className  )

Get openbiz template file path by searching modules/package, /templates

Parameters:
string   $className: 

API Tags:
Return:  php library file path
Static:  
Access:  public


[ Top ]
GetXmlArray  [line 352]

  array &GetXmlArray( string $xmlFile  )

Get Xml Array.

If xml file has been compiled (has .cmp), load the cmp file as array; otherwise, compile the .xml to .cmp first new 2.2.3, .cmp files will be created in app/cache/metadata_cmp directory. replace '/' with '_' for example, /module/demo/BOEvent.xml has cmp file as _module_demo_BOEvent.xml

Parameters:
string   $xmlFile: 

API Tags:
Static:  
Access:  public


[ Top ]
GetXmlFileWithPath  [line 177]

  string GetXmlFileWithPath( string $xmlObj  )

Get Xml file with path

Search the object metedata file as objname+.xml in metedata directories name convension: demo.BOEvent points to metadata/demo/BOEvent.xml new in 2.2.3, demo.BOEvent can point to modules/demo/BOEvent.xml

Parameters:
string   $xmlObj:  xml object

API Tags:
Return:  xml config file path
Static:  
Access:  public


[ Top ]
GetZendTemplate  [line 155]

  Zend_View GetZendTemplate( )

Get Zend Template


API Tags:
Return:  zend view template object
Static:  
Access:  public


[ Top ]
LoadMessage  [line 35]

  mixed LoadMessage( string $messageFile  )

Load message from file

Parameters:
string   $messageFile: 

API Tags:
Static:  
Access:  public


[ Top ]

Documentation generated on Tue, 22 Dec 2009 03:03:16 -0800 by phpDocumentor 1.3.0RC3