|
Stud.IP
jlu_3.3 Revision
|
Namespaces | |
| namespace | studip_cores |
Functions | |
| getHeaderLine ($id, $object_name=null) | |
| get_object_name ($range_id, $object_type) | |
| get_object_by_range_id ($range_id) | |
| selectSem ($sem_id) | |
| selectInst ($inst_id) | |
| openSem ($sem_id) | |
| openInst ($inst_id) | |
| checkObject () | |
| checkObjectModule ($module) | |
| closeObject () | |
| get_object_type ($id, $check_only=array()) | |
| select_group ($sem_start_time) | |
| my_substr ($what, $start, $end) | |
| get_global_perm ($user_id="") | |
| get_perm ($range_id, $user_id="") | |
| get_fullname ($user_id="", $format="full", $htmlready=false) | |
| get_fullname_from_uname ($uname="", $format="full", $htmlready=false) | |
| get_vorname ($user_id="") | |
| get_nachname ($user_id="") | |
| get_username ($user_id="") | |
| get_userid ($username="") | |
| TrackAccess ($id, $object_type=null) | |
| get_sem_tree_path ($seminar_id, $depth=false, $delimeter=">") | |
| get_range_tree_path ($institut_id, $depth=false, $delimeter=">") | |
| check_and_set_date ($tag, $monat, $jahr, $stunde, $minute, &$arr, $field) | |
| write_config ($key, $val, $arr=null) | |
| get_config ($key) | |
| get_seminar_dozent ($seminar_id) | |
| re_sort_dozenten ($s_id, $position) | |
| re_sort_tutoren ($s_id, $position) | |
| get_next_position ($status, $seminar_id) | |
| get_seminar_tutor ($seminar_id) | |
| get_seminar_sem_tree_entries ($seminar_id) | |
| get_seminars_user ($user_id) | |
| StringToFloat ($str) | |
| archiv_check_perm ($seminar_id) | |
| get_users_online ($active_time=5, $name_format='full_rev') | |
| get_users_online_count ($active_time=5) | |
| get_ticket () | |
| check_ticket ($studipticket) | |
| search_range ($search_str=false, $search_user=false, $show_sem=true) | |
| format_help_url ($keyword) | |
| remove_magic_quotes ($mixed) | |
| text_excerpt ($text, $phrase, $radius=100, $length=200, $excerpt_string='...') | |
| words ($string) | |
| studip_utf8encode ($data) | |
| studip_utf8decode ($data) | |
| get_title_for_status ($type, $count, $sem_type=NULL) | |
| studip_substr ($string, $offset, $length=false) | |
| studip_strlen ($string) | |
| is_internal_url ($url) | |
| studygroup_sem_types () | |
| addHiddenFields ($variable, $data, $parent=array()) | |
| array_flatten ($ary) | |
| reltime ($timestamp, $verbose=true, $displayed_levels=1, $tolerance=5) | |
| relsize ($size, $verbose=true, $displayed_levels=1, $glue=', ') | |
| get_route ($route='') | |
| match_route ($requested_route, $current_route='') | |
| studip_default_exception_handler ($exception) | |
| addHiddenFields | ( | $variable, | |
| $data, | |||
$parent = array() |
|||
| ) |
generates form fields for the submitted multidimensional array
| string | $variable | the name of the array, which is filled with the data |
| mixed | $data | the data-array |
| mixed | $parent | leave this entry as is |


| archiv_check_perm | ( | $seminar_id | ) |
check which perms the currently logged in user had in the passed archived seminar
@global array $perm @global object $auth @staticvar array $archiv_perms
| string | $seminar_id | the seminar in the archive |

| array_flatten | ( | $ary | ) |
Returns a new array that is a one-dimensional flattening of this array (recursively). That is, for every element that is an array, extract its elements into the new array.
| array | $ary | the array to be flattened |

