Difference between revisions of "JUtility"
From Joomla! Documentation
m (→User contributed notes: bad link repair) |
m (preparing for archive only) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
=={{JVer|11.1}} JUtility== | =={{JVer|11.1}} JUtility== | ||
===Description=== | ===Description=== | ||
| − | + | ||
| − | + | ||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
| Line 14: | Line 12: | ||
|- | |- | ||
|public | |public | ||
| − | |[[JUtility::array_unshift_ref | + | |[[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. | ||
|- | |- | ||
|public | |public | ||
| − | |[[JUtility::return_bytes | + | |[[API17:JUtility::return_bytes|return_bytes]] |
|Return the byte value of a particular string. | |Return the byte value of a particular string. | ||
|- | |- | ||
|public static | |public static | ||
| − | |[[JUtility::dump | + | |[[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. | ||
|- | |- | ||
|public static | |public static | ||
| − | |[[JUtility::getHash | + | |[[API17:JUtility::getHash|getHash]] |
|Provides a secure hash based on a seed. | |Provides a secure hash based on a seed. | ||
|- | |- | ||
|public static | |public static | ||
| − | |[[JUtility::getToken | + | |[[API17:JUtility::getToken|getToken]] |
|Method to determine a hash for anti-spoofing variable names. | |Method to determine a hash for anti-spoofing variable names. | ||
|- | |- | ||
|public static | |public static | ||
| − | |[[JUtility::isWinOS | + | |[[API17:JUtility::isWinOS|isWinOS]] |
|Method to determine if the host OS is Windows. | |Method to determine if the host OS is Windows. | ||
|- | |- | ||
|public static | |public static | ||
| − | |[[JUtility::parseAttributes | + | |[[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. | ||
|- | |- | ||
|public static | |public static | ||
| − | |[[JUtility::sendAdminMail | + | |[[API17:JUtility::sendAdminMail|sendAdminMail]] |
|Sends mail to administrator for approval of a user submission. | |Sends mail to administrator for approval of a user submission. | ||
|- | |- | ||
|public static | |public static | ||
| − | |[[JUtility::sendMail | + | |[[API17:JUtility::sendMail|sendMail]] |
|Mail function (uses phpMailer). | |Mail function (uses phpMailer). | ||
|- | |- | ||
| Line 55: | Line 53: | ||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JUtility source code''' on [[jplatform:utilities/utility.php|BitBucket]] | * {{JVer|11.1}} '''JUtility source code''' on [[jplatform:utilities/utility.php|BitBucket]] | ||
| − | * {{JVer|11.1}} Subpackage [[Subpackage Utilities | + | * {{JVer|11.1}} Subpackage [[API17:Subpackage Utilities|Utilities]] |
| − | * [[JUtility|Other versions of JUtility]] | + | * [[API17:JUtility|Other versions of JUtility]] |
| − | + | ||
| − | + | ||
| − | |||
| − | |||
===User contributed notes=== | ===User contributed notes=== | ||
| − | + | === Code Examples === | |
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JUtility | category=JUtility | ||
| − | + | namespace=CodeExample | |
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| Line 72: | Line 68: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
| − | <noinclude> | + | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> |
Latest revision as of 22:56, 24 March 2017
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JUtility[edit]
Description[edit]
Methods[edit]
| 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[edit]
jimport( 'joomla.utilities.utility' );See also[edit]
- JUtility source code on BitBucket
- Subpackage Utilities
- Other versions of JUtility
User contributed notes[edit]
Code Examples[edit]