Docs for page joomla.php - Joomla

Procedural File: joomla.php

Classes

Class	Description
mosProfiler	Page generation time
mosAbstractLog
mosAbstractTasker	Task routing class
mosCache	Class to support function caching
mosMainFrame	Joomla! Mainframe class
mosComponent	Component database table class
mosHTML	Utility class for all HTML drawing classes
mosCategory	Category database table class
mosSection	Section database table class
mosContent	Module database table class
mosMenu	Module database table class
mosUser	Users Table Class
mosTemplate	Template Table Class
mosMambot	Class mosMambot
mosModule	Module database table class
mosSession	Session database table class
mosMambotHandler	Plugin handler
mosTabs	Tab Creation handler
mosAdminMenus	Common HTML Output Files
mosCommonHTML
patHTML	Utility class for helping with patTemplate

Includes

include ($basePath.'/../configuration.php') [line 83]

[ Top ]

include ($basePath.'/../offline.php') [line 84]

[ Top ]

require_once (dirname(__FILE__).'/compat.php41x.php') [line 54]

[ Top ]

require_once ($mosConfig_absolute_path.'/includes/version.php') [line 71]

[ Top ]

require_once ($mosConfig_absolute_path.'/includes/gacl.class.php') [line 73]

[ Top ]

require_once ($mosConfig_absolute_path.'/includes/database.php') [line 72]

[ Top ]

require_once (dirname(__FILE__).'/compat.php42x.php') [line 57]

[ Top ]

require_once (dirname(__FILE__).'/compat.php50x.php') [line 60]

[ Top ]

require_once ($mosConfig_absolute_path.'/includes/phpInputFilter/class.inputfilter.php') [line 77]

[ Top ]

require_once ($mosConfig_absolute_path.'/includes/phpmailer/class.phpmailer.php') [line 75]

[ Top ]

require_once ($mosConfig_absolute_path.'/includes/gacl_api.class.php') [line 74]

[ Top ]

require_once ($mosConfig_absolute_path.'/includes/joomla.xml.php') [line 76]

[ Top ]

Constants

_CURRENT_SERVER_TIME [line 104]

_CURRENT_SERVER_TIME = $now

[ Top ]

_CURRENT_SERVER_TIME_FORMAT [line 105]

_CURRENT_SERVER_TIME_FORMAT = '%Y-%m-%d %H:%M:%S'

[ Top ]

_JOS_SET_SQLMODE [line 114]

_JOS_SET_SQLMODE = 1

ensure that functions are declared only once

[ Top ]

_MOS_ALLOWHTML [line 3019]

_MOS_ALLOWHTML = 0x0002

[ Top ]

_MOS_ALLOWRAW [line 3020]

_MOS_ALLOWRAW = 0x0004

[ Top ]

_MOS_MAMBO_INCLUDED [line 16]

_MOS_MAMBO_INCLUDED = 1

API Tags:

Filesource:

Source Code for this file

Information Tags:

Version:	$Id: joomla.php 9997 2008-02-07 11:27:04Z eddieajau $
Copyright:	Copyright (C) 2005 Open Source Matters. All rights reserved.
License:	GNU/GPL, see LICENSE.php Joomla! is free software. This version may have been modified pursuant to the GNU General Public License, and as distributed it includes or is derivative of works licensed under the GNU General Public License or other free or open source software licenses. See COPYRIGHT.php for copyright notices and details.

[ Top ]

_MOS_NOTRIM [line 3018]

_MOS_NOTRIM = 0x0001

Utility function to return a value from a named array or a specified default

[ Top ]

_URL_SCHEMES [line 109]

_URL_SCHEMES = $url_schemes

[ Top ]

Globals

mosPlugin $_MAMBOTS [line 6151]

Default value: new mosMambotHandler()

[ Top ]

Functions

ampReplace [line 5775]

void ampReplace(
 $text 
)

Replaces & with & for xhtml compliance

Needed to handle unicode conflicts due to unicode conflicts

Parameters:

$text:

[ Top ]

doGzip [line 4117]

void doGzip(
)

Perform GZIP

[ Top ]

initGzip [line 4060]

void initGzip(
)

Initialise GZIP

[ Top ]

josGetArrayInts [line 5906]

void josGetArrayInts(
 $name, [ $type = NULL] 
)

Parameters:

	$name:
	$type:

[ Top ]

josHashPassword [line 6135]

string josHashPassword(
string $password 
)

A simple helper function to salt and hash a clear-text password.

Parameters:

string

$password:

A plain-text password

API Tags:

Return:

An md5 hashed password with salt

Information Tags:

Since:

1.0.13

[ Top ]

JosIsValidEmail [line 4026]

boolean JosIsValidEmail(
string $email 
)

Checks if a given string is a valid email address

Parameters:

string

$email:

String to check for a valid email address

[ Top ]

JosIsValidName [line 4040]

boolean JosIsValidName(
string $string 
)

Checks if a given string is a valid (from-)name or subject for an email

Parameters:

string

$string:

String to check for validity

API Tags:

Deprecated:

1.5

Information Tags:

Since:

1.0.11

[ Top ]

josSpoofCheck [line 6028]

void josSpoofCheck(
[ $header = NULL], [ $alt = NULL], [ $method = 'post'] 
)

Parameters:

	$header:
	$alt:
	$method:

[ Top ]

josSpoofValue [line 6108]

string josSpoofValue(
[ $alt = NULL] 
)

Method to determine a hash for anti-spoofing variable names

Parameters:

$alt:

API Tags:

Return:

Hashed var name

[ Top ]

mosArrayToInts [line 5886]

array mosArrayToInts(
array &$array, [int $default = null] 
)

Function to convert array to integer values

Parameters:

array	&$array:
int	$default:	A default value to assign if $array is not an array

[ Top ]

mosBackTrace [line 6016]

void mosBackTrace(
)

Format a backtrace error

Information Tags:

Since:

1.0.5

[ Top ]

mosBindArrayToObject [line 3094]

void mosBindArrayToObject(
array $array, obj &$obj, [string $ignore = ''], [boolean $prefix = NULL], [ $checkSlashes = true] 
)

Copy the named array content into the object as properties

only existing properties of object are filled. when undefined in hash, properties wont be deleted

Parameters:

array	$array:	the input array
obj	&$obj:	byref the object to fill of any class
string	$ignore:
boolean	$prefix:
	$checkSlashes:

[ Top ]

mosChmod [line 5867]

TRUE=all mosChmod(
path $path, filemode 1, dirmode 2 
)

Chmods files and directories recursively to mos global permissions. Available from 1.0.0 up.

Parameters:

filemode	1:	Integer value to chmod files. NULL = dont chmod files.
dirmode	2:	Integer value to chmod directories. NULL = dont chmod directories.
path	$path:	The starting file or directory (no trailing slash)

API Tags:

Return:

succeeded FALSE=one or more chmods failed

[ Top ]

mosChmodRecursive [line 5831]

TRUE=all mosChmodRecursive(
path $path, [filemode $filemode = NULL], [dirmode $dirmode = NULL] 
)

Chmods files and directories recursively to given permissions. Available from 1.0.0 up.

Parameters:

path	$path:	The starting file or directory (no trailing slash)
filemode	$filemode:	Integer value to chmod files. NULL = dont chmod files.
dirmode	$dirmode:	Integer value to chmod directories. NULL = dont chmod directories.

API Tags:

Return:

succeeded FALSE=one or more chmods failed

[ Top ]

mosCompressID [line 3847]

void mosCompressID(
 $ID 
)

Parameters:

$ID:

[ Top ]

mosCreateGUID [line 3839]

void mosCreateGUID(
)

[ Top ]

mosCreateMail [line 3863]

object Mail mosCreateMail(
[string $from = ''], [string $fromname = ''], string $subject, string $body 
)

Function to create a mail object for futher use (uses phpMailer)

Parameters:

string	$from:	From e-mail address
string	$fromname:	From name
string	$subject:	E-mail subject
string	$body:	Message body

API Tags:

Return:

object

[ Top ]

mosCurrentDate [line 3774]

current mosCurrentDate(
[string $format = &quot;&quot;] 
)

Returns current date according to current local and time offset

Parameters:

string

$format:

format optional format for strftime

API Tags:

Return:

date

[ Top ]

