Site_Module

+------------------------------------------------------------+ | apnscp | +------------------------------------------------------------+ | Copyright (c) Apis Networks | +------------------------------------------------------------+ | Licensed under Artistic License 2.0 | +------------------------------------------------------------+ | Author: Matt Saladna (msaladna@apisnetworks.com) | +------------------------------------------------------------+
extends Module_Support_Auth implements Opcenter\Contracts\Hookable
Methods Summary
public
# __construct( )
{{{ void __construct(void)

ignore


Overrides

public
# user_service_enabled( string $user , string $service )
bool user_service_enabled(string, string)
public
# get_user_count( )
array get_user_count () Finds the number of users currently on an account and the maximum number permitted.

Deprecated


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
public
# get_users( )
array get_users()

Deprecated


public
# ip_address( )
Get IP address attached to account
public
# split_hostname( string $hostname )
Split hostname into subdomain + domain components

Deprecated


public
# get_account_quota( )
Get quota for an account qused: disk quota used qsoft: disk quota soft limit qhard: disk quota hard limit fused: files used fsoft: files soft limit fhard: files hard limit

see

public
# get_port_range( )
Get port range allocated to account
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
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
sendNotice(), rebuildMap(), getAuthService()
Methods inherited from Module\Skeleton\Standard
__construct(), set_user_parameters(), clean_user_parameters(), set_session_id(), _invoke(), __debugInfo(), getExportedFunctions(), _reset(), get_service_names(), get_services(), get_new_services(), get_active_services(), get_config(), get_service_value(), set_config_journal(), set_config(), query(), _resetModule()
Constants Summary
public string MIN_STORAGE_AMNESTY
# '2592000'
public string AMNESTY_DURATION
# '43200'
public string AMNESTY_MULTIPLIER
# '2'
Constants inherited from Module\Skeleton\Standard
DEPENDENCY_MAP
Properties inherited from Module\Skeleton\Standard
$exportedFunctions, $username, $password, $domain, $user_id, $group_id, $permission_level, $session_id, $site, $site_id, $pgsql, $mysql