Jump to main content Jump to doc navigation

xPDOObject::encode

Encodes a value before it is stored. In xPDO 3.x only the password and md5 types are accepted, and both of them produce the same MD5 hash. Any other type logs an error and returns the source unchanged. A non-string or empty $source is also logged and returned as passed.

To use a stronger algorithm, override this method in your own xPDOObject derivative class.

Syntax

string encode (string $source, [string $type = 'md5'])
  • $source — the value to encode.
  • $type — the encoding type. Both password and md5 fall through to md5().

Example

$hash = $user->encode($plainPassword, 'password');

See Also

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

  • modmore
  • STERC
  • Digital Penguin
  • Jens Wittmann – Gestaltung & Entwicklung
  • CrewMark
  • Fabian Christen
  • Sepia River Studios
  • Dannevang Digital
  • Alex
  • A. Moreno
  • Chris Fickling
  • Stéphane Jäggi
  • Murray Wood
  • Anton Tarasov
  • JT Skaggs
  • deJaya
  • Lefthandmedia
  • eydolan
  • Following Sea
  • Guido Gallenkamp
  • YJ
  • Raffy
  • Snow Creative
  • Nick Clark
  • Guest
  • Helen
  • krisznet
  • Yanni
  • Richard

Budget

$194 per month—let's make that $500!

Learn more