Updating docblock with explanation of why it's good to sort UUIDs

This commit is contained in:
Ben Ramsey
2013-07-26 17:31:25 -05:00
parent 5c011f467e
commit a0ab45f7dd
+3
View File
@@ -164,6 +164,9 @@ final class Uuid
* significant field in which the UUIDs differ is greater for the first
* UUID.
*
* Q. What's the value of being able to sort UUIDs?
* A. Use them as keys in a B-Tree or similar mapping.
*
* @param Uuid $uuid UUID to which this UUID is to be compared
* @return int -1, 0 or 1 as this UUID is less than, equal to, or greater than $uuid
*/