Nextcloud Circles API

ConfigService
in package
Uses TStringTools, TArrayTools, TNCLogger

Class ConfigService

Table of Contents

ACTIVITY_ON_NEW_CIRCLE  = 'creation_activity'
ALLOWED_TYPES  = 'allowed_types'
BYPASS_CIRCLE_TYPES  = 'bypass_circle_types'
CIRCLE_TYPES_BLOCK  = 'circle_types_block'
CIRCLE_TYPES_FORCE  = 'circle_types_force'
CIRCLES_ACCOUNTS_ONLY  = 'accounts_only'
CIRCLES_CONTACT_BACKEND  = 'contact_backend'
CIRCLES_SEARCH_FROM_COLLABORATOR  = 'search_from_collaborator'
DISPLAY_AT  = 1
DISPLAY_NONE  = 0
DISPLAY_PARENTHESIS  = 2
ENFORCE_PASSWORD  = 'enforce_password'
EVENT_EXAMPLES  = 'event_examples'
FORCE_NC_BASE  = 'force_nc_base'
FRONTAL_CLOUD_BASE  = 'frontal_cloud_base'
FRONTAL_CLOUD_ID  = 'frontal_cloud_id'
FRONTAL_CLOUD_PATH  = 'frontal_cloud_path'
FRONTAL_CLOUD_SCHEME  = 'frontal_cloud_scheme'
FRONTEND_ENABLED  = 'frontend_enabled'
GS_KEY  = 'key'
GS_LOOKUP_INSTANCES  = '/instances'
GS_LOOKUP_USERS  = '/users'
GS_MODE  = 'mode'
HARD_MODERATION  = 'hard_moderation'
IFACE0_CLOUD_ID  = 'iface0_cloud_id'
IFACE0_CLOUD_PATH  = 'iface0_cloud_path'
IFACE0_CLOUD_SCHEME  = 'iface0_cloud_scheme'
IFACE0_INTERNAL  = 'iface0_internal'
IFACE1_CLOUD_ID  = 'iface1_cloud_id'
IFACE1_CLOUD_PATH  = 'iface1_cloud_path'
IFACE1_CLOUD_SCHEME  = 'iface1_cloud_scheme'
IFACE1_INTERNAL  = 'iface1_internal'
IFACE2_CLOUD_ID  = 'iface2_cloud_id'
IFACE2_CLOUD_PATH  = 'iface2_cloud_path'
IFACE2_CLOUD_SCHEME  = 'iface2_cloud_scheme'
IFACE2_INTERNAL  = 'iface2_internal'
IFACE3_CLOUD_ID  = 'iface3_cloud_id'
IFACE3_CLOUD_PATH  = 'iface3_cloud_path'
IFACE3_CLOUD_SCHEME  = 'iface3_cloud_scheme'
IFACE3_INTERNAL  = 'iface3_internal'
IFACE4_CLOUD_ID  = 'iface4_cloud_id'
IFACE4_CLOUD_PATH  = 'iface4_cloud_path'
IFACE4_CLOUD_SCHEME  = 'iface4_cloud_scheme'
IFACE4_INTERNAL  = 'iface4_internal'
IFACE_TEST_ID  = 'iface_test_id'
IFACE_TEST_PATH  = 'iface_test_path'
IFACE_TEST_SCHEME  = 'iface_test_scheme'
IFACE_TEST_TOKEN  = 'iface_test_token'
INTERNAL_CLOUD_ID  = 'internal_cloud_id'
INTERNAL_CLOUD_PATH  = 'internal_cloud_path'
INTERNAL_CLOUD_SCHEME  = 'internal_cloud_scheme'
KEYHOLE_CFG_REQUEST  = 'keyhole_cfg_request'
LIMIT_CIRCLE_CREATION  = 'limit_circle_creation'
LOOPBACK_CLOUD_ID  = 'loopback_cloud_id'
LOOPBACK_CLOUD_PATH  = 'loopback_cloud_path'
LOOPBACK_CLOUD_SCHEME  = 'loopback_cloud_scheme'
LOOPBACK_TMP_ID  = 'loopback_tmp_id'
LOOPBACK_TMP_PATH  = 'loopback_tmp_path'
LOOPBACK_TMP_SCHEME  = 'loopback_tmp_scheme'
MAINTENANCE_RUN  = 'maintenance_run'
MAINTENANCE_UPDATE  = 'maintenance_update'
MEMBERS_LIMIT  = 'members_limit'
MIGRATION_22  = 'migration_22'
MIGRATION_22_1  = 'migration_22_1'
MIGRATION_22_CONFIRMED  = 'migration_22_confirmed'
MIGRATION_BYPASS  = 'migration_bypass'
MIGRATION_RUN  = 'migration_run'
ROUTE_TO_CIRCLE  = 'route_to_circle'
SELF_SIGNED_CERT  = 'self_signed_cert'
TEST_NC_BASE  = 'test_nc_base'
$ALERT  : mixed
$CRITICAL  : mixed
$DEBUG  : mixed
$EMERGENCY  : mixed
$ERROR  : mixed
$INFO  : mixed
$NOTICE  : mixed
$TYPE_ARRAY  : mixed
$TYPE_BOOLEAN  : mixed
$TYPE_INTEGER  : mixed
$TYPE_NULL  : mixed
$TYPE_SERIALIZABLE  : mixed
$TYPE_STRING  : mixed
$WARNING  : mixed
$config  : IConfig
$defaults  : mixed
$urlGenerator  : IURLGenerator
__construct()  : mixed
ConfigService constructor.
alert()  : void
configureLoopbackRequest()  : void
- Create route using getLoopbackAddress() - perfect for loopback request.
configureRequest()  : void
confirmAllowedCircleTypes()  : void
Enforce or Block circle's config/type
contactsBackendType()  : int
debug()  : void
displayFederatedUser()  : string
displayInstance()  : string
e()  : void
emergency()  : void
enforcePasswordOnSharedFile()  : bool
true if: - global setting of Nextcloud enforce password on shares.
exception()  : void
generateRandomSentence()  : string
generateRandomWord()  : string
getAppValue()  : string
Get a value by key
getAppValueBool()  : bool
getAppValueInt()  : int
getAvailableHosts()  : array<string|int, mixed>
Get available hosts
getCoreValueForUser()  : string
Get a user value by key and user
getDateDiff()  : string
getFrontalInstance()  : string
- must be configured using FRONTAL_CLOUD_ID - returns host+port, does not specify any protocol - used mainly to assign instance and source to a request - important only in remote environment
getGSData()  : array<string|int, mixed>
getGSInfo()  : string
getGSLookup()  : string
getGSSMockup()  : array<string|int, mixed>
getIfaceInstance()  : string
getInternalInstance()  : string
- must be configured using INTERNAL_CLOUD_ID - returns host+port, does not specify any protocol - used mainly to assign instance and source to a request to local GlobalScale - important only in GlobalScale environment
getLoopbackInstance()  : string
getLoopbackPath()  : string
returns loopback address based on getLoopbackInstance and LOOPBACK_CLOUD_SCHEME should be used to async process
getSettings()  : array<string|int, mixed>
// TODO: fetch data from somewhere else than hard coded.
getTrustedDomains()  : array<string|int, mixed>
humanReadable()  : string
isContactsBackend()  : bool
isGSAvailable()  : bool
isLocalInstance()  : bool
isSinglePasswordAvailable()  : bool
true if: - password enforced for Circle - single password enabled for Circle - single password defined within Circle's settings
linkToRoute()  : string
log()  : void
logger()  : LoggerInterface
notice()  : void
sendPasswordByMail()  : bool
true if: - password is generated randomly
setAppValue()  : void
Set a value by key
t()  : void
throwable()  : void
typeOf()  : string
unsetAppConfig()  : void
validKey()  : bool
warning()  : void
cleanArray()  : mixed
commonPart()  : string
cut()  : string
extractArray()  : mixed
feedStringWithParams()  : string
get()  : string
getArray()  : array<string|int, mixed>
getBool()  : bool
getFloat()  : float
getInt()  : int
getList()  : array<string|int, mixed>
getObj()  : mixed
isUuid()  : bool
mustContains()  : mixed
token()  : string
uuid()  : string
Generate uuid: 2b5a7a87-8db1-445f-a17b-405790f91c80

Constants

ACTIVITY_ON_NEW_CIRCLE

public mixed ACTIVITY_ON_NEW_CIRCLE = 'creation_activity'

BYPASS_CIRCLE_TYPES

public mixed BYPASS_CIRCLE_TYPES = 'bypass_circle_types'

CIRCLE_TYPES_BLOCK

public mixed CIRCLE_TYPES_BLOCK = 'circle_types_block'

CIRCLE_TYPES_FORCE

public mixed CIRCLE_TYPES_FORCE = 'circle_types_force'

CIRCLES_ACCOUNTS_ONLY

public mixed CIRCLES_ACCOUNTS_ONLY = 'accounts_only'

CIRCLES_CONTACT_BACKEND

public mixed CIRCLES_CONTACT_BACKEND = 'contact_backend'

CIRCLES_SEARCH_FROM_COLLABORATOR

public mixed CIRCLES_SEARCH_FROM_COLLABORATOR = 'search_from_collaborator'

ENFORCE_PASSWORD

public mixed ENFORCE_PASSWORD = 'enforce_password'

EVENT_EXAMPLES

public mixed EVENT_EXAMPLES = 'event_examples'

FRONTAL_CLOUD_BASE

public mixed FRONTAL_CLOUD_BASE = 'frontal_cloud_base'

