Stud.IP  jlu_3.3 Revision
StudipNews Class Reference
Inheritance diagram for StudipNews:
Inheritance graph
Collaboration diagram for StudipNews:
Collaboration graph

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)
 
 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)
 
 setData ($data, $reset=false)
 
 haveData ()
 
 isNew ()
 
 isDeleted ()
 
 setNew ($is_new)
 
 getWhereQuery ()
 
 restore ()
 
 store ()
 
 triggerChdate ()
 
 delete ()
 
 isDirty ()
 
 isFieldDirty ($field)
 
 revertValue ($field)
 
 getPristineValue ($field)
 
 initRelation ($relation)
 
 resetRelation ($relation)
 

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 ()
 
static TouchNews ($news_id, $touch_stamp=null)
 
static DeleteNewsRanges ($range_id)
 
static DeleteNewsByAuthor ($user_id)
 
static haveRangePermission ($operation, $range_id, $user_id='')
 
- Static Public Member Functions inherited from SimpleORMap
static expireTableScheme ()
 
static find ($id)
 
static exists ($id)
 
static countBySql ($sql=1, $params=array())
 
static create ($data)
 
static build ($data, $is_new=true)
 
static buildExisting ($data)
 
static import ($data)
 
static findBySQL ($sql, $params=array())
 
static findByObject (SimpleORMap $object)
 
static findOneBySQL ($where, $params=array())
 
static findThru ($foreign_key_value, $options)
 
static findEachBySQL ($callable, $sql, $params=array())
 
static findMany ($pks=array(), $order='', $order_params=array())
 
static findEachMany ($callable, $pks=array(), $order='', $order_params=array())
 
static findAndMapBySQL ($callable, $where, $params=array())
 
static findAndMapMany ($callable, $pks=array(), $order='', $order_params=array())
 
static deleteBySQL ($where, $params=array())
 
static toObject ($id_or_object)
 
static __callStatic ($name, $arguments)
 

Static Protected Member Functions

static configure ($config=array())
 
- Static Protected Member Functions inherited from SimpleORMap
static configure ($config=array())
 
static tableScheme ($db_table)
 

Additional Inherited Members

- 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)
 
 getTableScheme ()
 
 storeRelations ($only_these=null)
 
 deleteRelations ()
 
 initializeContent ()
 
 applyCallbacks ($type)
 
 registerCallback ($types, $cb)
 
 unregisterCallback ($types, $cb)
 
 cbAutoIncrementColumn ($type)
 
 cbAutoKeyCreation ()
 
 cbNotificationMapper ($cb_type)
 
 setSerializedValue ($field, $value)
 
- Protected Attributes inherited from SimpleORMap
 $content = array()
 
 $content_db = array()
 
 $is_new = true
 
 $is_deleted = false
 
 $db_table = ''
 
 $db_fields = null
 
 $pk = null
 
 $default_values = array()
 
 $serialized_fields = array()
 
 $alias_fields = array()
 
 $additional_fields = array()
 
 $relations = array()
 
 $has_many = array()
 
 $has_one = array()
 
 $belongs_to = array()
 
 $has_and_belongs_to_many = array()
 
 $registered_callbacks
 
 $known_slots = array()
 
 $reserved_slots = array('value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id')
 
 $notification_map = array()
 
 $additional_data = array()
 
- Static Protected Attributes inherited from SimpleORMap
static $schemes = null
 
static $config = array()
 

Member Function Documentation

◆ addRange()

addRange (   $range_id)
Here is the call graph for this function:

◆ configure()

static configure (   $config = array())
staticprotected

set configuration data from subclass

Parameters
array$configconfiguration data
Returns
void

Reimplemented from SimpleORMap.

◆ CountUnread()

static CountUnread (   $range_id = 'studip',
  $user_id = false 
)
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ delete()

delete ( )

delete entry from database the object is cleared, but is not(!) turned to new state

Returns
int number of deleted rows

Reimplemented from SimpleORMap.

Here is the call graph for this function:

◆ DeleteNewsByAuthor()

static DeleteNewsByAuthor (   $user_id)
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ DeleteNewsRanges()

static DeleteNewsRanges (   $range_id)
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ deleteRange()

deleteRange (   $range_id)
Here is the call graph for this function:

◆ DoGarbageCollect()

static DoGarbageCollect ( )
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetAdminMsg()

static GetAdminMsg (   $user_id,
  $date 
)
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetNewsByAuthor()

static GetNewsByAuthor (   $user_id,
  $as_objects = false 
)
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetNewsByRange()

static GetNewsByRange (   $range_id,
  $only_visible = false,
  $as_objects = false 
)
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetNewsByRSSId()

static GetNewsByRSSId (   $rss_id,
  $as_objects = false 
)
static
Here is the call graph for this function:

◆ GetNewsObjects()

static GetNewsObjects (   $news_result)
static
Here is the caller graph for this function:

◆ 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_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
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetRangeFromRssID()

static GetRangeFromRssID (   $rss_id)
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetRangeIdFromRssID()

static GetRangeIdFromRssID (   $rss_id)
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getRanges()

getRanges ( )
Here is the caller graph for this function:

◆ GetRssIdFromRangeId()

static GetRssIdFromRangeId (   $range_id)
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetRssIdFromUserId()

static GetRssIdFromUserId (   $user_id)
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetUserIdFromRssID()

static GetUserIdFromRssID (   $rss_id)
static
Here is the call graph for this function:

◆ havePermission()

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
Here is the call graph for this function:

◆ haveRangePermission()

static haveRangePermission (   $operation,
  $range_id,
  $user_id = '' 
)
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ issetRange()

issetRange (   $range_id)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ restoreRanges()

restoreRanges ( )
Here is the call graph for this function:

◆ SetRssId()

static SetRssId (   $range_id,
  $type = false 
)
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ storeRanges()

storeRanges ( )
Here is the call graph for this function:

◆ TouchNews()

static TouchNews (   $news_id,
  $touch_stamp = null 
)
static

DEPRECATED

◆ UnsetRssId()

static UnsetRssId (   $range_id)
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ validate()

validate ( )

checks, if basic news data is complete

Returns
boolean true or false
Here is the call graph for this function:

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