[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/joomla/utilities/ -> utility.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id: utility.php 14401 2010-01-26 14:10:00Z louis $
File Size: 182 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

JUtility:: (7 methods):
  sendMail()
  sendAdminMail()
  getHash()
  getToken()
  parseAttributes()
  isWinOS()
  dump()


Class: JUtility  - X-Ref

JUtility is a utility functions class

sendMail($from, $fromname, $recipient, $subject, $body, $mode=0, $cc=null, $bcc=null, $attachment=null, $replyto=null, $replytoname=null )   X-Ref
Mail function (uses phpMailer)

param: string $from From e-mail address
param: string $fromname From name
param: mixed $recipient Recipient e-mail address(es)
param: string $subject E-mail subject
param: string $body Message body
param: boolean $mode false = plain text, true = HTML
param: mixed $cc CC e-mail address(es)
param: mixed $bcc BCC e-mail address(es)
param: mixed $attachment Attachment file name(s)
param: mixed $replyto Reply to email address(es)
param: mixed $replytoname Reply to name(s)
return: boolean True on success

sendAdminMail( $adminName, $adminEmail, $email, $type, $title, $author, $url = null )   X-Ref
Sends mail to administrator for approval of a user submission

param: string $adminName Name of administrator
param: string $adminEmail Email address of administrator
param: string $email [NOT USED TODO: Deprecate?]
param: string $type Type of item to approve
param: string $title Title of item to approve
param: string $author Author of item to approve
return: boolean True on success

getHash( $seed )   X-Ref
Provides a secure hash based on a seed

param: string Seed string
return: string

getToken($forceNew = false)   X-Ref
Method to determine a hash for anti-spoofing variable names

return: string    Hashed var name

parseAttributes( $string )   X-Ref
Method to extract key/value pairs out of a string with xml style attributes

param: string    $string    String containing xml style attributes
return: array    Key/Value pairs for the attributes

isWinOS()   X-Ref
Method to determine if the host OS is  Windows

return: true if Windows OS

dump( &$var, $htmlSafe = true )   X-Ref
Method to dump the structure of a variable for debugging purposes

param: mixed    A variable
param: boolean    True to ensure all characters are htmlsafe
return: string



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1