Update doc blocks for all app/

This commit is contained in:
Dane Everitt 2017-03-19 19:36:50 -04:00
parent 5e27772fef
commit 0312c974f5
No known key found for this signature in database
GPG key ID: EEA66103B3D71F53
114 changed files with 1360 additions and 949 deletions

View file

@ -29,21 +29,13 @@ use Uuid;
class UuidService
{
/**
* Constructor.
*/
public function __construct()
{
//
}
/**
* Generate a unique UUID validating against specified table and column.
* Defaults to `users.uuid`.
*
* @param string $table
* @param string $field
* @param int $type The type of UUID to generate.
* @param string $table
* @param string $field
* @param int $type
* @return string
*/
public function generate($table = 'users', $field = 'uuid', $type = 4)
@ -62,8 +54,9 @@ class UuidService
/**
* Generates a ShortUUID code which is 8 characters long and is used for identifying servers in the system.
*
* @param string $table
* @param string $field
* @param string $table
* @param string $field
* @param null|string $attachedUuid
* @return string
*/
public function generateShort($table = 'servers', $field = 'uuidShort', $attachedUuid = null)