FRONTAL_CLOUD_ID

public mixed FRONTAL_CLOUD_ID = 'frontal_cloud_id'

FRONTAL_CLOUD_PATH

public mixed FRONTAL_CLOUD_PATH = 'frontal_cloud_path'

FRONTAL_CLOUD_SCHEME

public mixed FRONTAL_CLOUD_SCHEME = 'frontal_cloud_scheme'

FRONTEND_ENABLED

public mixed FRONTEND_ENABLED = 'frontend_enabled'

GS_LOOKUP_INSTANCES

public mixed GS_LOOKUP_INSTANCES = '/instances'

HARD_MODERATION

public mixed HARD_MODERATION = 'hard_moderation'

IFACE0_CLOUD_ID

public mixed IFACE0_CLOUD_ID = 'iface0_cloud_id'

IFACE0_CLOUD_PATH

public mixed IFACE0_CLOUD_PATH = 'iface0_cloud_path'

IFACE0_CLOUD_SCHEME

public mixed IFACE0_CLOUD_SCHEME = 'iface0_cloud_scheme'

IFACE0_INTERNAL

public mixed IFACE0_INTERNAL = 'iface0_internal'

IFACE1_CLOUD_ID

public mixed IFACE1_CLOUD_ID = 'iface1_cloud_id'

IFACE1_CLOUD_PATH

public mixed IFACE1_CLOUD_PATH = 'iface1_cloud_path'

IFACE1_CLOUD_SCHEME

public mixed IFACE1_CLOUD_SCHEME = 'iface1_cloud_scheme'

IFACE1_INTERNAL

public mixed IFACE1_INTERNAL = 'iface1_internal'

IFACE2_CLOUD_ID

public mixed IFACE2_CLOUD_ID = 'iface2_cloud_id'

IFACE2_CLOUD_PATH

public mixed IFACE2_CLOUD_PATH = 'iface2_cloud_path'

IFACE2_CLOUD_SCHEME

public mixed IFACE2_CLOUD_SCHEME = 'iface2_cloud_scheme'

IFACE2_INTERNAL

public mixed IFACE2_INTERNAL = 'iface2_internal'

IFACE3_CLOUD_ID

public mixed IFACE3_CLOUD_ID = 'iface3_cloud_id'

IFACE3_CLOUD_PATH

public mixed IFACE3_CLOUD_PATH = 'iface3_cloud_path'

IFACE3_CLOUD_SCHEME

public mixed IFACE3_CLOUD_SCHEME = 'iface3_cloud_scheme'

IFACE3_INTERNAL

public mixed IFACE3_INTERNAL = 'iface3_internal'

IFACE4_CLOUD_ID

public mixed IFACE4_CLOUD_ID = 'iface4_cloud_id'

IFACE4_CLOUD_PATH

public mixed IFACE4_CLOUD_PATH = 'iface4_cloud_path'

IFACE4_CLOUD_SCHEME

public mixed IFACE4_CLOUD_SCHEME = 'iface4_cloud_scheme'

IFACE4_INTERNAL

public mixed IFACE4_INTERNAL = 'iface4_internal'

IFACE_TEST_PATH

public mixed IFACE_TEST_PATH = 'iface_test_path'

IFACE_TEST_SCHEME

public mixed IFACE_TEST_SCHEME = 'iface_test_scheme'

IFACE_TEST_TOKEN

public mixed IFACE_TEST_TOKEN = 'iface_test_token'

