Skip to content
Mo McRoberts edited this page Aug 7, 2011 · 1 revision

Return the canonical form of a UUID string (i.e., no braces, no dashes, all lower-case)

Synopsis

uses('uuid');

public static function string [[UUID]]::canonical(string [in] $uuid)

Description

UUID::canonical() accepts a string representation of a UUID (for example, as returned by [[UUID::generate]]()) and returns the canonical form of the UUID: that is, all-lowercase, and with any braces and dashes removed. For example, the canonical form of the UUID string ``} would be 'eae58635b82642a99b033a3ac8a2cc29'.

Example

Parameters

Name Direction Type Description
$uuid in string A string representation of a UUID.

Return Value

The canonical form of the UUID, or null if $uuid is not a valid UUID string.

Clone this wiki locally