| check_and_set_date | ( | $tag, | |
| $monat, | |||
| $jahr, | |||
| $stunde, | |||
| $minute, | |||
| & | $arr, | ||
| $field | |||
| ) |
check_and_set_date
Checks if given date is valid and sets field in array accordingly. (E.g. $admin_admission_data['admission_enddate'])
| mixed | $tag | day or placeholder for day |
| mixed | $monat | month or placeholder for month |
| mixed | $jahr | year or placeholder for year |
| mixed | $stunde | hours or placeholder for hours |
| mixed | $minute | minutes or placeholder for minutes |
| array | &$arr | Reference to array to update. If NULL, only check is performed |
| mixed | $field | Name of field in array to be set |
| check_ticket | ( | $studipticket | ) |
check if the passed ticket is valid
| string | $studipticket | the ticket-id to check |


| checkObject | ( | ) |
This function checks, if there is an open Veranstaltung or Einrichtung
@global array $SessSemName
| CheckObjectException |

| checkObjectModule | ( | $module | ) |
This function checks, if given old style module "wiki","scm" (not "CoreWiki") etc. is allowed in this stud.ip-object.
@global array $SessSemName
| string | $module | the module to check for |


| closeObject | ( | ) |
This function closes a opened Veranstaltung or Einrichtung
@global string $SessionSeminar @global array $SessSemName @global string $SemSecLevelRead @global string $SemSecLevelWrite @global string $SemUserStatus @global boolean $rechte @global object $sess


| format_help_url | ( | $keyword | ) |
format_help_url($keyword) returns URL for given help keyword
| string | $keyword | the help-keyword |


| get_config | ( | $key | ) |
gets an entry from the studip configuration table
| string | $key | the key for the config entry |

| get_fullname | ( | $user_id = "", |
|
$format = "full", |
|||
$htmlready = false |
|||
| ) |
Retrieves the fullname for a given user_id
| string | $user_id | if omitted, current user_id is used |
| string | $format | output format |
| bool | $htmlready | if true, htmlReady is applied to all output-strings |


| get_fullname_from_uname | ( | $uname = "", |
|
$format = "full", |
|||
$htmlready = false |
|||
| ) |
Retrieves the fullname for a given username
| string | $uname | if omitted, current user_id is used |
| string | $format | output format |
| bool | $htmlready | if true, htmlReady is applied to all output-strings |


| get_global_perm | ( | $user_id = "" | ) |
The function gives the global perm of an user
It ist recommended to use $auth->auth["perm"] for this query, but the function is useful, if you want to query an user_id from another user (which ist not the current user)
| string | $user_id | if omitted, current user_id is used |

| get_nachname | ( | $user_id = "" | ) |
Retrieves the Nachname for a given user_id
| string | $user_id | if omitted, current user_id is used |


| get_next_position | ( | $status, | |
| $seminar_id | |||
| ) |
return the highest position-number increased by one for the passed user-group in the passed seminar
| string | $status | can be on of 'tutor', 'dozent', ... |
| string | $seminar_id | the seminar to work on |


| get_object_by_range_id | ( | $range_id | ) |
Returns a sorm object for a given range_id
| string | the range_id |

| get_object_name | ( | $range_id, | |
| $object_type | |||
| ) |
returns an array containing name and type of the passed objeact denoted by $range_id
@global array $SEM_TYPE @global array $INST_TYPE @global array $SEM_TYPE_MISC_NAME
| string | $range_id | the id of the object |
| string | $object_type | the type of the object |


| get_object_type | ( | $id, | |
$check_only = array() |
|||
| ) |
This function determines the type of the passed id
The function recognizes the following types at the moment: Einrichtungen, Veranstaltungen, Statusgruppen and Fakultaeten
@staticvar array $object_type_cache
| string | $id | the id of the object |
| array | $check_only | an array to narrow the search, may contain 'sem', 'inst', 'fak', 'group' or 'dokument' (optional) |


