BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
BlueSpice\Social\Groups\Entity\Group Class Reference
Inheritance diagram for BlueSpice\Social\Groups\Entity\Group:
Collaboration diagram for BlueSpice\Social\Groups\Entity\Group:

Public Member Functions

 getFullData ($a=array())
 
 setValuesByObject (\stdClass $o)
 
 getHeader ($oMsg=null)
 
 getHeaderWithTitle ($oMsg=null)
 
 getGroupName ()
 
 getNamespaceIndex ()
 
 setGroupName ($sGroupName)
 
 setNamespaceIndex ($iNsIdx)
 
 getRelatedTitle ()
 
 getGroupedEntities (array $aOptions=[], array $aFilters=[])
 
 save (\User $oUser=null, $aOptions=array())
 
 delete (\User $oUser=null, $aOptions=array())
 
 invalidateCache ()
 
- Public Member Functions inherited from BlueSpice\Social\Entity\Page
 getFullData ($a=array())
 
 setValuesByObject (\stdClass $o)
 
 getDescription ()
 
 setDescription ($sDescription)
 
- Public Member Functions inherited from BlueSpice\Social\Entity
 getConfig ()
 
 getOwnerID ()
 
 getOwner ()
 
 getOwnerName ()
 
 getOwnerRealName ()
 
 getTimestampTouched ()
 
 getTimestampCreated ()
 
 getHeaderMessageKey ()
 
 getHeader ($oMsg=null)
 
 save (\User $oUser=null, $aOptions=array())
 
 delete (\User $oUser=null, $aOptions=array())
 
 deleteChildren (\User $oUser)
 
 getFullData ($a=array())
 
 getChildren ($aOptions=array(), $aFilters=array(), $bForceReload=false, $bCheckPermission=true)
 
 getAttachments ($bForceInvalidateFirst=false)
 
 hasParent ()
 
 getParent ()
 
 getParentID ()
 
 setParentID ($iID)
 
 setValuesByObject (\stdClass $o)
 
 render ($sType= 'Default', $bNoCache=false)
 
 getOutput ()
 
 getRelatedTitle ()
 
 getVarMessage ($sVarName)
 
 userCan ($sAction= 'read',\User $oUser=null)
 
 getActions (array $aActions=[],\User $oUser=null)
 
 invalidateCache ()
 
- Public Member Functions inherited from BlueSpice\Entity
 getConfig ()
 
 getTitle ()
 
 getTimestampTouched ()
 
 getTimestampCreated ()
 
 save (\User $oUser=null, $aOptions=[])
 
 delete (\User $oUser=null, $aOptions=[])
 
 getFullData ($aData=array())
 
 exists ()
 
 isArchived ()
 
 hasUnsavedChanges ()
 
 getID ()
 
 getOwnerID ()
 
 getType ()
 
 setUnsavedChanges ($bStatus=true)
 
 setOwnerID ($iOwnerID)
 
 toJson ()
 
 jsonSerialize ()
 
 setValuesByObject (\stdClass $oData)
 
 userIsOwner (\User $oUser)
 
 invalidateCache ()
 

Static Public Member Functions

static newFromNamespaceIndex ($iNsIdx)
 
- Static Public Member Functions inherited from BlueSpice\Entity
static newFromFactory (\stdClass $data, EntityConfig $oConfig, EntityFactory $entityFactory)
 
static newFromContent (EntityContent $sContent)
 
static newFromObject ($oObject)
 
static getTitleFor ($iID)
 
static newFromID ($iID, $bForceReload=false)
 
static newFromTitle (\Title $oTitle, $bForceReload=false)
 

Protected Member Functions

 deleteGroupedEntities ($oUser, $aOptions)
 
- Protected Member Functions inherited from BlueSpice\Social\Entity
 getChildrenFromIndex ()
 
 checkPermission ($sAction,\User $oUser,\Title $oTitle=null)
 
- Protected Member Functions inherited from BlueSpice\Entity
 __construct (\stdClass $oStdClass, EntityConfig $oConfig, EntityFactory $entityFactory=null)
 
 invalidateTitleCache ($purgeTime=null)
 

Protected Attributes

 $sType = 'group'
 
 $sGroupName = ''
 
 $iNamespaceIndex = 0
 
- Protected Attributes inherited from BlueSpice\Social\Entity\Page
 $sDescription = ''
 
- Protected Attributes inherited from BlueSpice\Social\Entity
 $aChildren = null
 
 $oOutput = null
 
 $iParentID = 0
 
- Protected Attributes inherited from BlueSpice\Entity
 $entityFactory = null
 
 $bUnsavedChanges = true
 
 $oConfig = null
 
 $iID = 0
 
 $iOwnerID = 0
 
 $sType = ''
 
 $bArchived = false
 

Additional Inherited Members

- Public Attributes inherited from BlueSpice\Social\Entity
const NS = NS_BSSOCIAL
 
- Public Attributes inherited from BlueSpice\Entity
const NS = -1
 
const ATTR_TYPE = 'type'
 
const ATTR_ID = 'id'
 
const ATTR_OWNER_ID = 'ownerid'
 
const ATTR_ARCHIVED = 'archived'
 
const ATTR_PARENT_ID = 'parentid'
 
const ATTR_TIMESTAMP_CREATED = 'timestampcreated'
 
const ATTR_TIMESTAMP_TOUCHED = 'timestamptouched'
 

Member Function Documentation

BlueSpice\Social\Groups\Entity\Group::delete ( \User  $oUser = null,
  $aOptions = array() 
)

Deletes the current BSSocialEntity

Returns
Status
BlueSpice\Social\Groups\Entity\Group::getFullData (   $a = array())

Gets the BSSociaEntityPage attributes formated for the api

Returns
object
BlueSpice\Social\Groups\Entity\Group::getGroupedEntities ( array  $aOptions = [],
array  $aFilters = [] 
)

Returns an array of the entitys with this group

Returns
status
BlueSpice\Social\Groups\Entity\Group::getGroupName ( )

Returns the group name

Returns
String
BlueSpice\Social\Groups\Entity\Group::getNamespaceIndex ( )

Returns the namespace index

Returns
integer
static BlueSpice\Social\Groups\Entity\Group::newFromNamespaceIndex (   $iNsIdx)
static
Parameters
integer$iNsIdx
Returns
Group | null
BlueSpice\Social\Groups\Entity\Group::setGroupName (   $sGroupName)

Sets the group name

Parameters
string
Returns
BSSociaEntityPage
BlueSpice\Social\Groups\Entity\Group::setNamespaceIndex (   $iNsIdx)

Sets the namespace index

Parameters
string
Returns
BSSociaEntityPage

The documentation for this class was generated from the following file: