Support Joomla!

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

Class JUtility

Description
Description | Methods (details)

JUtility is a utility functions class

  • since: 1.5

Located in /joomla/utilities/utility.php (line 26) 

Class JUtility   (Subpackage Utilities)
Method Summary
Description | Methods (details)
Static method static string dump (mixed &$var, [boolean $htmlSafe = true])
Static method static string getToken ([ $forceNew = false])
Static method static true isWinOS ()
Method string getHash (string $seed)
Method array parseAttributes (string $string)
Method boolean sendAdminMail (string $adminName, string $adminEmail, string $email, string $type, string $title, string $author, [ $url = null])
Method boolean sendMail (string $from, string $fromname, mixed $recipient, string $subject, string $body, [boolean $mode = 0], [mixed $cc = null], [mixed $bcc = null], [mixed $attachment = null], [mixed $replyto = null], [mixed $replytoname = null])
Methods
Description | Methods (details)
dump (line 177)

Method to dump the structure of a variable for debugging purposes

  • since: 1.5
string dump (mixed &$var, [boolean $htmlSafe = true])
  • mixed &$var: A variable
  • boolean $htmlSafe: True to ensure all characters are htmlsafe
getHash (line 109)

Provides a secure hash based on a seed

string getHash (string $seed)
  • string $seed: Seed string
getToken (line 122)

Method to determine a hash for anti-spoofing variable names

  • return: Hashed var name
  • since: 1.5
string getToken ([ $forceNew = false])
  • $forceNew
isWinOS (line 164)

Method to determine if the host OS is Windows

  • return: if Windows OS
  • since: 1.5
true isWinOS ()
parseAttributes (line 137)

Method to extract key/value pairs out of a string with xml style attributes

  • return: Key/Value pairs for the attributes
  • since: 1.5
array parseAttributes (string $string)
  • string $string: String containing xml style attributes
sendAdminMail (line 87)

Sends mail to administrator for approval of a user submission

  • return: True on success
boolean sendAdminMail (string $adminName, string $adminEmail, string $email, string $type, string $title, string $author, [ $url = null])
  • string $adminName: Name of administrator
  • string $adminEmail: Email address of administrator
  • string $email: [NOT USED TODO: Deprecate?]
  • string $type: Type of item to approve
  • string $title: Title of item to approve
  • string $author: Author of item to approve
  • $url
sendMail (line 44)

Mail function (uses phpMailer)

  • return: True on success
boolean sendMail (string $from, string $fromname, mixed $recipient, string $subject, string $body, boolean $mode, [mixed $cc = null], [mixed $bcc = null], [mixed $attachment = null], [mixed $replyto = null], [mixed $replytoname = null])
  • string $from: From e-mail address
  • string $fromname: From name
  • mixed $recipient: Recipient e-mail address(es)
  • string $subject: E-mail subject
  • string $body: Message body
  • boolean $mode: false = plain text, true = HTML
  • mixed $cc: CC e-mail address(es)
  • mixed $bcc: BCC e-mail address(es)
  • mixed $attachment: Attachment file name(s)
  • mixed $replyto: Reply to email address(es)
  • mixed $replytoname: Reply to name(s)
Documentation generated on Sat, 14 Nov 2009 11:23:04 +0000 by phpDocumentor 1.3.1