Bitrix API

NodeMemberRepository implements NodeMemberRepository

Table of Contents

Interfaces

NodeMemberRepository

Constants

NODE_MEMBER_CACHE_DIR  = '/node/member/'

Methods

__construct()  : mixed
countAllByByNodeId()  : int
Counts all members by the given node ID.
countAllByStructureAndGroupByNode()  : array<int, int>
create()  : NodeMember
createByCollection()  : NodeMemberCollection
findAllByEntityIdAndEntityType()  : NodeMemberCollection
Finds all NodeMembers by their entity ID and entity type.
findAllByEntityIdAndEntityTypeAndNodeType()  : NodeMemberCollection
findAllByEntityIdsAndEntityType()  : NodeMemberCollection
Finds all NodeMembers by their entity ID and entity type.
findAllByEntityIdsAndEntityTypeAndNodeType()  : NodeMemberCollection
findAllByNodeId()  : NodeMemberCollection
findAllByNodeIdAndEntityType()  : NodeMemberCollection
findAllByRoleIdAndNodeCollection()  : NodeMemberCollection
findAllByRoleIdAndNodeId()  : NodeMemberCollection
findAllByRoleIdAndStructureId()  : NodeMemberCollection
findByEntityTypeAndEntityIdAndNodeId()  : NodeMember|null
findById()  : NodeMember|null
Finds a node member by their ID.
findFirstByEntityIdAndEntityTypeAndNodeTypeAndActive()  : NodeMember|null
Finds the first node member by their entity ID and entity type.
getCommonUsersFromRelation()  : array<string|int, mixed>
remove()  : bool
removeAllMembersByNodeId()  : void
removeByCollection()  : bool
setActiveByEntityTypeAndEntityId()  : Result
setActiveByEntityTypeAndEntityIds()  : Result
update()  : NodeMember
Represents a member in the Item's node.
updateByCollection()  : NodeMemberCollection

Constants

Methods

countAllByByNodeId()

Counts all members by the given node ID.

public countAllByByNodeId(int $nodeId) : int

This method takes a node ID as a parameter and returns the total count of members associated with that node.

Parameters
$nodeId : int
Return values
int

The total count of members associated with the given node ID.

countAllByStructureAndGroupByNode()

public countAllByStructureAndGroupByNode(Structure $structure) : array<int, int>
Parameters
$structure : Structure
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<int, int>

findAllByEntityIdAndEntityTypeAndNodeType()

public findAllByEntityIdAndEntityTypeAndNodeType(int $entityId, MemberEntityType $entityType, NodeEntityType $nodeType[, int $limit = 0 ][, int $offset = 0 ][, NodeActiveFilter $activeFilter = NodeActiveFilter::ONLY_GLOBAL_ACTIVE ]) : NodeMemberCollection
Parameters
$entityId : int
$entityType : MemberEntityType
$nodeType : NodeEntityType
$limit : int = 0
$offset : int = 0
$activeFilter : NodeActiveFilter = NodeActiveFilter::ONLY_GLOBAL_ACTIVE
Return values
NodeMemberCollection

findAllByEntityIdsAndEntityTypeAndNodeType()

public findAllByEntityIdsAndEntityTypeAndNodeType(array<string|int, mixed> $entityIds, MemberEntityType $entityType, NodeEntityType $nodeType[, NodeActiveFilter $activeFilter = NodeActiveFilter::ONLY_GLOBAL_ACTIVE ]) : NodeMemberCollection
Parameters
$entityIds : array<string|int, mixed>
$entityType : MemberEntityType
$nodeType : NodeEntityType
$activeFilter : NodeActiveFilter = NodeActiveFilter::ONLY_GLOBAL_ACTIVE
Return values
NodeMemberCollection

findAllByNodeId()

public findAllByNodeId(int $nodeId[, bool $withAllChildNodes = false ][, int $limit = 100 ][, int $offset = 0 ][, bool $onlyActive = true ]) : NodeMemberCollection
Parameters
$nodeId : int
$withAllChildNodes : bool = false
$limit : int = 100
$offset : int = 0
$onlyActive : bool = true
Tags
throws
ObjectPropertyException
throws
ArgumentException
throws
WrongStructureItemException
throws
SystemException
Return values
NodeMemberCollection

findAllByRoleIdAndNodeCollection()

public findAllByRoleIdAndNodeCollection(int|null $roleId, NodeCollection $nodeCollection[, int $limit = 0 ][, int $offset = 0 ][, bool $ascendingSort = true ]) : NodeMemberCollection
Parameters
$roleId : int|null
$nodeCollection : NodeCollection
$limit : int = 0
$offset : int = 0
$ascendingSort : bool = true
Tags
throws
ArgumentException
throws
WrongStructureItemException
throws
ObjectPropertyException
throws
SystemException
Return values
NodeMemberCollection

findAllByRoleIdAndNodeId()

public findAllByRoleIdAndNodeId(int|null $roleId, int|null $nodeId[, int|null $limit = null ][, int|null $offset = null ][, bool $ascendingSort = true ]) : NodeMemberCollection
Parameters
$roleId : int|null
$nodeId : int|null
$limit : int|null = null
$offset : int|null = null
$ascendingSort : bool = true
Tags
throws
ArgumentException
throws
WrongStructureItemException
throws
ObjectPropertyException
throws
SystemException
Return values
NodeMemberCollection

findByEntityTypeAndEntityIdAndNodeId()

public findByEntityTypeAndEntityIdAndNodeId(MemberEntityType $entityType, int $entityId, int $nodeId) : NodeMember|null
Parameters
$entityType : MemberEntityType
$entityId : int
$nodeId : int
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
NodeMember|null

findById()

Finds a node member by their ID.

public findById(int $memberId) : NodeMember|null
Parameters
$memberId : int

The ID of the node member to find.

Return values
NodeMember|null

The found node member, or null if not found.

findFirstByEntityIdAndEntityTypeAndNodeTypeAndActive()

Finds the first node member by their entity ID and entity type.

public findFirstByEntityIdAndEntityTypeAndNodeTypeAndActive(int $entityId, MemberEntityType $entityType, NodeEntityType $nodeType[, bool|null $active = null ]) : NodeMember|null
Parameters
$entityId : int
$entityType : MemberEntityType
$nodeType : NodeEntityType
$active : bool|null = null
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
NodeMember|null

getCommonUsersFromRelation()

public getCommonUsersFromRelation(RelationEntityType $entityType, int $entityId, array<string|int, mixed> $usersToCompare) : array<string|int, mixed>
Parameters
$entityType : RelationEntityType
$entityId : int
$usersToCompare : array<string|int, mixed>
Return values
array<string|int, mixed>

removeAllMembersByNodeId()

public removeAllMembersByNodeId(int $nodeId) : void
Parameters
$nodeId : int
Tags
throws
ArgumentException
throws
SqlQueryException
throws
SystemException

setActiveByEntityTypeAndEntityIds()

public setActiveByEntityTypeAndEntityIds(MemberEntityType $entityType, array<string|int, mixed> $entityIds, bool $active) : Result
Parameters
$entityType : MemberEntityType
$entityIds : array<string|int, mixed>
$active : bool
Return values
Result

        
On this page

Search results