API17:JUtility
From Joomla! Documentation
(Difference between revisions)
(Layout updates) |
m (→User contributed notes: bad link repair) |
||
| (One intermediate revision by one user 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> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public | ||
|[[JUtility::array_unshift_ref/11.1|array_unshift_ref]] | |[[JUtility::array_unshift_ref/11.1|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 | ||
|[[JUtility::return_bytes/11.1|return_bytes]] | |[[JUtility::return_bytes/11.1|return_bytes]] | ||
|Return the byte value of a particular string. | |Return the byte value of a particular string. | ||
|- | |- | ||
| + | |public static | ||
|[[JUtility::dump/11.1|dump]] | |[[JUtility::dump/11.1|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 | ||
|[[JUtility::getHash/11.1|getHash]] | |[[JUtility::getHash/11.1|getHash]] | ||
|Provides a secure hash based on a seed. | |Provides a secure hash based on a seed. | ||
|- | |- | ||
| + | |public static | ||
|[[JUtility::getToken/11.1|getToken]] | |[[JUtility::getToken/11.1|getToken]] | ||
|Method to determine a hash for anti-spoofing variable names. | |Method to determine a hash for anti-spoofing variable names. | ||
|- | |- | ||
| + | |public static | ||
|[[JUtility::isWinOS/11.1|isWinOS]] | |[[JUtility::isWinOS/11.1|isWinOS]] | ||
|Method to determine if the host OS is Windows. | |Method to determine if the host OS is Windows. | ||
|- | |- | ||
| + | |public static | ||
|[[JUtility::parseAttributes/11.1|parseAttributes]] | |[[JUtility::parseAttributes/11.1|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 | ||
|[[JUtility::sendAdminMail/11.1|sendAdminMail]] | |[[JUtility::sendAdminMail/11.1|sendAdminMail]] | ||
|Sends mail to administrator for approval of a user submission. | |Sends mail to administrator for approval of a user submission. | ||
|- | |- | ||
| + | |public static | ||
|[[JUtility::sendMail/11.1|sendMail]] | |[[JUtility::sendMail/11.1|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 source code | + | * {{JVer|11.1}} '''JUtility source code''' on [[jplatform:utilities/utility.php|BitBucket]] |
| − | * [[JUtility|Other versions of | + | * {{JVer|11.1}} Subpackage [[Subpackage Utilities/11.1|Utilities]] |
| + | * [[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> | ||
| − | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 62: | 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 JClasses]][[Category:Platform 11.1]][[Category:JUtility]]</noinclude> |
Revision as of 14:07, 29 August 2012
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
- JUtility source code on BitBucket
- Subpackage Utilities
- Other versions of JUtility
SeeAlso:JUtility [Edit See Also]
User contributed notes
<CodeExamplesForm />
