|
| static | __callStatic ($name, $arguments) |
| |
| static | log ($action_name, $affected=null, $coaffected=null, $info=null, $dbg_info=null, $user_id=null) |
| |
| static | registerAction ($name, $description, $info_template, $class) |
| |
| static | registerActionPlugin ($name, $description, $info_template, $plugin_class_name) |
| |
| static | registerActionFile ($name, $description, $info_template, $filename, $class) |
| |
| static | unregisterAction ($name) |
| |
| static | searchSeminar ($needle) |
| |
| static | searchInstitute ($needle) |
| |
| static | searchUser ($needle) |
| |
| static | searchResource ($needle) |
| |
| static | searchObjectByAction ($needle, $action_id) |
| |
| static __callStatic |
( |
|
$name, |
|
|
|
$arguments |
|
) |
| |
|
static |
Magic log, intercepts all undefined static method calls called method name must be the name of a log action
- Parameters
-
| string | $name | |
| array | $arguments | |
- Returns
- boolean True if event was written or false if logging is disabled
| static log |
( |
|
$action_name, |
|
|
|
$affected = null, |
|
|
|
$coaffected = null, |
|
|
|
$info = null, |
|
|
|
$dbg_info = null, |
|
|
|
$user_id = null |
|
) |
| |
|
static |
Logs an event to the database after a certain action took place along with the ids of the range object the action possibly affected. You can provide additional info as well as debug information.
- Parameters
-
| String | $action_name | Name of the action that took place |
| mixed | $affected | Range id that was affected by the action, if any |
| mixed | $coaffected | Range id that was possibly affected as well |
| mixed | $info | Information to add to the event |
| mixed | $dbg_info | Debug information to add to the event |
| mixed | $user_id | Provide null for the current user id |
| static registerAction |
( |
|
$name, |
|
|
|
$description, |
|
|
|
$info_template, |
|
|
|
$class |
|
) |
| |
|
static |
Registers a new log action in database. Use this function to register log actions for Stud.IP core objects.
- Parameters
-
| string | $name | The name of the action. |
| string | $description | The action's description. |
| string | $info_template | The template |
| string | $class | Name of the core class. |
| static registerActionFile |
( |
|
$name, |
|
|
|
$description, |
|
|
|
$info_template, |
|
|
|
$filename, |
|
|
|
$class |
|
) |
| |
|
static |
Registers a new log action in database. Use this function to register log actions for arbitrary objects.
- Parameters
-
| string | $name | The name of the action. |
| string | $description | The action's description. |
| string | $info_template | The template |
| string | $filename | Path to the file with the class (relative to Stud.IP root). |
| string | $class | Name of class to be logged. |
| static registerActionPlugin |
( |
|
$name, |
|
|
|
$description, |
|
|
|
$info_template, |
|
|
|
$plugin_class_name |
|
) |
| |
|
static |
Registers a new log action in database. Use this function to register log actions for plugin classes.
- Parameters
-
| string | $name | The name of the action. |
| string | $description | The action's description. |
| string | $info_template | The template |
| string | $plugin_class_name | Name of the plugin class. |
| static searchInstitute |
( |
|
$needle | ) |
|
|
static |
Finds all institutes by given search string. Searches for the name of existing or already deleted institutes.
- Parameters
-
| type | $needle | The needle to search for. |
- Returns
- array
| static searchObjectByAction |
( |
|
$needle, |
|
|
|
$action_id |
|
) |
| |
|
static |
Finds all objects related to the given action by search string. The search string can be either a part of the name or the id of the object.
Calls the method Loggable::logSearch() to retrieve the result.
- Parameters
-
| string | $needle | |
| type | $action_id | |
- Returns
- type
| static searchResource |
( |
|
$needle | ) |
|
|
static |
Finds all resources by given search string. The search string can be either a resource id or part of the name.
- Parameters
-
| string | $needle | The needle to search for. |
- Returns
- array
| static searchSeminar |
( |
|
$needle | ) |
|
|
static |
Finds all seminars by given search string. Searches for the name of existing or already deleted seminars.
- Parameters
-
| string | $needle | The needle to search for. |
- Returns
- array
| static searchUser |
( |
|
$needle | ) |
|
|
static |
Finds all users by given search string. Searches for the users id, part of the name or the username.
- Parameters
-
| type | $needle | The needle to search for. |
- Returns
- array
| static unregisterAction |
( |
|
$name | ) |
|
|
static |
Removes the action from database. Deletes all related log events also.
- Parameters
-
| string | $name | The name of the log action. |
- Returns
- mixed Number of deleted objects or false if action is unknown.
The documentation for this class was generated from the following file:
1.8.5 
