Класс Network

Открытые члены
	__construct ()
	isOptionEnabled ()
	isEnabled ()
	setEnable ($enable=true)
	searchUser ($search)
	getUser ($networkId, $lastSearch='')
	getUsers ($networkIds, $lastSearch='')
	addUserById ($networkId, $lastSearch='')
	addUsersById ($networkIds, $lastSearch='')
	addUser ($params)

Открытые статические члены
static	getNetworkId ($userId)
static	getUserId ($networkId)
static	getUsersId ($networkIds)
static	formatUserParam ($params)
static	getAuthUrl ($mode="page", $addScope=null)
static	setAdminPopupSession ()
static	clearAdminPopupSession ($userId)
static	getAdminPopupSession ()
static	setLastUserStatus ($status)
static	getLastUserStatus ()

Поля данных
const	ERROR_SEARCH_STRING_TO_SHORT = 'ERROR_SEARCH_STRING_TO_SHORT'
const	ERROR_SEARCH_USER_NOT_FOUND = 'ERROR_SEARCH_USER_NOT_FOUND'
const	ERROR_REGISTER_USER = 'ERROR_REGISTER_USER'
const	ERROR_SOCSERV_TRANSPORT = 'ERROR_SOCSERV_TRANSPORT'
const	ERROR_NETWORK_IN_NOT_ENABLED = 'ERROR_NETWORK_IN_NOT_ENABLED'
const	ERROR_INCORRECT_PARAMS = 'ERROR_INCORRECT_PARAMS'
const	EXTERNAL_AUTH_ID = 'replica'
const	ADMIN_SESSION_KEY = "SS_B24NET_STATE"
	$errorCollection = null

Защищенные статические члены
static	getShowOptions ()

Статические защищенные данные
static	$lastUserStatus = null

Подробное описание

См. определение в файле network.php строка 25

Конструктор(ы)

__construct()

__construct

(

)

См. определение в файле network.php строка 43

Методы

addUser()

addUser

(

$params

)

Add new user to b_user table. Returns its identifier or false on failure.

Аргументы

array

$params

Возвращает

integer|false

См. определение в файле network.php строка 240

addUserById()

addUserById	(		$networkId,
			$lastSearch = '' )

Аргументы

int	$networkId
string	$lastSearch

Возвращает

integer|false

См. определение в файле network.php строка 175

addUsersById()

addUsersById	(		$networkIds,
			$lastSearch = '' )

Аргументы

array	$networkIds
string	$lastSearch

Возвращает

array|boolean

См. определение в файле network.php строка 198

clearAdminPopupSession()

clearAdminPopupSession ( $userId )

static

См. определение в файле network.php строка 420

formatUserParam()

formatUserParam ( $params )

static

Аргументы

array

$params

Возвращает

array|false

См. определение в файле network.php строка 359

getAdminPopupSession()

getAdminPopupSession ( )

static

См. определение в файле network.php строка 436

getAuthUrl()

getAuthUrl ( $mode = "page", $addScope = null )

static

См. определение в файле network.php строка 397

getLastUserStatus()

getLastUserStatus ( )

static

См. определение в файле network.php строка 459

getNetworkId()

getNetworkId ( $userId )

static

Аргументы

integer

$userId

Возвращает

integer|null

См. определение в файле network.php строка 291

getShowOptions()

getShowOptions ( )

staticprotected

См. определение в файле network.php строка 431

getUser()

getUser	(		$networkId,
			$lastSearch = '' )

Аргументы

integer	$networkId
string	$lastSearch

Возвращает

array|null

См. определение в файле network.php строка 111

getUserId()

getUserId ( $networkId )

static

Аргументы

string

$networkId

Возвращает

integer|null

См. определение в файле network.php строка 310

getUsers()

getUsers	(		$networkIds,
			$lastSearch = '' )

Аргументы

array	$networkIds
string	$lastSearch

Возвращает

array|null

См. определение в файле network.php строка 124

getUsersId()

getUsersId ( $networkIds )

static

Аргументы

array

$networkIds

Возвращает

array|null

См. определение в файле network.php строка 322

isEnabled()

isEnabled

(

)

Returns if network communication is avalable for current user

Возвращает

boolean

См. определение в файле network.php строка 65

isOptionEnabled()

isOptionEnabled

(

)

Returns if option is turned on

Возвращает

bool

См. определение в файле network.php строка 54

searchUser()

searchUser

(

$search

)

Searches the network for users by email or nickname. Returns array on success and null on failure. Check errorCollection public member for errors description.

Аргументы

string

$search

Search query string.

Возвращает

array|null

См. определение в файле network.php строка 99

setAdminPopupSession()

setAdminPopupSession ( )

static

См. определение в файле network.php строка 414

setEnable()

setEnable

(

$enable = true

)

Enables network communication. Returns true on success.

Аргументы

boolean

$enable

Pass true to enable and false to disable.

Возвращает

boolean

См. определение в файле network.php строка 77

setLastUserStatus()

setLastUserStatus ( $status )

static

См. определение в файле network.php строка 454

Поля

$errorCollection

$errorCollection = null

См. определение в файле network.php строка 39

$lastUserStatus

$lastUserStatus = null

staticprotected

См. определение в файле network.php строка 41

ADMIN_SESSION_KEY

const ADMIN_SESSION_KEY = "SS_B24NET_STATE"

См. определение в файле network.php строка 36

ERROR_INCORRECT_PARAMS

const ERROR_INCORRECT_PARAMS = 'ERROR_INCORRECT_PARAMS'

См. определение в файле network.php строка 32

ERROR_NETWORK_IN_NOT_ENABLED

const ERROR_NETWORK_IN_NOT_ENABLED = 'ERROR_NETWORK_IN_NOT_ENABLED'

См. определение в файле network.php строка 31

ERROR_REGISTER_USER

const ERROR_REGISTER_USER = 'ERROR_REGISTER_USER'

См. определение в файле network.php строка 29

ERROR_SEARCH_STRING_TO_SHORT

const ERROR_SEARCH_STRING_TO_SHORT = 'ERROR_SEARCH_STRING_TO_SHORT'

См. определение в файле network.php строка 27

ERROR_SEARCH_USER_NOT_FOUND

const ERROR_SEARCH_USER_NOT_FOUND = 'ERROR_SEARCH_USER_NOT_FOUND'

См. определение в файле network.php строка 28

ERROR_SOCSERV_TRANSPORT

const ERROR_SOCSERV_TRANSPORT = 'ERROR_SOCSERV_TRANSPORT'

См. определение в файле network.php строка 30

EXTERNAL_AUTH_ID

const EXTERNAL_AUTH_ID = 'replica'

См. определение в файле network.php строка 34

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/socialservices/lib/network.php