API17

Difference between revisions of "JUserHelper::getCryptedPassword"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
m (preparing for archive only)
 
(6 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
Formats a password using the current encryption.  
 
Formats a password using the current encryption.  
  
{{Description:JUserHelper::getCryptedPassword}}
+
 
<span class="editsection" style="font-size:76%;">
+
 
<nowiki>[</nowiki>[[Description:JUserHelper::getCryptedPassword|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public static JUserHelper::getCryptedPassword ($plaintext, $salt= '', $encryption= 'md5-hex', $show_encrypt=false)
+
public static function getCryptedPassword (
 +
        $plaintext
 +
        $salt= ''
 +
        $encryption= 'md5-hex'
 +
        $show_encrypt=false
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 40: Line 42:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' string The encrypted password.
string The encrypted password.
+
* '''Defined''' on line 296 of libraries/joomla/user/helper.php
===Defined in===
+
* '''Referenced by'''
libraries/joomla/user/helper.php
+
** [[API17:JUser::bind|JUser::bind]]
===Referenced by===
 
* [[JUser/bind/11.1|JUser::bind]]
 
 
===See also===
 
===See also===
<span class="editsection" style="font-size:76%;">
+
* {{JVer|11.1}} '''JUserHelper::getCryptedPassword source code''' on [[jplatform:user/helper.php#cl-288|BitBucket]]
<nowiki>[</nowiki>[[SeeAlso:JUserHelper::getCryptedPassword|Edit See Also]]<nowiki>]</nowiki>
+
* {{JVer|11.1}} Class [[API17:JUserHelper|JUserHelper]]
</span>
+
* {{JVer|11.1}} Subpackage [[API17:Subpackage_User|User]]
* [[JUserHelper/11.1|JUserHelper]]
+
* [[API17:JUserHelper::getCryptedPassword|Other versions of JUserHelper::getCryptedPassword]]
* [[JUserHelper::getCryptedPassword|Other versions of this method]]
+
 
{{SeeAlso:JUserHelper::getCryptedPassword}}
+
 
===Examples===
+
===User contributed notes===
<CodeExamplesForm />
+
=== Code Examples ===
 
<dpl>
 
<dpl>
 
noresultsheader=\n
 
noresultsheader=\n
 
category=JUserHelper::getCryptedPassword
 
category=JUserHelper::getCryptedPassword
category=CodeExample
+
namespace=CodeExample
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
<noinclude>[[Category:JUserHelper]][[Category:JUserHelper::getCryptedPassword]]</noinclude>
+
<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

Latest revision as of 21: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.

Joomla 11.1 JUserHelper::getCryptedPassword[edit]

Description[edit]

Formats a password using the current encryption.


public static function getCryptedPassword (
        $plaintext
        $salt= ''
        $encryption= 'md5-hex'
        $show_encrypt=false
)
Parameter Type Default Description
$plaintext string The plaintext password to encrypt.
$salt string The salt to use to encrypt the password. [] If not present, a new salt will be generated.
$encryption string 'md5-hex' The kind of pasword encryption to use. Defaults to md5-hex.
$show_encrypt boolean false Some password systems prepend the kind of encryption to the crypted password ({SHA}, etc). Defaults to false.
  • Returns string The encrypted password.
  • Defined on line 296 of libraries/joomla/user/helper.php
  • Referenced by

See also[edit]


User contributed notes[edit]

Code Examples[edit]