StudipNews Class Reference

Inheritance diagram for StudipNews:

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)
	isRelation ($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	build ($data, $is_new=true)
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 (string $name, array $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)
	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()

addRange

(

$range_id

)

configure()

static configure (   $config = [] )

staticprotected

CountUnread()

static CountUnread (   $range_id = 'studip',   $user_id = false  )

static

delete()

delete

(

)

DeleteNewsByAuthor()

static DeleteNewsByAuthor (   $user_id )

static

DeleteNewsRanges()

static DeleteNewsRanges (   $range_id )

static

deleteRange()

deleteRange

(

$range_id

)

DoGarbageCollect()

static DoGarbageCollect (   $news_deletion_days = false )

static

exportUserData()

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

$storage

object to store data into

Implements PrivacyObject.

GetAdminMsg()

static GetAdminMsg (   $user_id,   $date  )

static

GetNewsByAuthor()

static GetNewsByAuthor (   $user_id,   $as_objects = false  )

static

GetNewsByRange()

static GetNewsByRange (   $range_id,   $only_visible = false,   $as_objects = false  )

static

GetNewsByRSSId()

static GetNewsByRSSId (   $rss_id,   $as_objects = false  )

static

GetNewsObjects()

static GetNewsObjects (   $news_result )

static

GetNewsRangesByFilter()

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_id	author id for news set
string	$area	area group for news set (global, inst, sem or user)
string	$term	search term for news topic
int	$startdate	return only news (still) visible after this date
int	$enddate	return only news (still) visible before this date
boolean	$as_objects	include StudipNews objects in result array
int	$limit	max size of returned news set

Returns

array set of news items

GetRangeFromRssID()

static GetRangeFromRssID (   $rss_id )

static

GetRangeIdFromRssID()

static GetRangeIdFromRssID (   $rss_id )

static

getRanges()

getRanges

(

)

GetRssIdFromRangeId()

static GetRssIdFromRangeId (   $range_id )

static

GetRssIdFromUserId()

static GetRssIdFromUserId (   $user_id )

static

GetUserIdFromRssID()

static GetUserIdFromRssID (   $rss_id )

static

havePermission()

havePermission	(		$operation,
			$check_range_id = '',
			$user_id = null
	)

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

Parameters

string	$operation	delete, unassign, edit, copy, or view
string	$check_range_id	specified range-id, used only for unassign-operation
string	$user_id	optional; check permission for given user ID; otherwise for the global $user's ID

Returns

boolean true or false

haveRangePermission()

static haveRangePermission (   $operation,   $range_id,   $user_id = ''  )

static

issetRange()

issetRange

(

$range_id

)

restoreRanges()

restoreRanges

(

)

SetRssId()

static SetRssId (   $range_id,   $type = false  )

static

storeRanges()

storeRanges

(

)

UnsetRssId()

static UnsetRssId (   $range_id )

static

validate()

validate

(

)

checks, if basic news data is complete

Returns

boolean true or false

---

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

• lib/models/StudipNews.class.php