INTERNAL_CLOUD_ID

public mixed INTERNAL_CLOUD_ID = 'internal_cloud_id'

INTERNAL_CLOUD_PATH

public mixed INTERNAL_CLOUD_PATH = 'internal_cloud_path'

INTERNAL_CLOUD_SCHEME

public mixed INTERNAL_CLOUD_SCHEME = 'internal_cloud_scheme'

KEYHOLE_CFG_REQUEST

public mixed KEYHOLE_CFG_REQUEST = 'keyhole_cfg_request'

LIMIT_CIRCLE_CREATION

public mixed LIMIT_CIRCLE_CREATION = 'limit_circle_creation'

LOOPBACK_CLOUD_ID

public mixed LOOPBACK_CLOUD_ID = 'loopback_cloud_id'

LOOPBACK_CLOUD_PATH

public mixed LOOPBACK_CLOUD_PATH = 'loopback_cloud_path'

LOOPBACK_CLOUD_SCHEME

public mixed LOOPBACK_CLOUD_SCHEME = 'loopback_cloud_scheme'

LOOPBACK_TMP_ID

public mixed LOOPBACK_TMP_ID = 'loopback_tmp_id'

LOOPBACK_TMP_PATH

public mixed LOOPBACK_TMP_PATH = 'loopback_tmp_path'

LOOPBACK_TMP_SCHEME

public mixed LOOPBACK_TMP_SCHEME = 'loopback_tmp_scheme'

MAINTENANCE_RUN

public mixed MAINTENANCE_RUN = 'maintenance_run'

MAINTENANCE_UPDATE

public mixed MAINTENANCE_UPDATE = 'maintenance_update'

MIGRATION_22_1

public mixed MIGRATION_22_1 = 'migration_22_1'

MIGRATION_22_CONFIRMED

public mixed MIGRATION_22_CONFIRMED = 'migration_22_confirmed'

MIGRATION_BYPASS

public mixed MIGRATION_BYPASS = 'migration_bypass'

ROUTE_TO_CIRCLE

public mixed ROUTE_TO_CIRCLE = 'route_to_circle'

SELF_SIGNED_CERT

public mixed SELF_SIGNED_CERT = 'self_signed_cert'

Properties

$EMERGENCY

public static mixed $EMERGENCY = 4

$TYPE_ARRAY

public static mixed $TYPE_ARRAY = 'Array'

$TYPE_BOOLEAN

public static mixed $TYPE_BOOLEAN = 'Boolean'

$TYPE_INTEGER

public static mixed $TYPE_INTEGER = 'Integer'

$TYPE_SERIALIZABLE

public static mixed $TYPE_SERIALIZABLE = 'Serializable'

$TYPE_STRING

public static mixed $TYPE_STRING = 'String'

$defaults

