Класс BlogUser

Открытые члены
	addAvatarSize ($width, $height, $key="")
	__construct ($cacheTime=0)
	setBlogId ($id)
	setCacheTime ($cacheTime)
	getUsers ($ids=array())

Открытые статические члены
static	cleanCache ($blogId=NULL)
static	getCommentAuthorsIdsByPostId ($postId)
static	getPostAuthorsIdsByBlogId ($blogId)
static	getPostAuthorsIdsByDbFilter ($arFilter)
static	GetUserName ($alias, $name, $lastName, $login, $secondName="")
static	GetUserNameEx ($user, $blogUser, $params)
static	isUserGivenConsent ($userId, $agreementId)
static	onUserDelete ($userId=NULL)

Открытые атрибуты
const	CACHE_ID = 'BLOG_USERS'

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

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

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

__construct()

__construct

(

$cacheTime = 0

)

Blog users can be saved in cache or get from DB. To cached - set cacheTime

BlogUser constructor.

Аргументы

int

$cacheTime

- integer - value of cache TTL

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

Методы

addAvatarSize()

addAvatarSize	(		$width,
			$height,
			$key = "" )

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

cleanCache()

static cleanCache ( $blogId = NULL )

static

Delete all data from blog users cache

Возвращает

mixed

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

getCommentAuthorsIdsByPostId()

static getCommentAuthorsIdsByPostId ( $postId )

static

Return users ids of post author and comments authors (for this post)

Аргументы

$postId

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

getPostAuthorsIdsByBlogId()

static getPostAuthorsIdsByBlogId ( $blogId )

static

Return users ids of blog posts

Аргументы

$blogId

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

getPostAuthorsIdsByDbFilter()

static getPostAuthorsIdsByDbFilter ( $arFilter )

static

Return IDs of post authors by custom selection

Аргументы

$arFilter

Возвращает

array

Исключения

ArgumentNullException

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

GetUserName()

static GetUserName ( $alias, $name, $lastName, $login, $secondName = "" )

static

Creat correctly blog user name from name, alias and login

Аргументы

	$alias
	$name
	$lastName
	$login
string	$secondName

Возвращает

string

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

GetUserNameEx()

static GetUserNameEx ( $user, $blogUser, $params )

static

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

getUsers()

getUsers

(

$ids = array()

)

Get users from cache (if set cache time) or from DB.

Аргументы

array

$ids

- array of users ids

Возвращает

array|bool

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

isUserGivenConsent()

static isUserGivenConsent ( $userId, $agreementId )

static

Check, is user given consent for current agreement ever in the past. Consent checked based on component URL, it means, that if URL will be changed, result will be false again.

Аргументы

$userId

- ID of main user (not blog user!)

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

onUserDelete()

static onUserDelete ( $userId = NULL )

static

Handles onUserDelete main module event

Возвращает

bool

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

setBlogId()

setBlogId

(

$id

)

Blog ID using to separate cache for different blogs

Аргументы

$id

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

setCacheTime()

setCacheTime

(

$cacheTime

)

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

Данные класса

CACHE_ID

const CACHE_ID = 'BLOG_USERS'

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