Overview
  • Namespace
  • Class

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CDN
      • Resource
    • CloudMonitoring
      • Collection
      • Exception
      • Resource
    • Common
      • Collection
      • Constants
      • Exceptions
      • Http
        • Message
      • Log
      • Resource
      • Service
    • Compute
      • Constants
      • Exception
      • Resource
    • Database
      • Resource
    • DNS
      • Collection
      • Resource
    • Identity
      • Constants
      • Resource
    • Image
      • Enum
      • Resource
        • JsonPatch
        • Schema
    • LoadBalancer
      • Collection
      • Enum
      • Resource
    • Networking
      • Resource
    • ObjectStore
      • Constants
      • Enum
      • Exception
      • Resource
      • Upload
    • Orchestration
      • Resource
    • Queues
      • Collection
      • Exception
      • Resource
    • Volume
      • Resource

Classes

  • AbstractSchemaItem
  • Property
  • Schema

Class Schema

Class that represents a JSON schema document

OpenCloud\Image\Resource\Schema\AbstractSchemaItem
Extended by OpenCloud\Image\Resource\Schema\Schema
Namespace: OpenCloud\Image\Resource\Schema
Package: OpenCloud\Images\Resource\Schema
Located at OpenCloud/Image/Resource/Schema/Schema.php

Methods summary

public static OpenCloud\Image\Resource\Schema\Schema
# factory( array $data )

Parameters

$data

Returns

OpenCloud\Image\Resource\Schema\Schema
public
# setName( string $name )

Parameters

$name
public string
# getName( )

Returns

string
public
# setProperties( array $properties )

Parameters

$properties
public array
# getProperties( )

Returns

array
public
# setAdditionalProperties( array $properties )

Parameters

$properties
public boolean|OpenCloud\Image\Resource\Schema\Property
# getAdditionalProperties( )

Returns

boolean|OpenCloud\Image\Resource\Schema\Property
public
# setLinks( array $links )

Parameters

$links
public array
# getLinks( )

Returns

array
public boolean
# propertyExists( $property )

Check whether a property exists

Check whether a property exists

Parameters

$property
name of the property

Returns

boolean
public null|OpenCloud\Image\Resource\Schema\Property
# getProperty( $property )

Retrieve a property

Retrieve a property

Parameters

$property
name of the property

Returns

null|OpenCloud\Image\Resource\Schema\Property
public string
# decideOperationType( OpenCloud\Image\Resource\Schema\Property $property )

Based on this schema, decide the most appropriate operation type for a given property

Based on this schema, decide the most appropriate operation type for a given property

Parameters

$property
The property being performed on

Returns

string
public boolean|OpenCloud\Image\Resource\Schema\Property
# validateAdditionalProperty( $value )

Check whether an additional property is allowed and its type is valid

Check whether an additional property is allowed and its type is valid

Parameters

$value
value trying to be set

Returns

boolean|OpenCloud\Image\Resource\Schema\Property
API documentation generated by ApiGen