Bitrix API

NodeMemberRepository

Table of Contents

Methods

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 NodeMember by its ID.
findFirstByEntityIdAndEntityTypeAndNodeTypeAndActive()  : NodeMember|null
Finds the first NodeMember by the given entity ID, entity type, node type, and active status.
getCommonUsersFromRelation()  : mixed
remove()  : bool
removeAllMembersByNodeId()  : void
removeByCollection()  : bool
setActiveByEntityTypeAndEntityId()  : Result
setActiveByEntityTypeAndEntityIds()  : Result
update()  : NodeMember
updateByCollection()  : NodeMemberCollection

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
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

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
Return values
NodeMemberCollection

findAllByRoleIdAndNodeId()

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

findById()

Finds a NodeMember by its ID.

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

The ID of the NodeMember to find.

Return values
NodeMember|null

The found NodeMember object or null if not found.

findFirstByEntityIdAndEntityTypeAndNodeTypeAndActive()

Finds the first NodeMember by the given entity ID, entity type, node type, and active status.

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

removeAllMembersByNodeId()

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

setActiveByEntityTypeAndEntityIds()

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

        
On this page

Search results