Nextcloud PHP API (master)

IBatchMethodsBackend
in

Tags
brief

Optional interface for group backends

since
28.0.0

Table of Contents

Methods

getGroupsDetails()  : array<string, array{displayName?: string}>
groupsExists()  : array<int, string>

Methods

getGroupsDetails()

public getGroupsDetails(array<string|int, mixed> $gids) : array<string, array{displayName?: string}>
Parameters
$gids : array<string|int, mixed>
Tags
brief

Batch method to get the group details of a list of groups

The default implementation in ABackend will just call getGroupDetails in a loop. But a GroupBackend implementation should override this method to provide a more optimized way to execute this operation.

throws
RuntimeException

if called on a backend that doesn't implements IGroupDetailsBackend

since
28.0.0
Return values
array<string, array{displayName?: string}>

groupsExists()

public groupsExists(array<int, string> $gids) : array<int, string>
Parameters
$gids : array<int, string>
Tags
brief

Batch method to check if a list of groups exists

The default implementation in ABackend will just call groupExists in a loop. But a GroupBackend implementation should provides a more optimized override this method to provide a more optimized way to execute this operation.

since
28.0.0
Return values
array<int, string> —

the list of group that exists


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results