Overview

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • 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
      • Enum
      • Resource
    • ObjectStore
      • Constants
      • Exception
      • Resource
      • Upload
    • Orchestration
    • Queues
      • Exception
      • Resource
    • Volume
      • Resource
  • PHP

Classes

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

Class Property

Class that represents an individual property in a JSON schema

OpenCloud\Image\Resource\Schema\AbstractSchemaItem
Extended by OpenCloud\Image\Resource\Schema\Property
Namespace: OpenCloud\Image\Resource\Schema
Package: OpenCloud\Images\Resource\Schema
Located at OpenCloud/Image/Resource/Schema/Property.php
Methods summary
public static OpenCloud\Image\Resource\Schema\Property
# factory( array $data = array() )

Parameters

$data
array
$data

Returns

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

Parameters

$name
mixed
$name
public string
# getName( )

Returns

string
public
# setDescription( mixed $description )

Parameters

$description
mixed
$description
public string
# getDescription( )

Returns

string
public
# setType( mixed $type )

Parameters

$type
mixed
$type
public string
# getType( )

Returns

string
public
# setEnum( mixed $enum )

Parameters

$enum
mixed
$enum
public array
# getEnum( )

Returns

array
public
# setPattern( mixed $pattern )

Parameters

$pattern
mixed
$pattern
public string
# getPattern( )

Returns

string
public
# setValue( mixed $value )

Parameters

$value
mixed
$value
public mixed
# getValue( )

Returns

mixed
public
# setItems( mixed $data )

Parameters

$data
mixed
$data
public array
# getItems( )

Returns

array
protected string
# preparePattern( mixed $pattern )

Prepare the given pattern for Regex functions

Prepare the given pattern for Regex functions

Parameters

$pattern
mixed
$pattern

Returns

string
public boolean
# validate( )

Validate the current value and ensure that it adheres to correct formatting, etc.

Validate the current value and ensure that it adheres to correct formatting, etc.

Returns

boolean
public string
# getPath( )

Get the JSON pointer for this property

Get the JSON pointer for this property

Returns

string
Methods inherited from OpenCloud\Image\Resource\Schema\AbstractSchemaItem
stockProperty()
Constants summary
string DELIMETER '#'
#
Properties summary
protected string $name
#

Name of property

Name of property

protected string $description
#

Description of property

Description of property

protected string $type
#

Type of property (e.g. string, array)

Type of property (e.g. string, array)

protected array $enum
#

Enumerated types that values must adhere to

Enumerated types that values must adhere to

protected string $pattern
#

Regex pattern that values must adhere to

Regex pattern that values must adhere to

protected array $items
#

Array items that this property may possess

Array items that this property may possess

protected mixed $value
#

This property's value

This property's value

PHP OpenCloud API API documentation generated by ApiGen 2.8.0