mosErrorAlert [line 3198]

void mosErrorAlert(
 $text, [ $action = 'window.history.go(-1);'], [ $mode = 1] 
)

Parameters:

	$text:
	$action:
	$mode:

[ Top ]

mosExpandID [line 3851]

void mosExpandID(
 $ID 
)

Parameters:

$ID:

[ Top ]

mosFormatDate [line 3753]

formated mosFormatDate(
string $date, [string $format = &quot;&quot;], [offset $offset = NULL] 
)

Returns formated date according to current local and adds time offset

Parameters:

string	$date:	date in datetime format
string	$format:	format optional format for strftime
offset	$offset:	time offset if different than global one

API Tags:

Return:

date

[ Top ]

mosGetBrowser [line 3582]

void mosGetBrowser(
 $agent 
)

Checks the user agent string against known browsers

Parameters:

$agent:

[ Top ]

mosGetOrderingList [line 3641]

void mosGetOrderingList(
string $sql, [integer $chop = '30'] 
)

Parameters:

string	$sql:	SQL with ordering As value and 'name field' AS text
integer	$chop:	The length of the truncated headline

[ Top ]

mosGetOS [line 3622]

void mosGetOS(
 $agent 
)

Checks the user agent string against known operating systems

Parameters:

$agent:

[ Top ]

mosGetParam [line 3021]

void mosGetParam(
 &$arr,  $name, [ $def = null], [ $mask = 0] 
)

Parameters:

	&$arr:
	$name:
	$def:
	$mask:

[ Top ]

mosHash [line 6008]

string mosHash(
string $seed 
)

Provides a secure hash based on a seed

Parameters:

string

$seed:

Seed string

[ Top ]

mosMail [line 3914]

boolean mosMail(
string $from, string $fromname, string/array $recipient, string $subject, string $body, [boolean $mode = 0], [string/array $cc = NULL], [string/array $bcc = NULL], [string/array $attachment = NULL], [string/array $replyto = NULL], [string/array $replytoname = NULL] 
)

Mail function (uses phpMailer)

Parameters:

string	$from:	From e-mail address
string	$fromname:	From name
string/array	$recipient:	Recipient e-mail address(es)
string	$subject:	E-mail subject
string	$body:	Message body
boolean	$mode:	false = plain text, true = HTML
string/array	$cc:	CC e-mail address(es)
string/array	$bcc:	BCC e-mail address(es)
string/array	$attachment:	Attachment file name(s)
string/array	$replyto:	ReplyTo e-mail address(es)
string/array	$replytoname:	ReplyTo name(s)

[ Top ]

mosMakeHtmlSafe [line 3681]

void mosMakeHtmlSafe(
object An &$mixed, [int $quote_style = ENT_QUOTES], [string|array $exclude_keys = ''] 
)

Makes a variable safe to display in forms

Object parameters that are non-string, array, object or start with underscore will be converted

Parameters:

object An	&$mixed:	object to be parsed
int	$quote_style:	The optional quote style for the htmlspecialchars function
string\|array	$exclude_keys:	An optional single field name or array of field names not to be parsed (eg, for a textarea)

[ Top ]

mosMakePassword [line 4145]

password mosMakePassword(
[ $length = 8] 
)

Random password generator

Parameters:

$length:

[ Top ]

mosMenuCheck [line 3705]

boolean mosMenuCheck(
int $Itemid, string $menu_option, int $task, database $gid 
)

Checks whether a menu option is within the users access level

Parameters:

int	$Itemid:	Item id number
string	$menu_option:	The menu option
int	$task:	The users group ID number
database	$gid:	A database connector object

API Tags:

Return:

True if the visitor's group at least equal to the menu access

[ Top ]

mosNotAuth [line 5761]

void mosNotAuth(
)

Displays a not authorised message

If the user is not logged in then an addition message is displayed.

[ Top ]

mosObjectToArray [line 3564]

void mosObjectToArray(
 $p_obj 
)

Parameters:

$p_obj:

[ Top ]

mosPathName [line 3256]

void mosPathName(
string $p_path, [boolean $p_addtrailingslash = true] 
)

Function to strip additional / or \ in a path name

Parameters:

string	$p_path:	The path
boolean	$p_addtrailingslash:	Add trailing slash

[ Top ]

mosPathWay [line 5749]

void mosPathWay(
)

[ Top ]

mosPrepareSearchContent [line 5792]

string mosPrepareSearchContent(
string $text, [int $length = 200], string $searchword 
)

Prepares results from search for display

Parameters:

string	$text:	The source string
int	$length:	Number of chars to trim
string	$searchword:	The searchword to select around

[ Top ]

mosReadDirectory [line 3125]

void mosReadDirectory(
string $path, [string $filter = '.'], [boolean $recurse = false], [boolean $fullpath = false] 
)

Utility function to read the files in a directory

Parameters:

string	$path:	The file system path
string	$filter:	A filter for the names
boolean	$recurse:	Recurse search into sub-directories
boolean	$fullpath:	True if to prepend the full path to the file name

[ Top ]

mosRedirect [line 3161]

void mosRedirect(
string $url, [string $msg = ''] 
)

Utility function redirect the browser location to another url

Can optionally provide a message.

Parameters:

string	$url:	The file system path
string	$msg:	A filter for the names

[ Top ]

mosSendAdminMail [line 5736]

void mosSendAdminMail(
 $adminName,  $adminEmail,  $email,  $type,  $title,  $author 
)

Sends mail to admin

Parameters:

	$adminName:
	$adminEmail:
	$email:
	$type:
	$title:
	$author:

[ Top ]

mosSmartSubstr [line 5814]

string mosSmartSubstr(
string $text, [int $length = 200], string $searchword 
)

returns substring of characters around a searchword

Parameters:

string	$text:	The source string
int	$length:	Number of chars to return
string	$searchword:	The searchword to select around

[ Top ]

mosStripslashes [line 3069]

mixed mosStripslashes(
mixed &$value 
)

Strip slashes from strings or arrays of strings

Parameters:

mixed

&$value:

The input string or array

API Tags:

Return:

String or array stripped of slashes

[ Top ]

mosToolTip [line 3789]

HTML mosToolTip(
string $tooltip, [string $title = ''], [ $width = ''], [ $image = 'tooltip.png'], [ $text = ''], [ $href = '#'], [ $link = 1] 
)

Utility function to provide ToolTips

Parameters:

string	$tooltip:	ToolTip text
string	$title:	Box title
	$width:
	$image:
	$text:
	$href:
	$link:

API Tags:

Return:

code for ToolTip

[ Top ]

mosTreeRecurse [line 3221]

void mosTreeRecurse(
 $id,  $indent,  $list,  &$children, [ $maxlevel = 9999], [ $level = 0], [ $type = 1] 
)

Parameters:

	$id:
	$indent:
	$list:
	&$children:
	$maxlevel:
	$level:
	$type:

[ Top ]

mosWarning [line 3827]

HTML mosWarning(
string $warning, [string $title = 'Joomla! Warning'] 
)

Utility function to provide Warning Icons

Parameters:

string	$warning:	Warning text
string	$title:	Box title

API Tags:

Return:

code for Warning

[ Top ]

SortArrayObjects [line 5720]

void SortArrayObjects(
 &$a,  $k, [ $sort_direction = 1] 
)

Sorts an Array of objects

sort_direction [1 = Ascending] [-1 = Descending]

Parameters:

	&$a:
	$k:
	$sort_direction:

[ Top ]

SortArrayObjects_cmp [line 5702]

void SortArrayObjects_cmp(
 &$a,  &$b 
)

Sorts an Array of objects

Parameters:

	&$a:
	&$b:

[ Top ]

_josSpoofCheck [line 6083]

void _josSpoofCheck(
 $array,  $badStrings 
)

Parameters:

	$array:
	$badStrings:

[ Top ]

The site fititnt.org is not affiliated with or endorsed by the Joomla! Project or Open Source Matters. If you are looking for official documentation, visit api.joomla.org and docs.joomla.org.

Documentation generated on Mon, 26 Oct 2009 22:53:36 -0200 by phpDocumentor 1.4.3

Visit fititnt.org, and look for some extension or more Joomla Framework info	Joomla

[ class tree: Joomla ] [ index: Joomla ] [ all elements ]