| get_perm | ( | $range_id, | |
$user_id = "" |
|||
| ) |
Returns permission for given range_id and user_id
Function works for Veranstaltungen, Einrichtungen, Fakultaeten. admins get status 'admin' if range_id is a seminar
| string | $range_id | an id a Veranstaltung, Einrichtung or Fakultaet |
| string | $user_id | if omitted,current user_id is used |

| get_range_tree_path | ( | $institut_id, | |
$depth = false, |
|||
$delimeter = ">" |
|||
| ) |
Return an array containing the nodes of the range-tree-path
| string | $institut_id | the institute to get the path for |
| int | $depth | the depth |
| string | $delimeter | a string to separate the path parts |

| get_route | ( | $route = '' | ) |
extracts route
| string | $route | route (optional, uses REQUEST_URI otherwise) |

| get_sem_tree_path | ( | $seminar_id, | |
$depth = false, |
|||
$delimeter = ">" |
|||
| ) |
Return an array containing the nodes of the sem-tree-path
| string | $seminar_id | the seminar to get the path for |
| int | $depth | the depth |
| string | $delimeter | a string to separate the path parts |


| get_seminar_dozent | ( | $seminar_id | ) |
get the lecturers and their order-positions in the passed seminar
folgende Funktion ist nur notwendig, wenn die zu kopierende Veranstaltung nicht vom Dozenten selbst, sondern vom Admin oder vom root kopiert wird (sonst wird das Dozentenfeld leer gelassen, was ja keiner will...)
| string | $seminar_id | the seminar to get the lecturers from |

| get_seminar_sem_tree_entries | ( | $seminar_id | ) |
return all sem_tree-entries for the passed seminar
| string | $seminar_id | the seminar |
| get_seminar_tutor | ( | $seminar_id | ) |
get the tutors and their order-positions in the passed seminar
| string | $seminar_id | the seminar to get the tutors from |

| get_seminars_user | ( | $user_id | ) |
return an array of all seminars for the passed user, containing the name, id, makedate and sem-number.
| string | $user_id | the user's id |

| get_ticket | ( | ) |
return a studip-ticket


| get_title_for_status | ( | $type, | |
| $count, | |||
$sem_type = NULL |
|||
| ) |
Get the title used for the given status ('dozent', 'tutor' etc.) for the specified SEM_TYPE. Alternative titles can be defined in the config.inc.php.
@global array $SEM_TYPE @global array $SessSemName @global array $DEFAULT_TITLE_FOR_STATUS
| string | $type | status ('dozent', 'tutor', 'autor', 'user' or 'accepted') |
| int | $count | count, this determines singular or plural form of title |
| int | $sem_type | sem_type of course (defaults to type of current course) |

| get_userid | ( | $username = "" | ) |
Retrieves the userid for a given username
uses global $online array if user is online
@global object $auth @staticvar array $cache
| string | $username | if omitted, current user_id will be returned |


| get_username | ( | $user_id = "" | ) |
Retrieves the username for a given user_id
@global object $auth @staticvar array $cache
| string | $user_id | if omitted, current username will be returned |


| get_users_online | ( | $active_time = 5, |
|
$name_format = 'full_rev' |
|||
| ) |
retrieve a list of all online users
@global object $user @global array $_fullname_sql
| int | $active_time | filter: the time in minutes until last life-sign |
| string | $name_format | format the fullname shall have |

| get_users_online_count | ( | $active_time = 5 | ) |
get the number of currently online users
| int | $active_time | filter: the time in minutes until last life-sign |


| get_vorname | ( | $user_id = "" | ) |
Retrieves the Vorname for a given user_id
| string | $user_id | if omitted, current user_id is used |

| getHeaderLine | ( | $id, | |
$object_name = null |
|||
| ) |
This function creates the header line for studip-objects
you will get a line like this "Veranstaltung: Name..."
| string | $id | the id of the Veranstaltung |
| string | $object_name | the name of the object (optional) |


