AWS SDK for PHP
  • Namespace
  • Class
  • Tree
  • Download

Namespaces

  • Aws
    • AutoScaling
      • Enum
      • Exception
    • CloudFormation
      • Enum
      • Exception
    • CloudFront
      • Enum
      • Exception
    • CloudFront_2012_05_05
    • CloudHsm
      • Exception
    • CloudSearch
      • Enum
      • Exception
    • CloudSearch_2011_02_01
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Enum
      • Exception
    • CloudWatchLogs
      • Exception
    • CodeCommit
      • Exception
    • CodeDeploy
      • Exception
    • CodePipeline
      • Exception
    • CognitoIdentity
      • Exception
    • CognitoSync
      • Exception
    • Common
      • Client
      • Command
      • Credentials
      • Enum
      • Exception
        • Parser
      • Hash
      • InstanceMetadata
        • Waiter
      • Iterator
      • Model
        • MultipartUpload
      • Signature
      • Waiter
    • ConfigService
      • Exception
    • DataPipeline
      • Enum
      • Exception
    • DeviceFarm
      • Exception
    • DirectConnect
      • Enum
      • Exception
    • DirectoryService
      • Exception
    • DynamoDb
      • Enum
      • Exception
      • Model
        • BatchRequest
      • Session
        • LockingStrategy
    • DynamoDb_2011_12_05
    • DynamoDbStreams
      • Exception
    • Ec2
      • Enum
      • Exception
      • Iterator
    • Ecs
      • Exception
    • Efs
      • Exception
    • ElastiCache
      • Enum
      • Exception
    • ElasticBeanstalk
      • Enum
      • Exception
    • ElasticFileSystem
    • ElasticLoadBalancing
      • Exception
    • ElasticTranscoder
      • Exception
    • Emr
      • Enum
      • Exception
    • Glacier
      • Enum
      • Exception
      • Model
        • MultipartUpload
    • Iam
      • Enum
      • Exception
    • ImportExport
      • Enum
      • Exception
    • Kinesis
      • Enum
      • Exception
    • Kms
      • Exception
    • Lambda
      • Exception
    • MachineLearning
      • Exception
    • OpsWorks
      • Enum
      • Exception
    • Rds
      • Enum
      • Exception
    • Redshift
      • Enum
      • Exception
    • Route53
      • Enum
      • Exception
    • Route53Domains
      • Exception
    • S3
      • Command
      • Enum
      • Exception
        • Parser
      • Iterator
      • Model
        • MultipartUpload
      • Sync
    • Ses
      • Enum
      • Exception
    • SimpleDb
      • Exception
    • Sns
      • Exception
      • MessageValidator
        • Exception
    • Sqs
      • Enum
      • Exception
    • Ssm
      • Exception
    • StorageGateway
      • Enum
      • Exception
    • Sts
      • Exception
    • Support
      • Exception
    • Swf
      • Enum
      • Exception
    • WorkSpaces
      • Exception
  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
        • Header
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
  • PHP

Classes

  • Operation
  • Parameter
  • SchemaFormatter
  • SchemaValidator
  • ServiceDescription
  • ServiceDescriptionLoader

Interfaces

  • OperationInterface
  • ServiceDescriptionInterface
  • ValidatorInterface
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
#
AWS SDK for PHP API documentation generated by ApiGen 2.8.0