Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
StudipNews Class Reference
Inheritance diagram for StudipNews:
SimpleORMap PrivacyObject

Public Member Functions

 restoreRanges ()
 
 getRanges ()
 
 issetRange ($range_id)
 
 addRange ($range_id)
 
 deleteRange ($range_id)
 
 storeRanges ()
 
 delete ()
 
 havePermission ($operation, $check_range_id= '', $user_id=null)
 
 validate ()
 
- Public Member Functions inherited from SimpleORMap
 __construct ($id=null)
 
 __clone ()
 
 getRelationOptions ($relation)
 
 getTableMetadata ()
 
 hasAutoIncrementColumn ()
 
 setId ($id)
 
 getId ()
 
 getNewId ()
 
 toArray ($only_these_fields=null)
 
 toRawArray ($only_these_fields=null)
 
 toArrayRecursive ($only_these_fields=null)
 
 getValue ($field)
 
 getRelationValue ($relation, $field)
 
 getDefaultValue ($field)
 
 setValue ($field, $value)
 
 __get ($field)
 
 __set ($field, $value)
 
 __isset ($field)
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 
 getIterator ()
 
 count ()
 
 isField ($field)
 
 isAdditionalField ($field)
 
 isAliasField ($field)
 
 isI18nField ($field)
 
 setData ($data, $reset=false)
 
 isNew ()
 
 isDeleted ()
 
 setNew ($is_new)
 
 getWhereQuery ()
 
 restore ()
 
 store ()
 
 triggerChdate ()
 
 delete ()
 
 isDirty ()
 
 isFieldDirty ($field)
 
 revertValue ($field)
 
 getPristineValue ($field)
 
 initRelation ($relation)
 
 resetRelation ($relation)
 
 cleanup ()
 

Static Public Member Functions

static GetNewsByRange ($range_id, $only_visible=false, $as_objects=false)
 
static CountUnread ($range_id= 'studip', $user_id=false)
 
static GetNewsByAuthor ($user_id, $as_objects=false)
 
static GetNewsByRSSId ($rss_id, $as_objects=false)
 
static GetNewsObjects ($news_result)
 
static GetNewsRangesByFilter ($user_id, $area= '', $term= '', $startdate=0, $enddate=0, $as_objects=false, $limit=100)
 
static GetUserIdFromRssID ($rss_id)
 
static GetRssIdFromUserId ($user_id)
 
static GetRangeFromRssID ($rss_id)
 
static GetRangeIdFromRssID ($rss_id)
 
static GetRssIdFromRangeId ($range_id)
 
static SetRssId ($range_id, $type=false)
 
static UnsetRssId ($range_id)
 
static GetAdminMsg ($user_id, $date)
 
static DoGarbageCollect ($news_deletion_days=false)
 
static DeleteNewsRanges ($range_id)
 
static DeleteNewsByAuthor ($user_id)
 
static haveRangePermission ($operation, $range_id, $user_id= '')
 
static exportUserData (StoredUserData $storage)
 
- Static Public Member Functions inherited from SimpleORMap
static tableScheme ($db_table)
 
static expireTableScheme ()
 
static exists ($id)
 
static countBySql ($sql= '1', $params=[])
 
static create ($data)
 
static buildExisting ($data)
 
static import ($data)
 
static findBySQL ($sql, $params=[])
 
static findOneBySQL ($where, $params=[])
 
static findThru ($foreign_key_value, $options)
 
static findEachBySQL ($callable, $sql, $params=[])
 
static findMany ($pks=[], $order= '', $order_params=[])
 
static findEachMany ($callable, $pks=[], $order= '', $order_params=[])
 
static findAndMapBySQL ($callable, $where, $params=[])
 
static findAndMapMany ($callable, $pks=[], $order= '', $order_params=[])
 
static deleteBySQL ($where, $params=[])
 
static toObject ($id_or_object)
 
static __callStatic ($name, $arguments)
 

Static Protected Member Functions

static configure ($config=[])
 
- Static Protected Member Functions inherited from SimpleORMap
static db_table ()
 
static db_fields ()
 
static pk ()
 
static default_values ()
 
static serialized_fields ()
 
static alias_fields ()
 
static i18n_fields ()
 
static additional_fields ()
 
static has_many ()
 