| is_internal_url | ( | $url | ) |
| match_route | ( | $requested_route, | |
$current_route = '' |
|||
| ) |
compares actual route to requested route
| string | $requested_route | requested route (for help content or tour) |
| string | $current_route | current route (optional) |


| my_substr | ( | $what, | |
| $start, | |||
| $end | |||
| ) |
The function shortens a string, but it uses the first 2/3 and the last 1/3
The parts will be divided by a "[...]". The functions is to use like php's substr function.
| string | $what | the original string |
| integer | $start | start pos, 0 is the first pos |
| integer | $end | end pos |


| openInst | ( | $inst_id | ) |
This function "opens" an institute to work with it. Does the same as selectInst() but also sets the visit date.
| string | $inst_id | the id of the institute |


| openSem | ( | $sem_id | ) |
This function "opens" a course to work with it. Does the same as selectSem() but also sets the visit date.
| string | $sem_id | the id of the course |

| re_sort_dozenten | ( | $s_id, | |
| $position | |||
| ) |
reset the order-positions for the lecturers in the passed seminar, starting at the passed position
| string | $s_id | the seminar to work on |
| int | $position | the position to start with |


| re_sort_tutoren | ( | $s_id, | |
| $position | |||
| ) |
reset the order-positions for the tutors in the passed seminar, starting at the passed position
| string | $s_id | the seminar to work on |
| int | $position | the position to start with |


| relsize | ( | $size, | |
$verbose = true, |
|||
$displayed_levels = 1, |
|||
$glue = ', |
|||
| ' | |||
| ) |
Displays a filesize in a (shortened) human readable form including the according units. For instance, 1234567 would be displayed as "1 MB" or 12345 would be displayed as "12 kB". The function can display the units in a short or a long form ("1 b" vs. "1 Byte"). Optionally, more than one unit part can be displayed. For instance, 1234567 could also be displayed as "1 MB, 234 kB, 567 b".
| int | $size | The raw filesize as integer |
| bool | $verbose | Use short or long unit names |
| int | $displayed_levels | How many unit parts should be displayed |
| String | $glue | Text used to glue the different unit parts together |

