Overview

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
  • PHP

Classes

  • AbstractSchemaItem
  • Property
  • Schema
  • Overview
  • Namespace
  • Class
  • Tree

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
Schema
public
# setName( string $name )

Parameters

$name
public string
# getName( )

Returns

string
string
public
# setProperties( array $properties )

Parameters

$properties
public array
# getProperties( )

Returns

array
array
public
# setAdditionalProperties( array $properties )

Parameters

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

Returns

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

Parameters

$links
public array
# getLinks( )

Returns

array
array
public boolean
# propertyExists( mixed $property )

Check whether a property exists

Check whether a property exists

Parameters

$property
name of the property

Returns

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

Retrieve a property

Retrieve a property

Parameters

$property
name of the property

Returns

null|OpenCloud\Image\Resource\Schema\Property
null|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
string
public boolean|OpenCloud\Image\Resource\Schema\Property
# validateAdditionalProperty( mixed $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
bool|Property
Methods inherited from OpenCloud\Image\Resource\Schema\AbstractSchemaItem
stockProperty()
Properties summary
protected string $name

Name of schema

Name of schema

#
protected array $properties

Properties that this schema possesses

Properties that this schema possesses

#
protected null|OpenCloud\Image\Resource\Schema\Property $additionalProperties

If set, this determines the template that all additional (i.e. undefined) properties must adhere to

If set, this determines the template that all additional (i.e. undefined) properties must adhere to

#
protected array $links

Links for this schema

Links for this schema

#
API documentation generated by ApiGen 2.8.0