static has_one ()
 
static belongs_to ()
 
static has_and_belongs_to_many ()
 
static registered_callbacks ()
 
static known_slots ()
 
static notification_map ()
 
static getter_setter_map ()
 
static configure ($config=[])
 
static config ($key)
 
static registerCallback ($types, $cb)
 
static unregisterCallback ($types, $cb)
 

Additional Inherited Members

- Data Fields inherited from SimpleORMap
const ID_SEPARATOR = '_'
 
- Static Public Attributes inherited from SimpleORMap
static $schemes = null
 
- Protected Member Functions inherited from SimpleORMap
 _getId ($field)
 
 _setId ($field, $value)
 
 _getAdditionalValueFromRelation ($field)
 
 _setAdditionalValueFromRelation ($field, $value)
 
 _getAdditionalValue ($field)
 
 _setAdditionalValue ($field, $value)
 
 parseRelationOptions ($type, $name, $options)
 
 storeRelations ($only_these=null)
 
 deleteRelations ()
 
 initializeContent ()
 
 applyCallbacks ($type)
 
 cbAutoIncrementColumn ($type)
 
 cbAutoKeyCreation ()
 
 cbNotificationMapper ($cb_type)
 
 cbAfterInitialize ($cb_type)
 
 setSerializedValue ($field, $value)
 
 setI18nValue ($field, $value)
 
- Protected Attributes inherited from SimpleORMap
 $content = []
 
 $content_db = []
 
 $is_new = true
 
 $is_deleted = false
 
 $relations = []
 
 $additional_data = []
 
- Static Protected Attributes inherited from SimpleORMap
static $config = []
 
static $reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']
 
static $performs_batch_operation = false
 

Member Function Documentation

addRange (   $range_id)
static configure (   $config = [])
staticprotected
static CountUnread (   $range_id = 'studip',
  $user_id = false 
)
static
delete ( )
static DeleteNewsByAuthor (   $user_id)
static
static DeleteNewsRanges (   $range_id)
static
deleteRange (   $range_id)
static DoGarbageCollect (   $news_deletion_days = false)
static
static exportUserData ( StoredUserData  $storage)
static

Export available data of a given user into a storage object (an instance of the StoredUserData class) for that user.

Parameters
StoredUserData$storageobject to store data into

Implements PrivacyObject.

static GetAdminMsg (   $user_id,
  $date 
)
static
static GetNewsByAuthor (   $user_id,
  $as_objects = false 
)
static
static GetNewsByRange (   $range_id,
  $only_visible = false,
  $as_objects = false 
)
static
static GetNewsByRSSId (   $rss_id,
  $as_objects = false 
)
static
static GetNewsObjects (   $news_result)
static
static GetNewsRangesByFilter (   $user_id,
  $area = '',
  $term = '',
  $startdate = 0,
  $enddate = 0,
  $as_objects = false,
  $limit = 100 
)
static

fetches set of news items from database

Parameters
string$user_idauthor id for news set
string$areaarea group for news set (global, inst, sem or user)
string$termsearch term for news topic
int$startdatereturn only news (still) visible after this date
int$enddatereturn only news (still) visible before this date
boolean$as_objectsinclude StudipNews objects in result array
int$limitmax size of returned news set
Returns
array set of news items
static GetRangeFromRssID (   $rss_id)
static
static GetRangeIdFromRssID (   $rss_id)
static
getRanges ( )
static GetRssIdFromRangeId (   $range_id)
static
static GetRssIdFromUserId (   $user_id)
static
static GetUserIdFromRssID (   $rss_id)
static
havePermission (   $operation,
  $check_range_id = '',
  $user_id = null 
)

checks, if user has permission to perform given operation on news object

Parameters
string$operationdelete, unassign, edit, copy, or view
string$check_range_idspecified range-id, used only for unassign-operation
string$user_idoptional; check permission for given user ID; otherwise for the global $user's ID
Returns
boolean true or false
static haveRangePermission (   $operation,
  $range_id,
  $user_id = '' 
)
static
issetRange (   $range_id)
restoreRanges ( )
static SetRssId (   $range_id,
  $type = false 
)
static
storeRanges ( )
static UnsetRssId (   $range_id)
static
validate ( )

checks, if basic news data is complete

Returns
boolean true or false

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