| reltime | ( | $timestamp, | |
$verbose = true, |
|||
$displayed_levels = 1, |
|||
$tolerance = 5 |
|||
| ) |
Displays "relative time" - a textual representation between now and a certain timestamp, e.g. "3 hours ago".
| int | $timestamp | Timestamp to relate to. |
| bool | $verbose | Display long or short texts (optional) |
| int | $displayed_levels | How many levels shall be displayed |
| int | $tolerance | Defines a tolerance area of seconds around now (How many seconds must have passed until the function won't return "now") |

| remove_magic_quotes | ( | $mixed | ) |
Remove slashes if magic quotes are enabled
| mixed | $mixed | string or array to strip slashes from |


searches
@global array $perm @global object $user @global array $_fullname_sql
| string | $search_str | optional search-string |
| string | $search_user | optional user to search for |
| bool | $show_sem | if true, the seminar is added to the result |


| select_group | ( | $sem_start_time | ) |
This function calculates one of the group colors unique for the semester of the passed timestamp
It calculates a unique color number to create the initial entry for a new user in a seminar. It will create a unique number for every semester and will start over, if the max. number (7) is reached.
| integer | $sem_start_time | the timestamp of the start time from the Semester |

| selectInst | ( | $inst_id | ) |
This function "selects" an Einrichtung to work with it
Note: Stud.IP treats Einrichtungen like Veranstaltungen, yu can see this especially if you look at the variable names....
The following variables will bet set: $SessionSeminar Einrichtung id
$SessSemName[0] Einrichtung name
$SessSemName[1] Einrichtung id
$SessSemName["art"] Einrichtung type in alphanumeric form
$SessSemName["art_num"] Einrichtung type in numeric form
$SessSemName["art_generic"] Einrichtung generic type in alhanumeric form (self description)
$SessSemName["class"] Einrichtung class (sem or inst, in this function always inst)
$SessSemName["header_line"] the header-line to use on every page of the Einrichtung
| string | $inst_id | the id of the Veranstaltung |


| selectSem | ( | $sem_id | ) |
This function "selects" a Veranstaltung to work with it
The following variables will bet set: $SessionSeminar Veranstaltung id
$SessSemName[0] Veranstaltung name
$SessSemName[1] Veranstaltung id
$SessSemName[2] Veranstaltung ort (room)
$SessSemName[3] Veranstaltung Untertitel (subtitle)
$SessSemName[4] Veranstaltung start_time (the Semester start_time)
$SessSemName[5] Veranstaltung institut_id (the home-intitute)
$SessSemName["art"] Veranstaltung type in alphanumeric form
$SessSemName["art_num"] Veranstaltung type in numeric form
$SessSemName["art_generic"] Veranstaltung generic type in alhanumeric form (self description)
$SessSemName["class"] Veranstaltung class (sem or inst, in this function always sem)
$SessSemName["header_line"] the header-line to use on every page of the Veranstaltung
| string | $sem_id | the id of the Veranstaltung |


| StringToFloat | ( | $str | ) |
converts a string to a float, depending on the locale
| string | $str | the string to convert to float |
| studip_default_exception_handler | ( | $exception | ) |

| studip_strlen | ( | $string | ) |
Stud.IP encoding aware version of good ol' strlen(), treats numeric HTML-ENTITIES as one character use only if really necessary
| string | $string | the string to measure |


| studip_substr | ( | $string, | |
| $offset, | |||
$length = false |
|||
| ) |
Stud.IP encoding aware version of good ol' substr(), treats numeric HTML-ENTITIES as one character use only if really necessary
| string | $string | string to shorten |
| integer | $offset | position to start with |
| integer | $length | maximum length |


| studip_utf8decode | ( | $data | ) |
Encodes a string or array from UTF-8 to Stud.IP encoding (WINDOWS-1252/ISO-8859-1 with numeric HTML-ENTITIES)
| mixed | $data | a string in UTF-8 or an array with all strings encoded in utf-8 |


| studip_utf8encode | ( | $data | ) |
Encodes a string or array from Stud.IP encoding (WINDOWS-1252/ISO-8859-1 with numeric HTML-ENTITIES) to UTF-8
| mixed | $data | a string or an array with strings to encode in WINDOWS-1252/HTML-ENTITIES |


| studygroup_sem_types | ( | ) |
Return the list of SEM_TYPES that represent study groups in this Stud.IP installation.

| text_excerpt | ( | $text, | |
| $phrase, | |||
$radius = 100, |
|||
$length = 200, |
|||
$excerpt_string = '...' |
|||
| ) |
Extracts an excerpt from the 'text' surrounding the 'phrase' with a number of characters on each side determined by 'radius'. If the phrase isn't found, null is returned. Ex: text_excerpt("hello my world", "my", 3) => "...lo my wo..."
| string | $text | the text to excerpt |
| string | $phrase | the search phrase |
| integer | $radius | the radius around the phrase |
| integer | $length | the maximum length of the excerpt string |
| string | $excerpt_string | the excerpt string |
| TrackAccess | ( | $id, | |
$object_type = null |
|||
| ) |
This function tracks user acces to several Data (only dokuments by now, to be extended)
| string | $id | the id of the object to track |
| string | $object_type | the object type (optional) |


| words | ( | $string | ) |
Splits a string by space characters and returns these words as an array.
| string | $string | the string to split |

| write_config | ( | $key, | |
| $val, | |||
$arr = null |
|||
| ) |
writes an entry into the studip configuration table
| string | $key | the key for the config entry |
| string | $val | the value that should be set |
| array | $arr | an array with key=>value to write into config |

