Overview
  • Namespace
  • Class

Namespaces

  • Omines
    • DirectAdmin
      • Context
      • Objects
        • Database
        • Domains
        • Email
        • Users
      • Utility

Classes

  • BaseObject
  • Database
  • Domain
  • DomainObject

Class BaseObject

Basic wrapper around a DirectAdmin object as observed within a specific context.

Direct known subclasses

Omines\DirectAdmin\Objects\Database, Omines\DirectAdmin\Objects\Database\AccessHost, Omines\DirectAdmin\Objects\Domain, Omines\DirectAdmin\Objects\DomainObject, Omines\DirectAdmin\Objects\Users\User

Indirect known subclasses

Omines\DirectAdmin\Objects\Domains\Subdomain, Omines\DirectAdmin\Objects\Email\Forwarder, Omines\DirectAdmin\Objects\Email\Mailbox, Omines\DirectAdmin\Objects\Email\MailObject, Omines\DirectAdmin\Objects\Users\Admin, Omines\DirectAdmin\Objects\Users\Reseller

Abstract
Namespace: Omines\DirectAdmin\Objects
Author: Niels Keurentjes niels.keurentjes@omines.com
Located at DirectAdmin/Objects/BaseObject.php

Methods summary

protected
# __construct( string $name, Omines\DirectAdmin\Context\UserContext $context )

Parameters

$name
Canonical name for the object
$context
Context within which the object is valid
public
# clearCache( )

Clear the object's internal cache.

Clear the object's internal cache.

protected mixed
# getCache( string $key, callable|mixed $default )

Retrieves an item from the internal cache.

Retrieves an item from the internal cache.

Parameters

$key
Key to retrieve
$default
Either a callback or an explicit default value

Returns

mixed
Cached value
protected mixed
# getCacheItem( string $key, string $item, callable|mixed $defaultKey, mixed|null $defaultItem = null )

Retrieves a keyed item from inside a cache item.

Retrieves a keyed item from inside a cache item.

Parameters

$key
$item
$defaultKey
$defaultItem

Returns

mixed
Cached value

Codecoverageignore

protected
# setCache( string $key, mixed $value )

Sets a specific cache item, for when a cacheable value was a by-product.

Sets a specific cache item, for when a cacheable value was a by-product.

Parameters

$key
$value
public Omines\DirectAdmin\Context\UserContext
# getContext( )

Returns

Omines\DirectAdmin\Context\UserContext
protected string
# getName( )

Protected as a derived class may want to offer the name under a different name.

Protected as a derived class may want to offer the name under a different name.

Returns

string
public static array
# toObjectArray( array $items, string $class, Omines\DirectAdmin\Context\UserContext $context )

Converts an array of string items to an associative array of objects of the specified type.

Converts an array of string items to an associative array of objects of the specified type.

Parameters

$items
$class
$context

Returns

array
public static array
# toRichObjectArray( array $items, string $class, Omines\DirectAdmin\Context\UserContext $context )

Converts an associative array of descriptors to objects of the specified type.

Converts an associative array of descriptors to objects of the specified type.

Parameters

$items
$class
$context

Returns

array
API documentation generated by ApiGen