|
ILIAS
release_10 Revision v10.1-43-ga1241a92c2f
|
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...
Collaboration diagram for ilOrgUnitType:Public Member Functions | |
| __construct (int $a_id=0) | |
| save () | |
| Wrapper around create() and update() methods. More... | |
| getTitle (string $a_lang_code='') | |
| Get the title of an OrgUnit type. More... | |
| setTitle (string $a_title, string $a_lang_code='') | |
| Set title of OrgUnit type. More... | |
| getDescription (string $a_lang_code='') | |
| Get the description of an OrgUnit type. More... | |
| setDescription (string $a_description, string $a_lang_code='') | |
| Set description of OrgUnit type. More... | |
| getOrgUnitIds (bool $include_deleted=true) | |
| Get an array of IDs of ilObjOrgUnit objects using this type. More... | |
| getOrgUnits (bool $include_deleted=true) | |
| Get an array of ilObjOrgUnit objects using this type. More... | |
| getAssignedAdvancedMDRecords (bool $a_only_active=false) | |
| Get assigned AdvancedMDRecord objects. More... | |
| getActivePlugins () | |
| Get array of all acitve plugins for the ilOrgUnitTypeHook plugin slot. More... | |
| setTranslations (array $translations) | |
| Getters & Setters. More... | |
| getTranslations () | |
| Returns the loaded translation objects. More... | |
| setOwner (int $owner) | |
| getOwner () | |
| setLastUpdate (string $last_update) | |
| getLastUpdate () | |
| getId () | |
| withIconIdentifier (string $identifier) | |
| getIconIdentifier () | |
| getDefaultLang () | |
| setCreateDate (string $create_date) | |
| getCreateDate () | |
| removeIconFromIrss (string $identifier) | |
| getIconSrc () | |
Static Public Member Functions | |
| static | getInstance (int $a_id) |
| Get instance of an ilOrgUnitType object Returns object from cache or from database, returns null if no object was found. More... | |
| static | getAllTypes () |
| Get array of all instances of ilOrgUnitType objects. More... | |
| static | getAvailableAdvancedMDRecords () |
| Get all available AdvancedMDRecord objects for OrgUnits/Types. More... | |
Data Fields | |
| const | TABLE_NAME = 'orgu_types' |
Protected Member Functions | |
| getTranslation (string $a_member, string $a_lang_code) | |
| Protected. More... | |
| loadTranslation (string $a_lang_code) | |
| Helper function to load a translation. More... | |
| read () | |
| Read object data from database. More... | |
| updateable () | |
| Helper function to check if this type can be updated. More... | |
Protected Attributes | |
| int | $id = 0 |
| string | $default_lang = '' |
| int | $owner |
| string | $create_date |
| string | $last_update |
| string | $icon = '' |
| array | $translations = array() |
| array | $amd_records_assigned |
| array | $orgus = [] |
| array | $orgus_ids = [] |
| ilDBInterface | $db |
| ILIAS DI LoggingServices | $log |
| ilObjUser | $user |
| array | $active_plugins |
| ilLanguage | $lng |
| ilComponentFactory | $component_factory |
| IRSS | $irss |
Static Protected Attributes | |
| static array | $amd_records_available = null |
| static array | $instances = array() |
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.
ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.
If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilOrgUnitType
Definition at line 26 of file class.ilOrgUnitType.php.
| ilOrgUnitType::__construct | ( | int | $a_id = 0 | ) |
| ilOrgUnitTypeException |
Definition at line 53 of file class.ilOrgUnitType.php.
References $DIC, ILIAS\Repository\int(), ILIAS\Repository\lng(), read(), and ILIAS\Repository\user().
Here is the call graph for this function:| ilOrgUnitType::getActivePlugins | ( | ) |
Get array of all acitve plugins for the ilOrgUnitTypeHook plugin slot.
Definition at line 597 of file class.ilOrgUnitType.php.
Referenced by getAllTypes(), getAvailableAdvancedMDRecords(), getIconIdentifier(), getTranslation(), save(), and updateable().
Here is the caller graph for this function:
|
static |
Get array of all instances of ilOrgUnitType objects.
Definition at line 96 of file class.ilOrgUnitType.php.
References $DIC, $ilDB, XapiProxy\$plugin, getActivePlugins(), getDefaultLang(), getIconIdentifier(), getId(), getOwner(), getTranslation(), ILIAS\Repository\lng(), and ILIAS\Repository\user().
Referenced by ilOrgUnitTypeGUI\getTableDataRetrieval(), and ilObjOrgUnitSettingsFormGUI\saveObject().
Here is the call graph for this function:
Here is the caller graph for this function:| ilOrgUnitType::getAssignedAdvancedMDRecords | ( | bool | $a_only_active = false | ) |
Get assigned AdvancedMDRecord objects.
| bool | $a_only_active | True if only active AMDRecords are returned |
Definition at line 358 of file class.ilOrgUnitType.php.
References getId().
Here is the call graph for this function:
|
static |
Get all available AdvancedMDRecord objects for OrgUnits/Types.
Definition at line 401 of file class.ilOrgUnitType.php.
References XapiProxy\$plugin, ilAdvancedMDRecord\_getActivatedRecordsByObjectType(), getActivePlugins(), getId(), getOrgUnitIds(), ILIAS\Repository\lng(), and ilAdvancedMDRecord\saveObjRecSelection().
Referenced by ilOrgUnitTypeGUI\getAvailableAMDRecords().
Here is the call graph for this function:
Here is the caller graph for this function:| ilOrgUnitType::getCreateDate | ( | ) |
| ilOrgUnitType::getDefaultLang | ( | ) |
Definition at line 761 of file class.ilOrgUnitType.php.
References $default_lang.
Referenced by getAllTypes(), ilOrgUnitTypeGUI\getEditForm(), getTranslation(), setDescription(), and setTitle().
Here is the caller graph for this function:| ilOrgUnitType::getDescription | ( | string | $a_lang_code = '' | ) |
Get the description of an OrgUnit 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.
Definition at line 277 of file class.ilOrgUnitType.php.
References getTranslation().
Referenced by ilOrgUnitTypeGUI\getEditForm().
Here is the call graph for this function:
Here is the caller graph for this function:| ilOrgUnitType::getIconIdentifier | ( | ) |
Definition at line 724 of file class.ilOrgUnitType.php.
References $default_lang, $icon, XapiProxy\$plugin, getActivePlugins(), and ILIAS\Repository\lng().
Referenced by getAllTypes(), getIconSrc(), and save().
Here is the call graph for this function:
Here is the caller graph for this function:| ilOrgUnitType::getIconSrc | ( | ) |
Definition at line 783 of file class.ilOrgUnitType.php.
References getIconIdentifier().
Here is the call graph for this function:| ilOrgUnitType::getId | ( | ) |
Definition at line 712 of file class.ilOrgUnitType.php.
References $id.
Referenced by getAllTypes(), getAssignedAdvancedMDRecords(), getAvailableAdvancedMDRecords(), ilOrgUnitTypeGUI\getEditForm(), getOrgUnitIds(), getTranslation(), getTranslations(), loadTranslation(), and save().
Here is the caller graph for this function:
|
static |
Get instance of an ilOrgUnitType object Returns object from cache or from database, returns null if no object was found.
| int | $a_id | ID of the OrgUnit type |
Definition at line 74 of file class.ilOrgUnitType.php.
References Vendor\Package\$e.
Referenced by ilObjOrgUnit\getIconsCache(), ilObjOrgUnit\getOrgUnitType(), and ilModulesOrgUnitTest\testIfOrgUnitHasRequiredLocalRoles().
Here is the caller graph for this function:| ilOrgUnitType::getLastUpdate | ( | ) |
| ilOrgUnitType::getOrgUnitIds | ( | bool | $include_deleted = true | ) |
Get an array of IDs of ilObjOrgUnit objects using this type.
Definition at line 295 of file class.ilOrgUnitType.php.
References getId().
Referenced by getAvailableAdvancedMDRecords(), and getOrgUnits().
Here is the call graph for this function:
Here is the caller graph for this function:| ilOrgUnitType::getOrgUnits | ( | bool | $include_deleted = true | ) |
Get an array of ilObjOrgUnit objects using this type.
| bool | $include_deleted | True if also deleted OrgUnits are returned |
Definition at line 325 of file class.ilOrgUnitType.php.
References $ref_id, ilObject\_getAllReferences(), ilObject\_isInTrash(), and getOrgUnitIds().
Referenced by save().
Here is the call graph for this function:
Here is the caller graph for this function:| ilOrgUnitType::getOwner | ( | ) |
Definition at line 697 of file class.ilOrgUnitType.php.
References $owner.
Referenced by getAllTypes().
Here is the caller graph for this function:| ilOrgUnitType::getTitle | ( | string | $a_lang_code = '' | ) |
Get the title of an OrgUnit 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 empty string.
Definition at line 257 of file class.ilOrgUnitType.php.
References getTranslation().
Referenced by ilOrgUnitTypeGUI\getEditForm().
Here is the call graph for this function:
Here is the caller graph for this function:
|
protected |
Protected.
Helper method to return a translation for a given member and language
Definition at line 510 of file class.ilOrgUnitType.php.
References XapiProxy\$plugin, getActivePlugins(), getDefaultLang(), getId(), ILIAS\Repository\lng(), loadTranslation(), and ILIAS\Repository\user().
Referenced by getAllTypes(), getDescription(), and getTitle().
Here is the call graph for this function:
Here is the caller graph for this function:| ilOrgUnitType::getTranslations | ( | ) |
Returns the loaded translation objects.
Definition at line 673 of file class.ilOrgUnitType.php.
References $translations, and getId().
Here is the call graph for this function:
|
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 608 of file class.ilOrgUnitType.php.
References getId(), and ilOrgUnitTypeTranslation\getInstance().
Referenced by getTranslation().
Here is the call graph for this function:
Here is the caller graph for this function:
|
protected |
Read object data from database.
| ilOrgUnitTypeException |
Definition at line 628 of file class.ilOrgUnitType.php.
References setCreateDate(), setLastUpdate(), and setOwner().
Referenced by __construct().
Here is the call graph for this function:
Here is the caller graph for this function:| ilOrgUnitType::removeIconFromIrss | ( | string | $identifier | ) |
Definition at line 776 of file class.ilOrgUnitType.php.
Referenced by save().
Here is the caller graph for this function:| ilOrgUnitType::save | ( | ) |
Wrapper around create() and update() methods.
| ilOrgUnitTypePluginException |
Definition at line 188 of file class.ilOrgUnitType.php.
References XapiProxy\$plugin, getActivePlugins(), getIconIdentifier(), getId(), getOrgUnits(), ILIAS\Repository\lng(), and removeIconFromIrss().
Here is the call graph for this function:| ilOrgUnitType::setCreateDate | ( | string | $create_date | ) |
Definition at line 766 of file class.ilOrgUnitType.php.
References $create_date.
Referenced by read().
Here is the caller graph for this function:| ilOrgUnitType::setDescription | ( | string | $a_description, |
| string | $a_lang_code = '' |
||
| ) |
Set description of OrgUnit type.
If no lang code is given, sets description for default language.
Definition at line 286 of file class.ilOrgUnitType.php.
References getDefaultLang().
Referenced by ilOrgUnitTypeGUI\getEditForm().
Here is the call graph for this function:
Here is the caller graph for this function:| ilOrgUnitType::setLastUpdate | ( | string | $last_update | ) |
Definition at line 702 of file class.ilOrgUnitType.php.
References $last_update.
Referenced by read().
Here is the caller graph for this function:| ilOrgUnitType::setOwner | ( | int | $owner | ) |
Definition at line 692 of file class.ilOrgUnitType.php.
References $owner.
Referenced by read().
Here is the caller graph for this function:| ilOrgUnitType::setTitle | ( | string | $a_title, |
| string | $a_lang_code = '' |
||
| ) |
Set title of OrgUnit type.
If no lang code is given, sets title for default language.
Definition at line 266 of file class.ilOrgUnitType.php.
References getDefaultLang().
Referenced by ilOrgUnitTypeGUI\getEditForm().
Here is the call graph for this function:
Here is the caller graph for this function:| ilOrgUnitType::setTranslations | ( | array | $translations | ) |
Getters & Setters.
| string[] | $translations |
Definition at line 665 of file class.ilOrgUnitType.php.
References $translations.
|
protected |
Helper function to check if this type can be updated.
Definition at line 646 of file class.ilOrgUnitType.php.
References XapiProxy\$plugin, and getActivePlugins().
Here is the call graph for this function:| ilOrgUnitType::withIconIdentifier | ( | string | $identifier | ) |
Definition at line 717 of file class.ilOrgUnitType.php.
|
protected |
Definition at line 43 of file class.ilOrgUnitType.php.
|
protected |
Definition at line 36 of file class.ilOrgUnitType.php.
|
staticprotected |
Definition at line 37 of file class.ilOrgUnitType.php.
|
protected |
Definition at line 47 of file class.ilOrgUnitType.php.
|
protected |
Definition at line 32 of file class.ilOrgUnitType.php.
Referenced by getCreateDate(), and setCreateDate().
|
protected |
Definition at line 40 of file class.ilOrgUnitType.php.
|
protected |
Definition at line 30 of file class.ilOrgUnitType.php.
Referenced by getDefaultLang(), and getIconIdentifier().
|
protected |
Definition at line 34 of file class.ilOrgUnitType.php.
Referenced by getIconIdentifier().
|
protected |
Definition at line 29 of file class.ilOrgUnitType.php.
Referenced by getId().
|
staticprotected |
| self[] |
Definition at line 46 of file class.ilOrgUnitType.php.
|
protected |
Definition at line 48 of file class.ilOrgUnitType.php.
|
protected |
Definition at line 33 of file class.ilOrgUnitType.php.
Referenced by getLastUpdate(), and setLastUpdate().
|
protected |
Definition at line 44 of file class.ilOrgUnitType.php.
|
protected |
Definition at line 41 of file class.ilOrgUnitType.php.
|
protected |
Definition at line 38 of file class.ilOrgUnitType.php.
|
protected |
Definition at line 39 of file class.ilOrgUnitType.php.
|
protected |
Definition at line 31 of file class.ilOrgUnitType.php.
Referenced by getOwner(), and setOwner().
|
protected |
Definition at line 35 of file class.ilOrgUnitType.php.
Referenced by getTranslations(), and setTranslations().
|
protected |
Definition at line 42 of file class.ilOrgUnitType.php.
| const ilOrgUnitType::TABLE_NAME = 'orgu_types' |
Definition at line 28 of file class.ilOrgUnitType.php.