Guzzle\Service\Description\SchemaFormatter Class Reference

Static Public Member Functions
static	format ($format, $value)
static	formatBooleanAsString ($value)
static	formatDate ($value)
static	formatDateTime ($value)
static	formatDateTimeHttp ($value)
static	formatTime ($value)
static	formatTimestamp ($value)

Static Protected Member Functions
static	dateFormatter ($dateTime, $format)
static	getUtcTimeZone ()

Static Protected Attributes
static	$utcTimeZone

Detailed Description

JSON Schema formatter class

Definition at line 10 of file SchemaFormatter.php.

Member Function Documentation

dateFormatter()

static Guzzle\Service\Description\SchemaFormatter::dateFormatter (   $dateTime,   $format  )

staticprotected

Perform the actual DateTime formatting

Parameters

int | string | \DateTime	$dateTime	Date time value
string	$format	Format of the result

Returns

string

Exceptions

InvalidArgumentException

Definition at line 140 of file SchemaFormatter.php.

Referenced by Guzzle\Service\Description\SchemaFormatter\formatDate(), Guzzle\Service\Description\SchemaFormatter\formatDateTime(), Guzzle\Service\Description\SchemaFormatter\formatDateTimeHttp(), Guzzle\Service\Description\SchemaFormatter\formatTime(), and Guzzle\Service\Description\SchemaFormatter\formatTimestamp().

format()

static Guzzle\Service\Description\SchemaFormatter::format (   $format,   $value  )

static

Format a value by a registered format name

Parameters

string	$format	Registered format used to format the value
mixed	$value	Value being formatted

Returns

mixed

Definition at line 23 of file SchemaFormatter.php.

References Guzzle\Service\Description\SchemaFormatter\formatBooleanAsString(), Guzzle\Service\Description\SchemaFormatter\formatDate(), Guzzle\Service\Description\SchemaFormatter\formatDateTime(), Guzzle\Service\Description\SchemaFormatter\formatDateTimeHttp(), Guzzle\Service\Description\SchemaFormatter\formatTime(), and Guzzle\Service\Description\SchemaFormatter\formatTimestamp().

Referenced by Guzzle\Service\Description\Parameter\filter(), Guzzle\Tests\Service\Description\SchemaFormatterTest\testEnsuresTimestampsAreIntegers(), Guzzle\Tests\Service\Description\SchemaFormatterTest\testFilters(), and Guzzle\Tests\Service\Description\SchemaFormatterTest\testValidatesDateTimeInput().

formatBooleanAsString()

static Guzzle\Service\Description\SchemaFormatter::formatBooleanAsString (   $value )

static

Formats a boolean value as a string

Parameters

string | integer | bool

$value

Value to convert to a boolean 'true' / 'false' value

Returns

string

Definition at line 98 of file SchemaFormatter.php.

Referenced by Guzzle\Service\Description\SchemaFormatter\format().

formatDate()

static Guzzle\Service\Description\SchemaFormatter::formatDate (   $value )

static

Create a YYYY-MM-DD formatted string

Parameters

string | integer | \DateTime

$value

Date time value

Returns

string

Definition at line 74 of file SchemaFormatter.php.

References Guzzle\Service\Description\SchemaFormatter\dateFormatter().

Referenced by Guzzle\Service\Description\SchemaFormatter\format().

formatDateTime()

static Guzzle\Service\Description\SchemaFormatter::formatDateTime (   $value )

static

Create a ISO 8601 (YYYY-MM-DDThh:mm:ssZ) formatted date time value in UTC time

Parameters

string | integer | \DateTime

$value

Date time value

Returns

string

Definition at line 50 of file SchemaFormatter.php.

References Guzzle\Service\Description\SchemaFormatter\dateFormatter().

Referenced by Guzzle\Service\Description\SchemaFormatter\format().

formatDateTimeHttp()

static Guzzle\Service\Description\SchemaFormatter::formatDateTimeHttp (   $value )

static

Create an HTTP date (RFC 1123 / RFC 822) formatted UTC date-time string

Parameters

string | integer | \DateTime

$value

Date time value

Returns

string

Definition at line 62 of file SchemaFormatter.php.

References Guzzle\Service\Description\SchemaFormatter\dateFormatter().

Referenced by Guzzle\Service\Description\SchemaFormatter\format().

formatTime()

static Guzzle\Service\Description\SchemaFormatter::formatTime (   $value )

static

Create a hh:mm:ss formatted string

Parameters

string | integer | \DateTime

$value

Date time value

Returns

string

Definition at line 86 of file SchemaFormatter.php.

References Guzzle\Service\Description\SchemaFormatter\dateFormatter().

Referenced by Guzzle\Service\Description\SchemaFormatter\format().

formatTimestamp()

static Guzzle\Service\Description\SchemaFormatter::formatTimestamp (   $value )

static

Return a UNIX timestamp in the UTC timezone

Parameters

string | integer | \DateTime

$value

Time value

Returns

int

Definition at line 110 of file SchemaFormatter.php.

References Guzzle\Service\Description\SchemaFormatter\dateFormatter().

Referenced by Guzzle\Service\Description\SchemaFormatter\format().

getUtcTimeZone()

static Guzzle\Service\Description\SchemaFormatter::getUtcTimeZone ( )

staticprotected

Get a UTC DateTimeZone object

Returns

\DateTimeZone

Definition at line 120 of file SchemaFormatter.php.

References Guzzle\Service\Description\SchemaFormatter\$utcTimeZone.

Field Documentation

$utcTimeZone

Guzzle\Service\Description\SchemaFormatter::$utcTimeZone

staticprotected

Definition at line 13 of file SchemaFormatter.php.

Referenced by Guzzle\Service\Description\SchemaFormatter\getUtcTimeZone().

---

The documentation for this class was generated from the following file:

• SchemaFormatter.php