private static mixed $defaults = [self::FRONTAL_CLOUD_BASE => '', self::FRONTAL_CLOUD_ID => '', self::FRONTAL_CLOUD_SCHEME => 'https', self::FRONTAL_CLOUD_PATH => '', self::INTERNAL_CLOUD_ID => '', self::INTERNAL_CLOUD_SCHEME => 'https', self::INTERNAL_CLOUD_PATH => '', self::LOOPBACK_CLOUD_ID => '', self::LOOPBACK_CLOUD_SCHEME => 'https', self::LOOPBACK_CLOUD_PATH => '', self::IFACE0_CLOUD_ID => '', self::IFACE0_CLOUD_SCHEME => 'https', self::IFACE0_CLOUD_PATH => '', self::IFACE0_INTERNAL => '0', self::IFACE1_CLOUD_ID => '', self::IFACE1_CLOUD_SCHEME => 'https', self::IFACE1_CLOUD_PATH => '', self::IFACE1_INTERNAL => '0', self::IFACE2_CLOUD_ID => '', self::IFACE2_CLOUD_SCHEME => 'https', self::IFACE2_CLOUD_PATH => '', self::IFACE2_INTERNAL => '0', self::IFACE3_CLOUD_ID => '', self::IFACE3_CLOUD_SCHEME => 'https', self::IFACE3_CLOUD_PATH => '', self::IFACE3_INTERNAL => '0', self::IFACE4_CLOUD_ID => '', self::IFACE4_CLOUD_SCHEME => 'https', self::IFACE4_CLOUD_PATH => '', self::IFACE4_INTERNAL => '0', self::IFACE_TEST_ID => '', self::IFACE_TEST_SCHEME => 'https', self::IFACE_TEST_PATH => '', self::IFACE_TEST_TOKEN => '', self::LOOPBACK_TMP_ID => '', self::LOOPBACK_TMP_SCHEME => '', self::LOOPBACK_TMP_PATH => '', self::FRONTEND_ENABLED => '1', self::HARD_MODERATION => '0', self::KEYHOLE_CFG_REQUEST => '0', self::ROUTE_TO_CIRCLE => 'contacts.contacts.directcircle', self::EVENT_EXAMPLES => '0', self::ENFORCE_PASSWORD => '2', self::SELF_SIGNED_CERT => '0', self::MEMBERS_LIMIT => '-1', self::ACTIVITY_ON_NEW_CIRCLE => '1', self::ALLOWED_TYPES => \OCA\Circles\Model\Member::ALLOWING_ALL_TYPES, self::CIRCLE_TYPES_FORCE => '0', self::CIRCLE_TYPES_BLOCK => '0', self::BYPASS_CIRCLE_TYPES => '', self::LIMIT_CIRCLE_CREATION => '', self::MIGRATION_BYPASS => '0', self::MIGRATION_22 => '0', self::MIGRATION_22_1 => '0', self::MIGRATION_22_CONFIRMED => '0', self::MIGRATION_RUN => '0', self::MAINTENANCE_UPDATE => '[]', self::MAINTENANCE_RUN => '0', self::FORCE_NC_BASE => '', self::TEST_NC_BASE => '', self::CIRCLES_CONTACT_BACKEND => '0', self::CIRCLES_ACCOUNTS_ONLY => '0', self::CIRCLES_SEARCH_FROM_COLLABORATOR => '0']

Methods

__construct()

ConfigService constructor.

public __construct(IConfig $config, IURLGenerator $urlGenerator) : mixed
Parameters
$config : IConfig
$urlGenerator : IURLGenerator
Return values
mixed —

alert()

public alert(string $message[, bool $trace = false ][, array<string|int, mixed> $serializable = [] ]) : void
Parameters
$message : string
$trace : bool = false
$serializable : array<string|int, mixed> = []
Return values
void —

configureLoopbackRequest()

- Create route using getLoopbackAddress() - perfect for loopback request.

public configureLoopbackRequest(NCRequest $request[, string $route = '' ][, array<string|int, mixed> $args = [] ]) : void
Parameters
$request : NCRequest
$route : string = ''
$args : array<string|int, mixed> = []
Return values
void —

confirmAllowedCircleTypes()

Enforce or Block circle's config/type

public confirmAllowedCircleTypes(Circle $circle) : void
Parameters
$circle : Circle
Return values
void —

contactsBackendType()

public contactsBackendType() : int
Tags
deprecated
Return values
int —

debug()

public debug(string $message[, array<string|int, mixed> $serializable = [] ]) : void
Parameters
$message : string
$serializable : array<string|int, mixed> = []
Return values
void —

displayFederatedUser()

public displayFederatedUser(IFederatedUser $federatedUser[, bool $displayName = false ][, bool $displayInstance = true ]) : string
Parameters
$federatedUser : IFederatedUser
$displayName : bool = false
$displayInstance : bool = true
Return values
string —

displayInstance()

public displayInstance(string $instance[, int $type = self::DISPLAY_NONE ]) : string
Parameters
$instance : string
$type : int = self::DISPLAY_NONE
Return values
string —

e()

public e(Exception $e[, array<string|int, mixed> $serializable = [] ]) : void
Parameters
$e : Exception
$serializable : array<string|int, mixed> = []
Return values
void —

emergency()

public emergency(string $message[, bool $trace = false ][, array<string|int, mixed> $serializable = [] ]) : void
Parameters
$message : string
$trace : bool = false
$serializable : array<string|int, mixed> = []
Return values
void —

enforcePasswordOnSharedFile()

true if: - global setting of Nextcloud enforce password on shares.

public enforcePasswordOnSharedFile(Circle $circle) : bool
  • setting of Circles' app enforce password on shares.
  • setting for specific Circle enforce password on shares.
Parameters
$circle : Circle
Return values
bool —

exception()

public exception(Exception $e[, int|array<string|int, mixed> $level = 3 ][, array<string|int, mixed> $serializable = [] ]) : void
Parameters
$e : Exception
$level : int|array<string|int, mixed> = 3
$serializable : array<string|int, mixed> = []
Return values
void —

