ILIAS
release_5-4 Revision v5.4.26-12-gabc799a52e6
|
Class ilStudyProgrammeType. More...
Public Member Functions | |
__construct ($primary_key=0) | |
getTitle ($a_lang_code='') | |
Get the title of an StudyProgramme type. More... | |
setTitle ($a_title, $a_lang_code='') | |
Set title of StudyProgramme type. More... | |
getDescription ($a_lang_code='') | |
Get the description of an StudyProgramme type. More... | |
setDescription ($a_description, $a_lang_code='') | |
Set description of StudyProgramme type. More... | |
getAssignedStudyProgrammes ($include_deleted=true) | |
Get an array of ilObjStudyProgramme objects using this type. More... | |
getAssignedStudyProgrammeIds () | |
updateAssignedStudyProgrammesIcons () | |
Update the Icons of assigned objects. More... | |
getAssignedAdvancedMDRecords ($a_only_active=false) | |
Get assigned AdvancedMDRecord objects. More... | |
processAndStoreIconFile (array $file_data) | |
Resize and store an icon file for this object. More... | |
removeIconFile () | |
Remove the icon file on disk. More... | |
setTranslations ($translations) | |
Getters & Setters. More... | |
getTranslations () | |
Returns the loaded translation objects. More... | |
setOwner ($owner) | |
getOwner () | |
setLastUpdate ($last_update) | |
getLastUpdate () | |
getId () | |
setIcon ($icon) | |
Set new Icon filename. More... | |
getIcon () | |
getIconPath ($append_filename=false) | |
Return the path to the icon. More... | |
getDefaultLang () | |
setCreateDate ($create_date) | |
getCreateDate () | |
Public Member Functions inherited from ActiveRecord | |
getArConnector () | |
getArFieldList () | |
getConnectorContainerName () | |
setConnectorContainerName ($connector_container_name) | |
getPrimaryFieldValue () | |
setPrimaryFieldValue ($value) | |
__construct ($primary_key=0, arConnector $connector=null) | |
storeObjectToCache () | |
__getConvertedDateFieldsAsArray ($format=null) | |
__asCsv ($separator=';', $header=false) | |
__asArray () | |
__asStdClass () | |
__asSerializedObject () | |
buildFromArray (array $array) | |
fixDateField ($field_name, $value) | |
sleep ($field_name) | |
wakeUp ($field_name, $field_value) | |
getArrayForDb () | |
getArrayForConnector () | |
installConnector () | |
store () | |
save () | |
create () | |
copy ($new_id=0) | |
afterObjectLoad () | |
read () | |
update () | |
delete () | |
__call ($name, $arguments) | |
Static Public Member Functions | |
static | returnDbTableName () |
static | getAllTypes () |
Public. More... | |
static | getAllTypesArray () |
static | getAvailableAdvancedMDRecords () |
Get all available AdvancedMDRecord objects for StudyProgrammes/Types. More... | |
static | getIconPathByStudyProgrammObjId ($obj_id) |
Return the path to the icon by studyprogramme obj id. More... | |
Static Public Member Functions inherited from ActiveRecord | |
static | returnDbTableName () |
static | installDB () |
static | renameDBField ($old_name, $new_name) |
static | tableExists () |
static | fieldExists ($field_name) |
static | removeDBField ($field_name) |
static | updateDB () |
static | resetDB () |
static | truncateDB () |
static | flushDB () |
static | preloadObjects () |
static | additionalParams (array $additional_params) |
static | findOrFail ($primary_key, array $add_constructor_args=array()) |
Tries to find the object and throws an Exception if object is not found, instead of returning null. More... | |
static | findOrGetInstance ($primary_key, array $add_constructor_args=array()) |
static | where ($where, $operator=null) |
static | innerjoinAR (ActiveRecord $ar, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false) |
static | innerjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false) |
static | leftjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false) |
static | orderBy ($orderBy, $orderDirection='ASC') |
static | dateFormat ($date_format='d.m.Y - H:i:s') |
static | limit ($start, $end) |
static | affectedRows () |
static | count () |
static | get () |
static | debug () |
static | first () |
static | getCollection () |
static | last () |
static | getFirstFromLastQuery () |
static | connector (arConnector $connector) |
static | raw ($set_raw=true) |
static | getArray ($key=null, $values=null) |
static | _toCamelCase ($str, $capitalise_first_char=false) |
Data Fields | |
const | WEB_DATA_FOLDER = 'prg_data' |
Folder in ILIAS webdir to store the icons. More... | |
Data Fields inherited from ActiveRecord | |
const | ACTIVE_RECORD_VERSION = '2.0.7' |
Protected Member Functions | |
getTranslation ($a_member, $a_lang_code) | |
Protected. More... | |
loadTranslation ($a_lang_code) | |
Helper function to load a translation. More... | |
updateable () | |
Helper function to check if this type can be updated. More... | |
Protected Member Functions inherited from ActiveRecord | |
serializeToCSV ($field) | |
This method is called for every field of your instance if you use __asCsv. More... | |
installDatabase () | |
Protected Attributes | |
$id = 0 | |
$default_lang = '' | |
$owner | |
$create_date | |
$last_update | |
$icon | |
$amd_records_assigned | |
$log | |
$user | |
$pluginAdmin | |
$active_plugins | |
$lng | |
$translations | |
$changed_translations = array() | |
Protected Attributes inherited from ActiveRecord | |
$ar_safe_read = true | |
$connector_container_name = '' | |
Static Protected Attributes | |
static | $amd_records_available |
Additional Inherited Members | |
Static Protected Member Functions inherited from ActiveRecord | |
static | getCalledClass () |
static | fromCamelCase ($str) |
Class ilStudyProgrammeType.
Definition at line 16 of file class.ilStudyProgrammeType.php.
ilStudyProgrammeType::__construct | ( | $primary_key = 0 | ) |
int | $a_id |
ilStudyProgrammeTypeException |
Definition at line 141 of file class.ilStudyProgrammeType.php.
References $DIC, $ilDB, $ilLog, $ilUser, $lng, and user().
|
static |
Public.
Get array of all instances of ilStudyProgrammeType objects
Definition at line 169 of file class.ilStudyProgrammeType.php.
References ILIAS\GlobalScreen\get().
Referenced by ilStudyProgrammeTypeTableGUI\initColumns().
|
static |
Definition at line 174 of file class.ilStudyProgrammeType.php.
References $container, $default_lang, $key, $lang, $out, $records, $title, $type, ActiveRecord\count(), ActiveRecord\create(), ilStudyProgrammeTypeTranslation\deleteAllTranslations(), getDefaultLang(), getIconPath(), getId(), getTranslation(), IL_CAL_UNIX, setCreateDate(), setLastUpdate(), setOwner(), League\Flysystem\Adapter\Polyfill\update(), ActiveRecord\update(), user(), and ActiveRecord\where().
Referenced by ilObjStudyProgrammeSettingsGUI\buildForm().
ilStudyProgrammeType::getAssignedAdvancedMDRecords | ( | $a_only_active = false | ) |
Get assigned AdvancedMDRecord objects.
bool | $a_only_active | True if only active AMDRecords are returned |
Definition at line 426 of file class.ilStudyProgrammeType.php.
References $sets, getId(), and ActiveRecord\where().
ilStudyProgrammeType::getAssignedStudyProgrammeIds | ( | ) |
Definition at line 391 of file class.ilStudyProgrammeType.php.
References $out, and getAssignedStudyProgrammes().
Referenced by getAvailableAdvancedMDRecords(), and updateAssignedStudyProgrammesIcons().
ilStudyProgrammeType::getAssignedStudyProgrammes | ( | $include_deleted = true | ) |
Get an array of ilObjStudyProgramme objects using this type.
bool | $include_deleted | True if also deleted StudyProgrammes are returned |
Definition at line 386 of file class.ilStudyProgrammeType.php.
References getId(), and ActiveRecord\where().
Referenced by getAssignedStudyProgrammeIds().
|
static |
Get all available AdvancedMDRecord objects for StudyProgrammes/Types.
Definition at line 474 of file class.ilStudyProgrammeType.php.
References $key, $records, ilAdvancedMDRecord\_getActivatedRecordsByObjectType(), ActiveRecord\count(), getAssignedStudyProgrammeIds(), getId(), ilAdvancedMDRecord\saveObjRecSelection(), and ActiveRecord\where().
Referenced by ilStudyProgrammeTypeAdvancedMetaDataFormGUI\saveObject().
ilStudyProgrammeType::getCreateDate | ( | ) |
Definition at line 1028 of file class.ilStudyProgrammeType.php.
References $create_date.
ilStudyProgrammeType::getDefaultLang | ( | ) |
Definition at line 1010 of file class.ilStudyProgrammeType.php.
References $default_lang.
Referenced by getAllTypesArray(), getTranslation(), setDescription(), and setTitle().
ilStudyProgrammeType::getDescription | ( | $a_lang_code = '' | ) |
Get the description of an StudyProgramme type.
If no language code is given, a translation in the user-language is returned. If no such translation exists, the description of the default language is substituted. If a language code is provided, returns description for the given language or null.
string | $a_lang_code |
Definition at line 360 of file class.ilStudyProgrammeType.php.
References getTranslation().
ilStudyProgrammeType::getIcon | ( | ) |
Definition at line 917 of file class.ilStudyProgrammeType.php.
References $icon.
Referenced by getIconPath(), processAndStoreIconFile(), and removeIconFile().
ilStudyProgrammeType::getIconPath | ( | $append_filename = false | ) |
Return the path to the icon.
bool | $append_filename | If true, append filename of icon |
Definition at line 930 of file class.ilStudyProgrammeType.php.
References $path, getIcon(), and getId().
Referenced by getAllTypesArray(), processAndStoreIconFile(), and removeIconFile().
|
static |
Return the path to the icon by studyprogramme obj id.
int | $obj_id | study prgramm obj id |
Definition at line 947 of file class.ilStudyProgrammeType.php.
References $default_lang, $DIC, $ilDB, $path, $res, $row, and ActiveRecord\count().
ilStudyProgrammeType::getId | ( | ) |
Definition at line 887 of file class.ilStudyProgrammeType.php.
References $id.
Referenced by getAllTypesArray(), getAssignedAdvancedMDRecords(), getAssignedStudyProgrammes(), getAvailableAdvancedMDRecords(), getIconPath(), getTranslation(), getTranslations(), and loadTranslation().
ilStudyProgrammeType::getLastUpdate | ( | ) |
Definition at line 878 of file class.ilStudyProgrammeType.php.
References $last_update.
ilStudyProgrammeType::getOwner | ( | ) |
ilStudyProgrammeType::getTitle | ( | $a_lang_code = '' | ) |
Get the title of an StudyProgramme type.
If no language code is given, a translation in the user-language is returned. If no such translation exists, the translation of the default language is substituted. If a language code is provided, returns title for the given language or null.
string | $a_lang_code |
Definition at line 331 of file class.ilStudyProgrammeType.php.
References getTranslation().
|
protected |
Protected.
Helper method to return a translation for a given member and language
$a_member | |
$a_lang_code |
Definition at line 656 of file class.ilStudyProgrammeType.php.
References $active_plugins, $lang, ActiveRecord\count(), getDefaultLang(), getId(), IL_COMP_MODULE, loadTranslation(), user(), and ActiveRecord\where().
Referenced by getAllTypesArray(), getDescription(), and getTitle().
ilStudyProgrammeType::getTranslations | ( | ) |
Returns the loaded translation objects.
Definition at line 825 of file class.ilStudyProgrammeType.php.
References $translations, getId(), and ActiveRecord\where().
|
protected |
Helper function to load a translation.
Returns translation object from cache or null, if no translation exists for the given code.
string | $a_lang_code | A language code |
Definition at line 774 of file class.ilStudyProgrammeType.php.
References ActiveRecord\count(), getId(), and ActiveRecord\where().
Referenced by getTranslation().
ilStudyProgrammeType::processAndStoreIconFile | ( | array | $file_data | ) |
Resize and store an icon file for this object.
array | $file_data | The array containing file information from the icon from PHPs $_FILES array |
Definition at line 600 of file class.ilStudyProgrammeType.php.
References $filename, GuzzleHttp\Psr7\$stream, ActiveRecord\count(), getIcon(), getIconPath(), ILIAS\Filesystem\Stream\Streams\ofResource(), and updateable().
ilStudyProgrammeType::removeIconFile | ( | ) |
Remove the icon file on disk.
Definition at line 628 of file class.ilStudyProgrammeType.php.
References getIcon(), getIconPath(), setIcon(), and updateable().
|
static |
Definition at line 131 of file class.ilStudyProgrammeType.php.
ilStudyProgrammeType::setCreateDate | ( | $create_date | ) |
string | $create_date |
Definition at line 1019 of file class.ilStudyProgrammeType.php.
References $create_date.
Referenced by getAllTypesArray().
ilStudyProgrammeType::setDescription | ( | $a_description, | |
$a_lang_code = '' |
|||
) |
Set description of StudyProgramme type.
If no lang code is given, sets description for default language.
$a_description | ||
string | $a_lang_code |
Definition at line 373 of file class.ilStudyProgrammeType.php.
References $lang, and getDefaultLang().
ilStudyProgrammeType::setIcon | ( | $icon | ) |
Set new Icon filename.
Note that if you did also send a new icon image file with a form, make sure to call ilStudyProgrammeType::processAndStoreIconFile() to store the file additionally on disk.
If you want to delete the icon, set call ilStudyProgrammeType::removeIconFile() first and set an empty string here.
string | $icon |
ilStudyProgrammeTypeException |
Definition at line 905 of file class.ilStudyProgrammeType.php.
References $icon.
Referenced by removeIconFile().
ilStudyProgrammeType::setLastUpdate | ( | $last_update | ) |
string | $last_update |
Definition at line 869 of file class.ilStudyProgrammeType.php.
References $last_update.
Referenced by getAllTypesArray().
ilStudyProgrammeType::setOwner | ( | $owner | ) |
int | $owner |
Definition at line 851 of file class.ilStudyProgrammeType.php.
References $owner.
Referenced by getAllTypesArray().
ilStudyProgrammeType::setTitle | ( | $a_title, | |
$a_lang_code = '' |
|||
) |
Set title of StudyProgramme type.
If no lang code is given, sets title for default language.
$a_title | ||
string | $a_lang_code |
Definition at line 344 of file class.ilStudyProgrammeType.php.
References $lang, and getDefaultLang().
ilStudyProgrammeType::setTranslations | ( | $translations | ) |
Getters & Setters.
array | $translations |
Definition at line 814 of file class.ilStudyProgrammeType.php.
References $translations.
|
protected |
Helper function to check if this type can be updated.
Definition at line 795 of file class.ilStudyProgrammeType.php.
Referenced by processAndStoreIconFile(), and removeIconFile().
ilStudyProgrammeType::updateAssignedStudyProgrammesIcons | ( | ) |
Update the Icons of assigned objects.
Definition at line 408 of file class.ilStudyProgrammeType.php.
References $id, ilObject\_getAllReferences(), getAssignedStudyProgrammeIds(), and ilObjStudyProgramme\getInstanceByRefId().
|
protected |
Definition at line 110 of file class.ilStudyProgrammeType.php.
Referenced by getTranslation().
|
protected |
Definition at line 85 of file class.ilStudyProgrammeType.php.
|
staticprotected |
Definition at line 90 of file class.ilStudyProgrammeType.php.
|
protected |
Definition at line 124 of file class.ilStudyProgrammeType.php.
|
protected |
Definition at line 61 of file class.ilStudyProgrammeType.php.
Referenced by getCreateDate(), and setCreateDate().
|
protected |
Definition at line 43 of file class.ilStudyProgrammeType.php.
Referenced by getAllTypesArray(), getDefaultLang(), and getIconPathByStudyProgrammObjId().
|
protected |
Definition at line 79 of file class.ilStudyProgrammeType.php.
|
protected |
Definition at line 34 of file class.ilStudyProgrammeType.php.
Referenced by getId(), and updateAssignedStudyProgrammesIcons().
|
protected |
Definition at line 70 of file class.ilStudyProgrammeType.php.
Referenced by getLastUpdate(), and setLastUpdate().
|
protected |
Definition at line 115 of file class.ilStudyProgrammeType.php.
Referenced by __construct().
|
protected |
Definition at line 95 of file class.ilStudyProgrammeType.php.
|
protected |
Definition at line 52 of file class.ilStudyProgrammeType.php.
Referenced by getOwner(), and setOwner().
|
protected |
Definition at line 105 of file class.ilStudyProgrammeType.php.
|
protected |
Definition at line 120 of file class.ilStudyProgrammeType.php.
Referenced by getTranslations(), and setTranslations().
|
protected |
Definition at line 100 of file class.ilStudyProgrammeType.php.
const ilStudyProgrammeType::WEB_DATA_FOLDER = 'prg_data' |
Folder in ILIAS webdir to store the icons.
Definition at line 22 of file class.ilStudyProgrammeType.php.