Actions

API17

Difference between revisions of "JUtility"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
m (moving preparation)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
=={{JVer|11.1}} JUtility==
 +
===Description===
 +
{{Description:JUtility}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[Description:JUtility|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JUtility|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
{{Description:JUtility}}
 
===Defined in===
 
libraries/joomla/utilities/utility.php
 
===Subpackage===
 
[[Subpackage Utilities/11.1|Utilities]]
 
===Extends===
 
===Extended by===
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
|[[JUtility::array_unshift_ref/11.1|array_unshift_ref]]
+
|public
 +
|[[API17:JUtility::array_unshift_ref|array_unshift_ref]]
 
|Prepend a reference to an element to the beginning of an array.  
 
|Prepend a reference to an element to the beginning of an array.  
 
|-
 
|-
|[[JUtility::return_bytes/11.1|return_bytes]]
+
|public
 +
|[[API17:JUtility::return_bytes|return_bytes]]
 
|Return the byte value of a particular string.  
 
|Return the byte value of a particular string.  
 
|-
 
|-
|[[JUtility::dump/11.1|dump]]
+
|public static
 +
|[[API17:JUtility::dump|dump]]
 
|Method to dump the structure of a variable for debugging purposes.  
 
|Method to dump the structure of a variable for debugging purposes.  
 
|-
 
|-
|[[JUtility::getHash/11.1|getHash]]
+
|public static
 +
|[[API17:JUtility::getHash|getHash]]
 
|Provides a secure hash based on a seed.  
 
|Provides a secure hash based on a seed.  
 
|-
 
|-
|[[JUtility::getToken/11.1|getToken]]
+
|public static
 +
|[[API17:JUtility::getToken|getToken]]
 
|Method to determine a hash for anti-spoofing variable names.  
 
|Method to determine a hash for anti-spoofing variable names.  
 
|-
 
|-
|[[JUtility::isWinOS/11.1|isWinOS]]
+
|public static
 +
|[[API17:JUtility::isWinOS|isWinOS]]
 
|Method to determine if the host OS is Windows.  
 
|Method to determine if the host OS is Windows.  
 
|-
 
|-
|[[JUtility::parseAttributes/11.1|parseAttributes]]
+
|public static
 +
|[[API17:JUtility::parseAttributes|parseAttributes]]
 
|Method to extract key/value pairs out of a string with xml style attributes.  
 
|Method to extract key/value pairs out of a string with xml style attributes.  
 
|-
 
|-
|[[JUtility::sendAdminMail/11.1|sendAdminMail]]
+
|public static
 +
|[[API17:JUtility::sendAdminMail|sendAdminMail]]
 
|Sends mail to administrator for approval of a user submission.  
 
|Sends mail to administrator for approval of a user submission.  
 
|-
 
|-
|[[JUtility::sendMail/11.1|sendMail]]
+
|public static
 +
|[[API17:JUtility::sendMail|sendMail]]
 
|Mail function (uses phpMailer).  
 
|Mail function (uses phpMailer).  
 
|-
 
|-
 
|}
 
|}
 +
* '''Defined in''' libraries/joomla/utilities/utility.php
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.utilities.utility' );</source>
 
<source lang="php">jimport( 'joomla.utilities.utility' );</source>
 
===See also===
 
===See also===
* [[JUtility|Other versions of this class]]
+
* {{JVer|11.1}} '''JUtility source code''' on [[jplatform:utilities/utility.php|BitBucket]]
 +
* {{JVer|11.1}} Subpackage [[API17:Subpackage Utilities|Utilities]]
 +
* [[API17:JUtility|Other versions of JUtility]]
 
{{SeeAlso:JUtility}}
 
{{SeeAlso:JUtility}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JUtility|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JUtility|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Examples===
+
===User contributed notes===
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 60: Line 69:
 
category=ClassExample
 
category=ClassExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JUtility]]</noinclude>
+
<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

Latest revision as of 21:50, 11 May 2013

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 JUtility

Description

Description:JUtility [Edit Descripton]

Methods

Visibility Method name Description
public array_unshift_ref Prepend a reference to an element to the beginning of an array.
public return_bytes Return the byte value of a particular string.
public static dump Method to dump the structure of a variable for debugging purposes.
public static getHash Provides a secure hash based on a seed.
public static getToken Method to determine a hash for anti-spoofing variable names.
public static isWinOS Method to determine if the host OS is Windows.
public static parseAttributes Method to extract key/value pairs out of a string with xml style attributes.
public static sendAdminMail Sends mail to administrator for approval of a user submission.
public static sendMail Mail function (uses phpMailer).
  • Defined in libraries/joomla/utilities/utility.php

Importing

jimport( 'joomla.utilities.utility' );

See also

SeeAlso:JUtility [Edit See Also]

User contributed notes

<CodeExamplesForm />