Overview
  • Namespace
  • Class

Namespaces

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

Classes

  • AdminContext
  • BaseContext
  • ResellerContext
  • UserContext

Class UserContext

Context for user functions.

Omines\DirectAdmin\Context\BaseContext
Extended by Omines\DirectAdmin\Context\UserContext

Direct known subclasses

Omines\DirectAdmin\Context\ResellerContext

Indirect known subclasses

Omines\DirectAdmin\Context\AdminContext

Namespace: Omines\DirectAdmin\Context
Author: Niels Keurentjes niels.keurentjes@omines.com
Located at DirectAdmin/Context/UserContext.php

Methods summary

public
# __construct( Omines\DirectAdmin\DirectAdmin $connection, boolean $validate = false )

Constructs the object.

Constructs the object.

Parameters

$connection
A prepared connection
$validate
Whether to check if the connection matches the context

Overrides

Omines\DirectAdmin\Context\BaseContext::__construct
public string
# getType( )

Returns the type of the account (user/reseller/admin).

Returns the type of the account (user/reseller/admin).

Returns

string
One of the DirectAdmin::ACCOUNT_TYPE_ constants describing the type of underlying account
public Omines\DirectAdmin\Objects\Users\User
# getContextUser( )

Returns the actual user object behind the context.

Returns the actual user object behind the context.

Returns

Omines\DirectAdmin\Objects\Users\User
The user object behind the context
public null|Omines\DirectAdmin\Objects\Domain
# getDomain( string $domainName )

Returns a domain managed by the current user.

Returns a domain managed by the current user.

Parameters

$domainName
The requested domain name

Returns

null|Omines\DirectAdmin\Objects\Domain
The domain if found, or NULL if it does not exist
public Omines\DirectAdmin\Objects\Domain[]
# getDomains( )

Returns a full list of the domains managed by the current user.

Returns a full list of the domains managed by the current user.

Returns

Omines\DirectAdmin\Objects\Domain[]
public string
# getUsername( )

Returns the username of the current context.

Returns the username of the current context.

Returns

string
Username for the current context

Methods inherited from Omines\DirectAdmin\Context\BaseContext

getConnection(), invokeApiGet(), invokeApiPost()

API documentation generated by ApiGen