Studip Class Reference
Inheritance diagram for Studip:
Collaboration diagram for Studip:
Static Public Member Functions | |
| static | detect () |
 Static Public Member Functions inherited from Base | |
| static | detect () |
| static | addType ($type, $class) |
| static | removeType ($type) |
| static | find ($id) |
| static | findAll () |
| static | create ($type) |
| static | detectConsumer ($type=null, $request_type=null, $request_body=null) |
| Static Public Member Functions inherited from SimpleORMap | |
| static | tableScheme ($db_table) |
| 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 | 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) |
Additional Inherited Members | |
| Public Member Functions inherited from Base | |
| __construct ($id=null, $user=null) | |
| getPermissions () | |
| setUser ($user) | |
| hasUser () | |
| getUser () | |
| 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 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) | |
| registerCallback ($types, $cb) | |
| unregisterCallback ($types, $cb) | |
| cbAutoIncrementColumn ($type) | |
| cbAutoKeyCreation () | |
| cbNotificationMapper ($cb_type) | |
| cbAfterInitialize ($cb_type) | |
| setSerializedValue ($field, $value) | |
| setI18nValue ($field, $value) | |
| cbI18N ($type) | |
| Static Protected Member Functions inherited from Base | |
| static | configure ($config=[]) |
| Static Protected Member Functions inherited from SimpleORMap | |
| static | configure ($config=array()) |
| static | config ($key) |
| Protected Attributes inherited from Base | |
| $user = null | |
| 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() | |
| $i18n_fields = array() | |
| $additional_fields = array() | |
| $relations = array() | |
| $has_many = array() | |
| $has_one = array() | |
| $belongs_to = array() | |
| $has_and_belongs_to_many = array() | |
| $registered_callbacks = array() | |
| $known_slots = array() | |
| $notification_map = array() | |
| $additional_data = array() | |
| $getter_setter_map = array() | |
| Static Protected Attributes inherited from Base | |
| static | $known_types = array() |
| Static Protected Attributes inherited from SimpleORMap | |
| static | $config = array() |
| static | $reserved_slots = array('value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id') |
Detailed Description
Stud.IP Session Consumer for the rest api
- Since
- Stud.IP 3.0
Member Function Documentation
◆ detect()
|
static |
Detects a user via the Stud.IP session. If a session is present and valid, the auth and user object have already been set up by stud.ip functions, so we just need to check if these are present.
- Returns
- mixed Instance of self if authentication was detected, false otherwise
The documentation for this class was generated from the following file:
- lib/classes/restapi/consumer/Studip.php
