Site_Module

Provides site administrator-specific functionality
extends Module\Support\Auth implements Opcenter\Contracts\Hookable uses ImpersonableTrait
Methods Summary
public
# user_service_enabled( string $user , string $service )
bool user_service_enabled(string, string)
public
# get_bandwidth_usage( int $type = NULL )
array get_bandwidth_usage(string)

privilege


public
# get_bandwidth_rollover( )
Retrieve day on which banwidth rolls over to 0
public
# set_admin_email( string $email )
bool set_admin_email(string email)

privilege


public
# get_admin_email( )
Get admin email
public
# ip_address( )
Get IP address attached to account
public
# get_account_quota( )
Get quota for an account qused: disk quota used in KB qsoft: disk quota soft limit in KB qhard: disk quota hard limit in KB fused: files used fsoft: files soft limit fhard: files hard limit

see

public
# get_port_range( )
Get port range allocated to account

Deprecated


public
# wipe( string $token = '' )
Wipe an account, reinitializing it to its pristine state
public
# storage_amnesty( )
Request a temporary bump to account storage

see

MIN_STORAGE_AMNESTY
public
# amnesty_active( )
Account is under amnesty
public
# hijack( string $user )
Assume the role of a secondary user
public
public
public
public
# _verify_conf( Opcenter\Service\ConfigurationContext $ctx )
Configuration verification

Implementation of

public
# _edit_user( string $userold , string $usernew , array $oldpwd )
public
public
Methods inherited from Module\Support\Auth
getAuthService(), sendNotice(), rebuildMap()
Methods inherited from Module\Skeleton\Standard
__construct(), setUserParameters(), autoloadModule(), __wakeup(), _invoke(), __debugInfo(), getExportedFunctions(), _reset(), _resetModule(), cleanUserParameters(), query()
Methods used from ImpersonableTrait trait
impersonateRole() restoreImpersonator()
Constants Summary
public int MIN_STORAGE_AMNESTY
# 2592000
public int AMNESTY_DURATION
# 43200
public int AMNESTY_MULTIPLIER
# 2
public array DEPENDENCY_MAP
# array ( )
Constants inherited from Module\Skeleton\Standard
DEPENDENCY_MAP
Properties Summary
protected $exportedFunctions

# array ( '*' => 2, 'get_admin_email' => 3, 'ip_address' => 3, 'split_hostname' => 3, )
Properties inherited from Module\Skeleton\Standard
$exportedFunctions, $username, $password, $domain, $user_id, $group_id, $permission_level, $session_id, $site, $site_id
Properties used from ImpersonableTrait