generateRandomSentence()

public generateRandomSentence([int $words = 5 ]) : string
Parameters
$words : int = 5
Return values
string —

generateRandomWord()

public generateRandomWord([int $length = 8 ]) : string
Parameters
$length : int = 8
Return values
string —

getAppValue()

Get a value by key

public getAppValue(string $key) : string
Parameters
$key : string
Return values
string —

getAppValueBool()

public getAppValueBool(string $key) : bool
Parameters
$key : string
Return values
bool —

getAppValueInt()

public getAppValueInt(string $key) : int
Parameters
$key : string
Return values
int —

getAvailableHosts()

Get available hosts

public getAvailableHosts() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getCoreValueForUser()

Get a user value by key and user

public getCoreValueForUser(string $userId, string $key[, string $default = '' ]) : string
Parameters
$userId : string
$key : string
$default : string = ''
Return values
string —

getDateDiff()

public getDateDiff(int $first, int $second[, bool $short = false ][, array<string|int, mixed> $words = [] ]) : string
Parameters
$first : int
$second : int
$short : bool = false
$words : array<string|int, mixed> = []
Tags
throws
Exception
Return values
string —

getFrontalInstance()

- must be configured using FRONTAL_CLOUD_ID - returns host+port, does not specify any protocol - used mainly to assign instance and source to a request - important only in remote environment

public getFrontalInstance() : string
Return values
string —

getGSInfo()

public getGSInfo(string $type) : string
Parameters
$type : string
Return values
string —

getGSSMockup()

public getGSSMockup() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getIfaceInstance()

public getIfaceInstance(int $iface) : string
Parameters
$iface : int
Return values
string —

getInternalInstance()

- must be configured using INTERNAL_CLOUD_ID - returns host+port, does not specify any protocol - used mainly to assign instance and source to a request to local GlobalScale - important only in GlobalScale environment

public getInternalInstance() : string
Return values
string —

getLoopbackInstance()

public getLoopbackInstance() : string
Return values
string —

getLoopbackPath()

returns loopback address based on getLoopbackInstance and LOOPBACK_CLOUD_SCHEME should be used to async process

public getLoopbackPath([string $route = '' ][, array<string|int, mixed> $args = [] ]) : string
Parameters
$route : string = ''
$args : array<string|int, mixed> = []
Return values
string —

getSettings()

// TODO: fetch data from somewhere else than hard coded.

public getSettings() : array<string|int, mixed>

..

Return values
array<string|int, mixed> —

getTrustedDomains()

public getTrustedDomains() : array<string|int, mixed>
Return values
array<string|int, mixed> —

humanReadable()

public humanReadable(int $bytes) : string
Parameters
$bytes : int
Return values
string —

isContactsBackend()

public isContactsBackend() : bool
Tags
deprecated
Return values
bool —

isGSAvailable()

public isGSAvailable() : bool
Return values
bool —

isLocalInstance()

public isLocalInstance(string $instance) : bool
Parameters
$instance : string
Return values
bool —

isSinglePasswordAvailable()

true if: - password enforced for Circle - single password enabled for Circle - single password defined within Circle's settings

public isSinglePasswordAvailable(Circle $circle) : bool
Parameters
$circle : Circle
Return values
bool —

linkToRoute()

public linkToRoute(string $route, array<string|int, mixed> $args) : string
Parameters
$route : string
$args : array<string|int, mixed>
Return values
string —

log()

public log(int $level, string $message[, bool $trace = false ][, array<string|int, mixed> $serializable = [] ]) : void
Parameters
$level : int
$message : string
$trace : bool = false
$serializable : array<string|int, mixed> = []
Return values
void —

logger()

public logger() : LoggerInterface
Return values
LoggerInterface —

notice()

public notice(string $message[, bool $trace = false ][, array<string|int, mixed> $serializable = [] ]) : void
Parameters
$message : string
$trace : bool = false
$serializable : array<string|int, mixed> = []
Return values
void —

sendPasswordByMail()

true if: - password is generated randomly

public sendPasswordByMail(Circle $circle) : bool
Parameters
$circle : Circle
Return values
bool —

setAppValue()

Set a value by key

public setAppValue(string $key, string $value) : void
Parameters
$key : string
$value : string
Return values
void —

t()

