ilDclNReferenceFieldGUI Class Reference

Class ilDclNReferenceFieldGUI. More...

Collaboration diagram for ilDclNReferenceFieldGUI:

Public Member Functions
	__construct (ilDclNReferenceRecordFieldModel $field)
	getSingleHTML ($options=null)
	getHTML ()

Protected Member Functions
	buildTemplate (ilDclNReferenceRecordFieldModel $record_field, $values, $options)

Protected Attributes
	$field

Detailed Description

Class ilDclNReferenceFieldGUI.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 8 of file class.ilDclNReferenceFieldGUI.php.

Constructor & Destructor Documentation

__construct()

ilDclNReferenceFieldGUI::__construct

(

ilDclNReferenceRecordFieldModel

$field

)

Parameters

ilDclNReferenceRecordFieldModel

$field

Definition at line 20 of file class.ilDclNReferenceFieldGUI.php.

References $field.

    {
        $this->field = $field;
    }

Member Function Documentation

buildTemplate()

ilDclNReferenceFieldGUI::buildTemplate ( ilDclNReferenceRecordFieldModel  $record_field,   $values,   $options  )

protected

Parameters

$record_field
$values
$options

Returns

ilTemplate

Definition at line 53 of file class.ilDclNReferenceFieldGUI.php.

References PHPMailer\PHPMailer\$options, $tpl, $values, ilDclNReferenceRecordFieldModel\doUpdate(), ilDclBaseRecordFieldModel\getField(), ilDclNReferenceRecordFieldModel\getLinkHTML(), ilDclCache\getRecordCache(), and ilDclBaseRecordFieldModel\setValue().

Referenced by getSingleHTML().

    {
        $tpl = new ilTemplate("tpl.reference_list.html", true, true, "Modules/DataCollection");
        $tpl->setCurrentBlock("reference_list");
        foreach ($values as $value) {
            $ref_record = ilDclCache::getRecordCache($value);
            if (!$ref_record->getTableId() || !$record_field->getField() || !$record_field->getField()->getTableId()) {
                //the referenced record_field does not seem to exist.
                $record_field->setValue(0);
                $record_field->doUpdate();
            } else {
                $tpl->setCurrentBlock("reference");
                if (!$options) {
                    $tpl->setVariable("CONTENT", $ref_record->getRecordFieldHTML($record_field->getField()->getFieldRef()));
                } else {
                    $tpl->setVariable("CONTENT", $record_field->getLinkHTML($options['link']['name'], $value));
                }
                $tpl->parseCurrentBlock();
            }
        }
        $tpl->parseCurrentBlock();

        return $tpl;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHTML()

ilDclNReferenceFieldGUI::getHTML

(

)

Returns

array|mixed|string

Definition at line 82 of file class.ilDclNReferenceFieldGUI.php.

References $field, $html, $tpl, $values, ilDclCache\getRecordCache(), ilDclDatatype\INPUTFORMAT_DATETIME, ilDclDatatype\INPUTFORMAT_NUMBER, and ilUtil\sortArray().

    {
        $values = $this->field->getValue();
        $record_field = $this->field;

        if (!$values or !count($values)) {
            return "";
        }

        $html = "";
        $cut = false;
        $tpl = new ilTemplate("tpl.reference_hover.html", true, true, "Modules/DataCollection");
        $tpl->setCurrentBlock("reference_list");
        $elements = array();
        foreach ($values as $value) {
            $ref_record = ilDclCache::getRecordCache($value);
            if (!$ref_record->getTableId() or !$record_field->getField() or !$record_field->getField()->getTableId()) {
                //the referenced record_field does not seem to exist.
                $record_field->setValue(null);
                $record_field->doUpdate();
            } else {
                $elements[] = array('value' => $ref_record->getRecordFieldHTML($this->field->getField()->getFieldRef()),
                                    'sort' => $ref_record->getRecordFieldSortingValue($this->field->getField()->getFieldRef()));
            }
        }
        //sort fetched elements
        $is_numeric = false;
        $ref_field = new ilDclBaseFieldModel($this->field->getField()->getFieldRef());
        switch ($ref_field->getDatatypeId()) {
            case ilDclDatatype::INPUTFORMAT_DATETIME:
            case ilDclDatatype::INPUTFORMAT_NUMBER:
                $is_numeric = true;
                break;
        }
        $elements = ilUtil::sortArray($elements, 'sort', 'asc', $is_numeric);

        //concat
        foreach ($elements as $element) {
            if ((strlen($html) < $record_field->getMaxReferenceLength())) {
                $html .= $element['value'] . ", ";
            } else {
                $cut = true;
            }
            $tpl->setCurrentBlock("reference");
            $tpl->setVariable("CONTENT", $element['value']);
            $tpl->parseCurrentBlock();
        }

        $html = substr($html, 0, -2);
        if ($cut) {
            $html .= "...";
        }
        $tpl->setVariable("RECORD_ID", $record_field->getRecord()->getId());
        $tpl->setVariable("ALL", $html);
        $tpl->parseCurrentBlock();

        return $tpl->get();
    }

Here is the call graph for this function:

getSingleHTML()

ilDclNReferenceFieldGUI::getSingleHTML

(

$options = null

)

Parameters

ilDclNReferenceRecordFieldModel	$field
null	$options

Returns

string

Definition at line 32 of file class.ilDclNReferenceFieldGUI.php.

References PHPMailer\PHPMailer\$options, $tpl, $values, and buildTemplate().

    {
        $values = $this->field->getValue();

        if (!$values || !count($values)) {
            return "";
        }

        $tpl = $this->buildTemplate($this->field, $values, $options);

        return $tpl->get();
    }

Here is the call graph for this function:

Field Documentation

$field

ilDclNReferenceFieldGUI::$field

protected

Definition at line 14 of file class.ilDclNReferenceFieldGUI.php.

Referenced by __construct(), and getHTML().

---

The documentation for this class was generated from the following file:

• Modules/DataCollection/classes/Fields/NReference/class.ilDclNReferenceFieldGUI.php