NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

# Class SchemaFormatter

JSON Schema formatter class

Namespace: Guzzle\Service\Description
Located at Guzzle/Service/Description/SchemaFormatter.php

## Methods summary

- `public static` `format ( string $format, mixed $value )`

  Format a value by a registered format name

- `public static` `formatDateTime ( string|integer|\DateTime $value )`

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

- `public static` `formatDateTimeHttp ( string|integer|\DateTime $value )`

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

- `public static` `formatDate ( string|integer|\DateTime $value )`

  Create a YYYY-MM-DD formatted string

- `public static` `formatTime ( string|integer|\DateTime $value )`

  Create a hh:mm:ss formatted string

- `public static` `formatBooleanAsString ( string|integer|bool $value )`

  Formats a boolean value as a string

- `public static` `formatTimestamp ( string|integer|\DateTime $value )`

  Return a UNIX timestamp in the UTC timezone

- `protected static` `getUtcTimeZone ( )`

  Get a UTC DateTimeZone object

- `protected static` `dateFormatter ( int|string|\DateTime $dateTime, string $format )`

  Perform the actual DateTime formatting

## Methods detail

# `public static mixed`
`format( string $format, mixed $value )`

Format a value by a registered format name

#### Parameters

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

#### Returns

`mixed`
# `public static string`
`formatDateTime( string|integer|`DateTime` $value )`

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

#### Parameters

$value
  `string|integer|`DateTime``
  $value Date time value

#### Returns

`string`
# `public static string`
`formatDateTimeHttp( string|integer|`DateTime` $value )`

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

#### Parameters

$value
  `string|integer|`DateTime``
  $value Date time value

#### Returns

`string`
# `public static string`
`formatDate( string|integer|`DateTime` $value )`

Create a YYYY-MM-DD formatted string

#### Parameters

$value
  `string|integer|`DateTime``
  $value Date time value

#### Returns

`string`
# `public static string`
`formatTime( string|integer|`DateTime` $value )`

Create a hh:mm:ss formatted string

#### Parameters

$value
  `string|integer|`DateTime``
  $value Date time value

#### Returns

`string`
# `public static string`
`formatBooleanAsString( string|integer|boolean $value )`

Formats a boolean value as a string

#### Parameters

$value
  `string|integer|boolean`
  $value Value to convert to a boolean 'true' / 'false' value

#### Returns

`string`
# `public static integer`
`formatTimestamp( string|integer|`DateTime` $value )`

Return a UNIX timestamp in the UTC timezone

#### Parameters

$value
  `string|integer|`DateTime``
  $value Time value

#### Returns

`integer`
# `protected static `DateTimeZone``
`getUtcTimeZone( )`

Get a UTC DateTimeZone object

#### Returns

``DateTimeZone``
# `protected static string`
`dateFormatter( integer|string|`DateTime` $dateTime, string $format )`

Perform the actual DateTime formatting

#### Parameters

$dateTime
  `integer|string|`DateTime``
  $dateTime Date time value
$format
  `string`
  $format Format of the result

#### Returns

`string`

#### Throws

``Guzzle\Common\Exception\InvalidArgumentException``

### Magic methods summary

## Properties summary

`protected static `DateTimeZone`` | $utcTimeZone | #