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

Public Member Functions

 addItem ($range_id=null, $range_type= 'StudipItem')
 
 removeItem ($range_id=null)
 
 getContent ()
 
 getAllRangeIds ($range_types= 'StudipItem')
 
 getSomeRangeIds ($range_types= 'StudipItem', $item_ids=[])
 
- 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 getClipboardsForUser ($user_id= '', $item_range_types=[])
 
- 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

addItem (   $range_id = null,
  $range_type = 'StudipItem' 
)

Adds an item to the clipboard by specifying the ID of the object that shall be added to it.

Parameters
string$range_idThe ID of the object that shall be added.
Exceptions
ClipboardExceptionIf an error occurs.
Returns
ClipboardItem A ClipboardItem instance on success, false on failure.
static configure (   $config = [])
staticprotected
getAllRangeIds (   $range_types = 'StudipItem')

Retrieves all range-IDs of objects that are associated with this clipboard. The objects can be filtered by their range type.

Parameters
string|string[]$range_types The class name(s) of the objects which shall be included in the result set. This parameter can be a string or an array of strings.
Returns
string[] An array with all range-IDs that match the specified range type.
static getClipboardsForUser (   $user_id = '',
  $item_range_types = [] 
)
static

This class returns all clipboards for a specified user, optionally filtered by required item range types.

Parameters
string$user_id,:The ID of the user whose clipboards shall be returned.
array$item_range_types,:The range types which at least one item of the clipboard must have to be included in the result set.
Returns
Clipboard[] An array of clipboard objects which are associated with the user specified by $user_id.
getContent ( )

Formats the content of the clipboard for display. This method should be overloaded by derived classes to output the data of the clipboard with appropriate names and other attributes which may be needed.

Returns
string[][] A two-dimensional array with strings. The first dimension represents the list of clipboard items. The second dimension represents an item and holds at least the following attributes of the item: id, name. These attributes are the keys of the second array dimension. The array has the following structure: [ [ 'id' => (id of the item) 'name' => (name of the item) ], [ … ] ]

Derived classes may add further attributes to the array, if necessary.

getSomeRangeIds (   $range_types = 'StudipItem',
  $item_ids = [] 
)

Retrieves specific range-IDs of objects that are associated with this clipboard and referenced by the specified clipboard item-IDs. The objects can be filtered by their range type, too.

Parameters
string|string[]$range_types The class name(s) of the objects which shall be included in the result set. This parameter can be an array or a string.
string[]$item_ids The item-IDs of the clipboard items whose range-IDs shall be included in the result set. Note that the clipboard items must be associated with this clipboard.
Returns
string[] An array with all range-IDs that match the specified range type.
removeItem (   $range_id = null)

Removes an item from the clipboard by specifying the ID of the object that shall be removed from the pad.

Parameters
string$range_idThe ID of the object that shall be removed.
Returns
bool True on success, false on failure.

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