Add docblocks for classes and interfaces in Ramsey\Uuid\Converter namespace

This commit is contained in:
Ben Ramsey
2015-09-26 18:06:02 -05:00
parent 77a34348d5
commit dc26d4addb
7 changed files with 115 additions and 12 deletions
+8 -3
View File
@@ -14,15 +14,20 @@
namespace Ramsey\Uuid\Converter;
/**
* TimeConverterInterface provides facilities for converting parts of time into
* representations that may be used in UUIDs
*/
interface TimeConverterInterface
{
/**
* Calculates low, mid, high time array.
* Uses the provided seconds and micro-seconds to calculate the time_low,
* time_mid, and time_high fields used by RFC 4122 version 1 UUIDs
*
* @param string $seconds
* @param string $microSeconds
* @return string[] An array guaranteed to contain 'low', 'mid', and 'high' keys.
* @return string[] An array guaranteed to contain `low`, `mid`, and `high` keys
* @link http://tools.ietf.org/html/rfc4122#section-4.2.2
*/
public function calculateTime($seconds, $microSeconds);
}