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

Returns

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

Parameters

$name
public string
# getName( )

Returns

string
string
public
# setDescription( mixed $description )

Parameters

$description
public string
# getDescription( )

Returns

string
string
public
# setType( mixed $type )

Parameters

$type
public string
# getType( )

Returns

string
string
public
# setEnum( mixed $enum )

Parameters

$enum
public array
# getEnum( )

Returns

array
array
public
# setPattern( mixed $pattern )

Parameters

$pattern
public string
# getPattern( )

Returns

string
string
public
# setValue( mixed $value )

Parameters

$value
public mixed
# getValue( )

Returns

mixed
mixed
public
# setItems( mixed $data )

Parameters

$data
public array
# getItems( )

Returns

array
array
protected string
# preparePattern( mixed $pattern )

Prepare the given pattern for Regex functions

Prepare the given pattern for Regex functions

Parameters

$pattern

Returns

string
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
bool
public string
# getPath( )

Get the JSON pointer for this property

Get the JSON pointer for this property

Returns

string
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

#
API documentation generated by ApiGen 2.8.0