public t(Throwable $t[, array<string|int, mixed> $serializable = [] ]) : void
Parameters
$t : Throwable
$serializable : array<string|int, mixed> = []
Return values
void —

throwable()

public throwable(Throwable $t[, int $level = 3 ][, array<string|int, mixed> $serializable = [] ]) : void
Parameters
$t : Throwable
$level : int = 3
$serializable : array<string|int, mixed> = []
Return values
void —

typeOf()

public typeOf(string $key, array<string|int, mixed> $arr[, bool $root = true ]) : string
Parameters
$key : string
$arr : array<string|int, mixed>
$root : bool = true
Tags
throws
ItemNotFoundException
throws
UnknownTypeException
Return values
string —

unsetAppConfig()

public unsetAppConfig() : void
Return values
void —

validKey()

public validKey(string $k, array<string|int, mixed> $arr) : bool
Parameters
$k : string
$arr : array<string|int, mixed>
Return values
bool —

warning()

public warning(string $message[, bool $trace = false ][, array<string|int, mixed> $serializable = [] ]) : void
Parameters
$message : string
$trace : bool = false
$serializable : array<string|int, mixed> = []
Return values
void —

cleanArray()

protected cleanArray(array<string|int, mixed> &$arr) : mixed
Parameters
$arr : array<string|int, mixed>
Return values
mixed —

commonPart()

protected commonPart(string $str1, string $str2[, bool $cs = true ]) : string
Parameters
$str1 : string
$str2 : string
$cs : bool = true

case sensitive ?

Return values
string —

cut()

protected cut(string $line, int $length) : string
Parameters
$line : string
$length : int
Return values
string —

extractArray()

protected extractArray(string $k, string $value, array<string|int, mixed> $list) : mixed
Parameters
$k : string
$value : string
$list : array<string|int, mixed>
Tags
throws
ArrayNotFoundException
Return values
mixed —

feedStringWithParams()

protected feedStringWithParams(string $line, array<string|int, mixed> $params) : string
Parameters
$line : string
$params : array<string|int, mixed>
Return values
string —

get()

protected get(string $k, array<string|int, mixed> $arr[, string $default = '' ]) : string
Parameters
$k : string
$arr : array<string|int, mixed>
$default : string = ''
Return values
string —

getArray()

protected getArray(string $k, array<string|int, mixed> $arr[, array<string|int, mixed> $default = [] ]) : array<string|int, mixed>
Parameters
$k : string
$arr : array<string|int, mixed>
$default : array<string|int, mixed> = []
Return values
array<string|int, mixed> —

getBool()

protected getBool(string $k, array<string|int, mixed> $arr[, bool $default = false ]) : bool
Parameters
$k : string
$arr : array<string|int, mixed>
$default : bool = false
Return values
bool —

getFloat()

protected getFloat(string $k, array<string|int, mixed> $arr, float $default) : float
Parameters
$k : string
$arr : array<string|int, mixed>
$default : float
Return values
float —

getInt()

protected getInt(string $k, array<string|int, mixed> $arr, int $default) : int
Parameters
$k : string
$arr : array<string|int, mixed>
$default : int
Return values
int —

getList()

protected getList(string $k, array<string|int, mixed> $arr, array<string|int, mixed> $import[, array<string|int, mixed> $default = [] ]) : array<string|int, mixed>
Parameters
$k : string
$arr : array<string|int, mixed>
$import : array<string|int, mixed>
$default : array<string|int, mixed> = []
Return values
array<string|int, mixed> —

getObj()

protected getObj(string $k, array<string|int, mixed> $arr[, JsonSerializable|null $default = null ]) : mixed
Parameters
$k : string
$arr : array<string|int, mixed>
$default : JsonSerializable|null = null
Return values
mixed —

isUuid()

protected isUuid(string $uuid) : bool
Parameters
$uuid : string
Return values
bool —

mustContains()

protected mustContains(array<string|int, mixed> $keys, array<string|int, mixed> $arr) : mixed
Parameters
$keys : array<string|int, mixed>
$arr : array<string|int, mixed>
Tags
throws
MalformedArrayException
Return values
mixed —

token()

protected token([int $length = 15 ]) : string
Parameters
$length : int = 15
Return values
string —

uuid()

Generate uuid: 2b5a7a87-8db1-445f-a17b-405790f91c80

protected uuid(int $length) : string
Parameters
$length : int
Return values
string —

Search results