joomlaclass1.docx
《joomlaclass1.docx》由会员分享，可在线阅读，更多相关《joomlaclass1.docx（40页珍藏版）》请在冰豆网上搜索。
joomlaclass1
joomla_class
Jversion
API
Package
Joomla.Framework
Joomla.Framework
提供Joomla的版本信息!
如果代码跑在当前的Joomla中!
前端（站点）或后端（管理员）都能使用全局性对象$_VERSION而不用创造JVersion一个新的对象。
方法
Method
Description
getHelpVersion
返回帮助文件的版本信息,后台帮助系统使用的方法
getLongVersion
返回一个长的格式的joomla的版本信息
getShortVersion
返回一个短的格式的joomla的版本信息
isCompatible
比较版本的当前的版本
方法应用:
getHelpVersion
意义:
助文件的版本信息
语法:
stringgetHelpVersion（）
实际应用
$version=&newJversion;
$help_version=$version->getHelpVersion（）;
结果:
返回帮助文本的信息.
Result:
.15
getLongVersion
意义:
长的格式的joomla的版本信息
语法:
stringgetLongVersion（）
实际应用
$version=&newJversion（）;
$long_version=$version->getLongVersion（）;
结果:
返回长格式的joomla的版本信息.
Result:
Joomla!
1.5.0Production/Stable[Khepri]21-January-200823:
55GMT
getShortVersion
意义:
短的格式的joomla的版本信息
语法:
stringgetShortVersion（）
实际应用:
$version=&newJversion;
$short_version=$version->getShortVersion（）;
echo$short_version;
结果:
返回短格式的joomla的版本信息.
Result:
1.5.0
isCompatible
意义:
比较版本的当前的版本
语法:
booleanisCompatible（string$minimum）
这个方法是静态的.
实际应用:
$version=&newJversion;
$iscom=$version->iscompatible（'1.5.0''）;
echo$iscom;
结果:
与输入的参数作为参考做比较,真为1假为0.
Result:
1
类中涉及的变量:
int$BUILDvar:
buildNumber
string$CODENAMEvar:
Codename
string$COPYRIGHTvar:
CopyrightText
int$DEV_LEVELvar:
SubReleaseLevel
string$DEV_STATUSvar:
DevelopmentStatus
string$PRODUCTvar:
Product
string$RELDATEvar:
Date
string$RELEASEvar:
MainReleaseLevel
string$RELTIMEvar:
Time
string$RELTZvar:
Timezone
string$URLvar:
URL
变量的用法:
$version=&newJversion;
echo$version->BULID;
echo$version->CODENAME;
echo$version->COPYRIGHT;
echo$version->DEV_LEVEL;
echo$version->DEV_STATUS;
echo$version->PRODUCT;
echo$version->RELDATE;
echo$version->RELEASE;
echo$version->RELTIME;
echo$version->RELTZ;
echo$version->URL;
JFactory
API
Package
Joomla.Framework
Joomla.Framework
Joomla!
框架工厂类.这个类被用来创建各种各样的Joomla!
框架类.它将使安装变的容易化,这就意味不用手工导入类库文件给一个特定类,调用已经设计好的JFactory类的方法可以自动导入正确的类库文件然后返回一个对象的指针.
方法:
Method
Description
getACL
返回一个指向JAuthorization对象的标识符
getCache
返回一个指向JCache对象的标识符
getConfig
返回一个指向JRegistry对象的标识符
getDBO
返回一个指向JDatabase对象的标识符
getDocument
返回一个指向JDocument对象的标识符
getEditor
如果已经安装了editor插件,得到一个editor的对象.
getLanguage
返回一个指向JLanguage对象的标识符
getMailer
返回一个指向JMail对象的标识符
getSession
返回一个指向JSession对象的标识符
getTemplate
返回一个指向JTemplate对象的标识符
getURI
返回一个指向JURI对象的标识符
getUser
返回一个指向JUser对象的标识符
getXMLParser
得到XML文件解析器
getApplication
返回一个指向JApplication对象的标识符
方法应用:
getAcl
意义:
这个方法返回JAuthorization对象的标识符，如果它不存在就创建一个。
语法:
objectJAuthorization&getACL（）
实际应用:
example1
Variablesarray$acl=null;
返回在当前访问控制列表里有多少个对象
（ACL权限控制系统）
$acl=&JFactory:
:
getACL（）;
echo“Thereare”.$acl->acl_count.“objectsintheacl.”;
结果:
输出当前访问控制列表里对象的个数.
Result:
Thereare101objectsintheacl
example2
MethodsintgetCheckMode（）;
得到检查方式
$check=&Jfactory:
:
getACL（）;
echo$check->getCheckMode（）;
结果:
得到当前的检查模式.
Result:
0
getCache
意义:
这个方法创建一个JCache子类对象,当方法被调用时候,一个合适的子类对象被实例化并且被返回,
语法:
objectJCache&getCache（$group,$handler）
$group是个包含存储包名称的字符串,这个参数是可选的,缺省是一个空字符串.
$handler是个包含存储类名称的字符串,参数是可选的,缺省是方法.
实际应用:
example1
Methodbooleanclean（[string$group=null],[string$mode='group']）
string$group:
Thecachedatagroup
string$mode:
Themodeforcleaningcache[group|notgroup]
以给定的方式清除缓存
$cache=&Jfactory:
:
getCache（）;
$cache->clean（）;
结果:
清空缓存.
example2
Variablesarray$_errors
以数组的形式返回错误信息
$cache=&Jfactory:
:
getCache（）;
$arr=$cache->_errors;
print_r（$arr）;
结果:
返回一组错误信息.
getApplication
意义:
返回全局性JApplication标识符，如果不存在就创建一个.
语法:
objectJApplication&getApplication（[mixed$id=null],[array$config=array（）],[$prefix='J']）
mixed$id:
Aclientidentifierorname.
array$config:
Anoptionalassociativearrayofconfigurationsettings.
$prefix
实际应用
example1
Variablesarray$_name=null
$application=&Jfactory:
:
getApplication（）;
$application->_name;
结果:
得到当前应用程序的程序名.
Result:
site
example2
MethodgetPageTitle（）
得到当前页面的标题
$title=&Jfactory:
:
getApplication（）;
echo$title->getPageTitle（）;
结果:
得到当前标题的名字.
Result:
Welcometothefontpage.
example3
MethodsetPageTitle（）
设置当前页面的标题
$settitle=&JFactory:
:
getApplication（）;
$settitle->setPageTitle（'welcome'）;
$settitle->getPapeTitle（）;
结果:
设置当前页面的标题.
Result:
welcome.
getConfig
意义:
返回全局性JRegistry对象标识符,如果不存在就创建一个.
语法:
objectJregistry&getConfig（[string$file=null],[string$type='PHP']）
string$file:
Thepathtotheconfigurationfile
string$type:
Thetypeoftheconfigurationfile
实际应用
example1
Variablesstring$_defaultNameSpace=null
DefaultNameSpace
$config=&Jfacytory:
:
getConfig（）;
$config->_defaultNameSpace;
echo$config;
结果:
缺省的NAMESPACE
Result:
config.
example2
Variablesarray$_registry=array（）
RegistryObject
$arr=&Jfactory:
:
getConfig（）;
$arr->_registry;
print_r（$arr）;
结果:
以数组的方式打印注册过的对像
Result:
Array（[config]=>Array（[data]=>stdClassObject（[dbtype]=>mysql[host]=>localhost[user]=>root[password]=>root[db]=>............
getDBO
意义:
返回一个指向JDatabase对象的标识符
语法:
objectjRegistry&getConfig（[string$file=null],[string='PHP']）
string$file:
Thepathtotheconfigurationfile.
string$type:
Thetypeoftheconfigurationfile.
实际应用:
example1
Variablesstring$name=''
Thedatabasedirvername.
$dbo=&Jfactory:
:
getDBO（）;
$db=$dbo->name;
echo$db;
结果:
数据库驱动的名字.
Result:
mysql.
example2
Methodbooleanconnected（）
确定当前数据库是否被激活.
$dbo=&Jfactoty:
:
getDBO（）;
$db=$dbo->connected（）;
echo$db;
结果:
返回当前的数据库是否连接成功.
Result:
1.
example3
Methodvoiddebug（int$level）
int$level:
0=off,1=on
设置debug的开关.
$debug=&Jfactory:
:
getDBO（）
$debug->debug
（1）
结果:
设置调试水平的开1关0.
getDocument
意义:
返回一个指向JDocument对象的标识符
语法:
objectJDocument&getDocument（）;
实际应用
example1
Variablesstring$language=en-gb''
Containsthedocumentlanguagesetting
$doc=&JFactory:
:
getDocument（）;
$do=$doc->language;
echo$do;
结果:
文件语言的设置.
Result:
en-gb.
example2
MethodstringgetCharset（）
Returnsthedocumentcharsetencoding.
$doc=&Jfactory:
:
getDocument（）;
$doc->getCharset（）;
echo$doc;
结果:
返回文档的字符集
Result:
utf-8.
example3
MethodstringgetDescription（）
Returnthetitleofthepage
$doc=&Jfactory:
:
getDocument（）;
$doc->getDescription（）;
echo$doc;
结果:
返回当前页面的标题.
Result:
Joomla!
-thedynamicportalengineandcontentmanagementsystem.
getEditor
意义:
如果已经安装了editor插件,得到一个editor的对象
语法:
objectJeditor&getEditor（[string$editor=null]）
string$editor:
Theeditortoload,dependsontheeditorpluginsthatareinstalled
实际应用
example1
Variablesstring$_name=null
EditorPluginname
$editor=&Jfactory:
:
getEditor（）;
$edr=$editor->_name;
echo$edr;
结果:
编辑器插件的名字.
Result:
tinymce.
example2
MethodvoidgetButtons（$editor,[mixed$buttons=true]）
mixed$buttons:
Canbebooleanorarray,ifbooleandefinesifthebuttonsaredisplayed,ifarraydefinesalistofbuttonsnottoshow.
$editor
$editor=&Jfactory:
:
getEditor（）;
$edr=$editor->getButtons（tinymce）;
print_r（$edr）;
结果:
得到编辑按钮.
Result:
Array（[0]=>JObjectObject（[_errors]=>Array（）[modal]=>1[link]=>index.php?
option=com_media&view=images&tmpl=component&e_name=tinymce[text]=>Image[name]=>image[options]=>{handler:
'iframe',size:
{x:
570,y:
400}}）[1]=>JObjectObject（[_errors]=>Array（）[modal]=>1[link]=>index.php?
option=com_content&task=ins_pagebreak&tmpl=component&e_name=tinymce[text]=>Pagebreak[name]=>pagebreak[options]=>{handler:
'iframe',size:
{x:
400,y:
85}}）[2]=>JObjectObject（[_errors]=>Array（）[modal]=>[onclick]=>insertReadmore（'tinymce'）;returnfalse;[text]=>Readmore[name]=>readmore[link]=>#））
getLanguage
意义:
返回一个指向JLanguage对象的标识符
语法:
objectJlanguage&getLanguage（）
实际应用
example1
Variablesarray$_paths=array（）
Listoflanguagefilesthathavebeenloaded.
$lan=&Jfactory:
:
getLanguage（）;
$language=$lan->_paths;
print_r（$language）;
结果:
列出被装载的语言文件.
Result:
Array（[joomla]=>Array（[/var/www/test/joomlaAPItest/language/en-GB/en-GB.ini]=>1）[plg_system_debug]=>Array（[/var/www/test/joomlaAPItest/language/en-GB/en-GB.plg_system_debug.ini]=>1）[com_content]=>Array（[/var/www/test/joomlaAPItest/language/en-GB/en-GB.com_content.ini]=>1）[tpl_rhuk_milkyway]=>Array（[/var/www/test/joomlaAPItest/language/en-GB/en-GB.tpl_rhuk_milkyway.ini]=>1））
example2
MethodstringgetLocale（）
Getlocaleproperty
$lan=&Jfactory:
:
getLanguage（）;
$language=$lan->getLocale（）;
print_r（$language）;
结果:
当前语言环境
Result:
Array（[0]=>en_GB.utf8[1]=>en_GB.UTF-8[2]=>en_GB[3]=>eng_GB[4]=>en[5]=>english[6]=>english-uk[7]=>uk[8]=>gbr[9]=>britain[10]=>england[11]=>greatbritain[12]=>uk[13]=>unitedkingdom[14]=>united-kingdom）
example3
MethodstringgetPdfFontName（）
return:
nameofpdffonttobeused.
$lan=&Jfactory:
:
getLanguage（）;
$language=$lan->getPdfFontName（）;
print_r（$language）;
结果:
返回pdf的字体的名字
Result:
freesans.
getMailer
意义:
返回一个指向JMail对象的标识符
语法:
objectJmail&getMailer（）
实际应用:
example1
InheritedVariables$FromName
SetstheFromnameofthemessage.
$mail=&Jfactory:
:
getMailer（）;
$ma=$mail->FromName;
echo$ma;
结果:
设置消息发出的名字
Result:
joomlaAPItest
example2
InheritedVariables$Version
HoldsPHPMailerversion.
$mail=&Jfactory:
:
getMailer（）;
$ma=$mail->Version;
echo$ma;
结果:
PHPMAIL的版本
Result:
1.73.
example3
MethodbooleanuseSendmail（[string$sendmail=null]）
Us
升级会员 