.
* ---------------------------------------------------------------------
**/
class Appliance_Item_Relation extends CommonDBRelation {
static public $itemtype_1 = 'Appliance_Item';
static public $items_id_1 = 'appliances_items_id';
//static public $take_entity_1 = false;
static public $itemtype_2 = 'itemtype';
static public $items_id_2 = 'items_id';
//static public $take_entity_2 = true;
static function getTypeName($nb = 0) {
return _nx('appliance', 'Relation', 'Relations', $nb);
}
/**
* Get item types that can be linked to an appliance item
*
* @param boolean $all Get all possible types or only allowed ones
*
* @return array
*/
public static function getTypes($all = false): array {
global $CFG_GLPI;
$types = $CFG_GLPI['appliance_relation_types'];
foreach ($types as $key => $type) {
if (!class_exists($type)) {
continue;
}
if ($all === false && !$type::canView()) {
unset($types[$key]);
}
}
return $types;
}
static function canCreate() {
return Appliance_Item::canUpdate();
}
function canCreateItem() {
$app_item = new Appliance_Item;
$app_item->getFromDB($this->fields[Appliance_Item::getForeignKeyField()]);
return $app_item->canUpdateItem();
}
function prepareInputForAdd($input) {
return $this->prepareInput($input);
}
function prepareInputForUpdate($input) {
return $this->prepareInput($input);
}
/**
* Prepares input (for update and add)
*
* @param array $input Input data
*
* @return array
*/
private function prepareInput($input) {
$error_detected = [];
//check for requirements
if (($this->isNewItem() && (!isset($input['itemtype']) || empty($input['itemtype'])))
|| (isset($input['itemtype']) && empty($input['itemtype']))) {
$error_detected[] = __('An item type is required');
}
if (($this->isNewItem() && (!isset($input['items_id']) || empty($input['items_id'])))
|| (isset($input['items_id']) && empty($input['items_id']))) {
$error_detected[] = __('An item is required');
}
if (($this->isNewItem() && (!isset($input[self::$items_id_1]) || empty($input[self::$items_id_1])))
|| (isset($input[self::$items_id_1]) && empty($input[self::$items_id_1]))) {
$error_detected[] = __('An appliance item is required');
}
if (count($error_detected)) {
foreach ($error_detected as $error) {
Session::addMessageAfterRedirect(
$error,
true,
ERROR
);
}
return false;
}
return $input;
}
/**
* count number of appliance's items relations for a give item
*
* @param CommonDBTM $item the give item
* @param array $extra_types_where additional criteria to pass to the count function
*
* @return int number of relations
*/
public static function countForMainItem(CommonDBTM $item, $extra_types_where = []) {
$types = self::getTypes();
$clause = [];
if (count($types)) {
$clause = ['itemtype' => $types];
} else {
$clause = [new \QueryExpression('true = false')];
}
$extra_types_where = array_merge(
$extra_types_where,
$clause
);
return parent::countForMainItem($item, $extra_types_where);
}
/**
* return an array of relations for a given Appliance_Item's id
*
* @param int $appliances_items_id
*
* @return array array of string with icons and names
*/
public static function getForApplianceItem(int $appliances_items_id = 0) {
global $DB;
$iterator = $DB->request([
'FROM' => self::getTable(),
'WHERE' => [
Appliance_Item::getForeignKeyField() => $appliances_items_id
]
]);
$relations = [];
while ($row = $iterator->next()) {
$itemtype = $row['itemtype'];
$item = new $itemtype;
$item->getFromDB($row['items_id']);
$relations[$row['id']] = "".
" ".$item::getTypeName(1).
" - ".$item->getLink();
}
return $relations;
}
/**
* return a mini list of relation for a given Appliance_Item's id
* It's need the javascript return by self::getListJSForApplianceItem
* we separate in two function because the list is usually displayed in a form tag
* and we need to display an additionnal form.
*
* @param int $appliances_items_id the id of Appliance_Item
* @param bool $canedit do we have the right to edit
*
* @return string the html for the list
*/
public static function showListForApplianceItem(int $appliances_items_id = 0, bool $canedit = true) {
$relations_str = "";
foreach (Appliance_Item_Relation::getForApplianceItem($appliances_items_id) as $rel_id => $link) {
$del = "";
if ($canedit) {
$del = "";
}
$relations_str.= "
$link $del
";
}
return "
$relations_str
" . __('New relation') . "
";
}
/**
* Return the corresponding javascript to an mini html list of relation
* see self::showListForApplianceItem docblock
*
* @param CommonDBTM $item the item where the mini list will be displayed,
* we use this to check entities/is_recursive attributres
* @param bool $canedit do we have the right to edit
*
* @return string the javascript
*/
public static function getListJSForApplianceItem(
CommonDBTM $item = null,
bool $canedit = true
) {
if ($canedit) {
$form_url = Appliance_Item_Relation::getFormURL();
echo "