Overview

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • Exception
      • Resource
    • Common
      • Collection
      • Constants
      • Exceptions
      • Http
        • Message
      • Identity
      • Log
      • Service
    • Compute
      • Constants
      • Exception
      • Resource
    • Database
      • Resource
    • DNS
      • Resource
    • LoadBalancer
      • Resource
    • ObjectStore
      • Constants
      • Exception
      • Resource
      • Upload
    • Orchestration
    • Queues
      • Exception
      • Resource
    • Volume
      • Resource
  • PHP

Classes

  • Database
  • Instance
  • User
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

Class User

This class represents a User in the Rackspace "Red Dwarf" database-as-a-service product.

OpenCloud\Common\Base
Extended by OpenCloud\Common\PersistentObject
Extended by OpenCloud\Database\Resource\User
Namespace: OpenCloud\Database\Resource
Located at OpenCloud/Database/Resource/User.php
Methods summary
public
# __construct( OpenCloud\Database\Resource\Instance $instance, mixed $info = null, array $db = array() )

Creates a new database object

Creates a new database object

Unlike other objects (Servers, DataObjects, etc.), passing a database name to the constructor does not pull information from the database. For example, if you pass an ID to the Server() constructor, it will attempt to retrieve the information on that server from the service, and will return an error if it is not found. However, the Cloud Users service does not permit retrieval of information on individual databases (only via Collection), and thus passing in a name via the $info parameter only creates an in-memory object that is not necessarily tied to an actual database.

Parameters

$instance
OpenCloud\Database\Resource\Instance
$instance the parent DbService\Instance of the database
$info
mixed
$info if an array or object, treated as properties to set; if a string, treated as the database name
$db
array
$db a list of database names to associate with the User

Throws

UserNameError
if $info is not a string, object, or array

Overrides

OpenCloud\Common\PersistentObject::__construct()
public type
# getName( )

Returns name of this user. Because it's so important (i.e. as an identifier), it will throw an error if not set/empty.

Returns name of this user. Because it's so important (i.e. as an identifier), it will throw an error if not set/empty.

Returns

type

Throws

OpenCloud\Common\Exceptions\DatabaseNameError
public string
# primaryKeyField( )

Returns the primary key field for the object

Returns the primary key field for the object

Returns

string

Overrides

OpenCloud\Common\PersistentObject::primaryKeyField()
public
# addDatabase( string $dbname )

Adds a new database to the list of databases for the user

Adds a new database to the list of databases for the user

Parameters

$dbname
string
$dbname the database name to be added

Api

public HttpResponse
# update( array $params = array() )

Updates an existing object

Updates an existing object

Parameters

$params
array
$params array of values to set when updating the object

Returns

HttpResponse

Throws

VolumeCreateError
if HTTP status is not Success

Overrides

OpenCloud\Common\PersistentObject::update()
public OpenCloud\HttpResponse
# delete( )

Deletes a database user

Deletes a database user

Returns

OpenCloud\HttpResponse

Throws

UserDeleteError
if HTTP response is not Success

Api

Overrides

OpenCloud\Common\PersistentObject::delete()
protected
# createJson( )

Returns an object for the Create() method JSON Must be overridden in a child class.

Returns an object for the Create() method JSON Must be overridden in a child class.

Throws

CreateError
if not overridden

Overrides

OpenCloud\Common\PersistentObject::createJson()
Methods inherited from OpenCloud\Common\PersistentObject
action(), checkExtension(), create(), createUrl(), findLink(), getClient(), getMetadata(), getParent(), getService(), getUrl(), id(), jsonCollectionElement(), jsonCollectionName(), jsonName(), name(), noCreate(), noDelete(), noUpdate(), parseResponse(), refresh(), refreshFromLocationUrl(), region(), resourceName(), setMetadata(), setParent(), setService(), status(), updateJson(), url(), waitFor()
Methods inherited from OpenCloud\Common\Base
__call(), checkJsonError(), generateUuid(), getLogger(), getProperty(), makeResourceIteratorOptions(), populate(), propertyExists(), setLogger(), setProperty(), stripNamespace(), toCamel(), toUnderscores()
Properties summary
public string $name
#

$name the user name

$name the user name

public mixed $password
#
public array $databases array()
#
protected static string $json_name 'user'
#
protected static string $url_resource 'users'
#
Properties inherited from OpenCloud\Common\PersistentObject
$metadata
PHP OpenCloud API API documentation generated by ApiGen 2.8.0