ISystemTag
in
Public interface for a system-wide tag.
Tags
Table of Contents
Constants
- ACCESS_LEVEL_INVISIBLE = 2
- ACCESS_LEVEL_LOOKUP = [\OCP\SystemTag\ISystemTag::ACCESS_LEVEL_PUBLIC => 'public', \OCP\SystemTag\ISystemTag::ACCESS_LEVEL_RESTRICTED => 'restricted', \OCP\SystemTag\ISystemTag::ACCESS_LEVEL_INVISIBLE => 'invisible']
- ACCESS_LEVEL_PUBLIC = 0
- ACCESS_LEVEL_RESTRICTED = 1
Methods
- getAccessLevel() : int
- Returns a term summarizing the access control flags
- getETag() : string|null
- Returns the ETag of the tag The ETag is a unique identifier for the tag and should change whenever the tag changes or whenever elements gets added or removed from the tag.
- getId() : string
- Returns the tag id
- getName() : string
- Returns the tag display name
- isUserAssignable() : bool
- Returns whether the tag can be assigned to objects by regular users
- isUserVisible() : bool
- Returns whether the tag is visible for regular users
Constants
ACCESS_LEVEL_INVISIBLE
public
mixed
ACCESS_LEVEL_INVISIBLE
= 2
Tags
ACCESS_LEVEL_LOOKUP
public
mixed
ACCESS_LEVEL_LOOKUP
= [\OCP\SystemTag\ISystemTag::ACCESS_LEVEL_PUBLIC => 'public', \OCP\SystemTag\ISystemTag::ACCESS_LEVEL_RESTRICTED => 'restricted', \OCP\SystemTag\ISystemTag::ACCESS_LEVEL_INVISIBLE => 'invisible']
Tags
ACCESS_LEVEL_PUBLIC
public
mixed
ACCESS_LEVEL_PUBLIC
= 0
Tags
ACCESS_LEVEL_RESTRICTED
public
mixed
ACCESS_LEVEL_RESTRICTED
= 1
Tags
Methods
getAccessLevel()
Returns a term summarizing the access control flags
public
getAccessLevel() : int
Tags
Return values
int —the level of access control
getETag()
Returns the ETag of the tag The ETag is a unique identifier for the tag and should change whenever the tag changes or whenever elements gets added or removed from the tag.
public
getETag() : string|null
Tags
Return values
string|nullgetId()
Returns the tag id
public
getId() : string
Tags
Return values
string —id
getName()
Returns the tag display name
public
getName() : string
Tags
Return values
string —tag display name
isUserAssignable()
Returns whether the tag can be assigned to objects by regular users
public
isUserAssignable() : bool
Tags
Return values
bool —true if assignable, false otherwise
isUserVisible()
Returns whether the tag is visible for regular users
public
isUserVisible() : bool
Tags
Return values
bool —true if visible, false otherwise