This class represents a copyright property in a property form. More...

Inheritance diagram for ilCopyrightInputGUI:

Collaboration diagram for ilCopyrightInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	setValue ($a_value)
	Set Value. More...

	getValue ()
	Get Value. More...

	setCols ($a_cols)
	Set Cols. More...

	getCols ()
	Get Cols. More...

	setRows ($a_rows)
	Set Rows. More...

	getRows ()
	Get Rows. More...

	setValueByArray ($a_values)
	Set value by array. More...

	checkInput ()
	Check input, strip slashes etc. More...

	insert (&$a_tpl)
	Insert property html. More...

Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	executeCommand ()
	Execute command. More...

	getType ()
	Get Type. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setPostVar ($a_postvar)
	Set Post Variable. More...

	getPostVar ()
	Get Post Variable. More...

	getFieldId ()
	Get Post Variable. More...

	setInfo ($a_info)
	Set Information Text. More...

	getInfo ()
	Get Information Text. More...

	setAlert ($a_alert)
	Set Alert Text. More...

	getAlert ()
	Get Alert Text. More...

	setRequired ($a_required)
	Set Required. More...

	getRequired ()
	Get Required. More...

	setDisabled ($a_disabled)
	Set Disabled. More...

	getDisabled ()
	Get Disabled. More...

	checkInput ()
	Check input, strip slashes etc. More...

	setParentForm ($a_parentform)
	Set Parent Form. More...

	getParentForm ()
	Get Parent Form. More...

	setParent ($a_val)
	Set Parent GUI object. More...

	getParent ()
	Get Parent GUI object. More...

	getSubForm ()
	Get sub form html. More...

	hideSubForm ()
	Sub form hidden on init? More...

	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...

	getHiddenTitle ()
	Get hidden title. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	writeToSession ()
	Write to session. More...

	clearFromSession ()
	Clear session value. More...

	readFromSession ()
	Read from session. More...

	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...

	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...

	getMulti ()
	Get Multi. More...

	setMultiValues (array $a_values)
	Set multi values. More...

	getMultiValues ()
	Get multi values. More...

	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...

	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

Protected Attributes
	$value

	$cols

	$rows

	$settings

Protected Attributes inherited from ilFormPropertyGUI
	$ctrl

	$lng

	$type

	$title

	$postvar

	$info

	$alert

	$required = false

	$parentgui

	$parentform

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Detailed Description

This class represents a copyright property in a property form.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 16 of file class.ilCopyrightInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilCopyrightInputGUI::__construct	(	$a_title = `""`,
		$a_postvar = `""`
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Definition at line 29 of file class.ilCopyrightInputGUI.php.

References ilFormPropertyGUI\$lng, ilMDSettings\_getInstance(), settings(), and ilFormPropertyGUI\setType().

     {
         global $lng;
         
         $this->lng = $lng;
         $this->lng->loadLanguageModule("meta");
         
         parent::__construct($a_title, $a_postvar);
         $this->setType("copyright");
         $this->settings = ilMDSettings::_getInstance();
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilCopyrightInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Definition at line 116 of file class.ilCopyrightInputGUI.php.

References $_POST, ilFormPropertyGUI\$lng, ilFormPropertyGUI\getPostVar(), and ilUtil\stripSlashes().

     {
         global $lng;
         
         if ($this->usePurifier() && $this->getPurifier()) {
             $_POST[$this->getPostVar()]["ta"] = ilUtil::stripSlashes($_POST[$this->getPostVar()]["ta"]);
         }
         
         // todo: implement setRequired, if needed
 
         return true;
     }

Here is the call graph for this function:

◆ getCols()

ilCopyrightInputGUI::getCols ( )

Get Cols.

Returns: int Cols

Definition at line 76 of file class.ilCopyrightInputGUI.php.

References $cols.

Referenced by insert().

     {
         return $this->cols;
     }

Here is the caller graph for this function:

◆ getRows()

ilCopyrightInputGUI::getRows ( )

Get Rows.

Returns: int Rows

Definition at line 96 of file class.ilCopyrightInputGUI.php.

References $rows.

Referenced by insert().

     {
         return $this->rows;
     }

Here is the caller graph for this function:

◆ getValue()

ilCopyrightInputGUI::getValue ( )

Get Value.

Returns: string Value

Definition at line 56 of file class.ilCopyrightInputGUI.php.

References $value.

Referenced by insert().

     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ insert()

ilCopyrightInputGUI::insert ( & $a_tpl )

Insert property html.

Definition at line 132 of file class.ilCopyrightInputGUI.php.

References ilMDCopyrightSelectionEntry\_extractEntryId(), ilMDCopyrightSelectionEntry\_getEntries(), getCols(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getHiddenTag(), ilFormPropertyGUI\getPostVar(), getRows(), getValue(), ilUtil\prepareFormOutput(), and settings().

     {
         include_once('Services/MetaData/classes/class.ilMDCopyrightSelectionEntry.php');
         
         $ttpl = new ilTemplate("tpl.prop_copyright.html", true, true, "Services/MetaData");
         $entries = ilMDCopyrightSelectionEntry::_getEntries();
         $use_selection = ($this->settings->isCopyrightSelectionActive() && count($entries));
         $val = $this->getValue();
         
         if ($use_selection) {
             $default_id = ilMDCopyrightSelectionEntry::_extractEntryId($val["ta"]);
         
             include_once('Services/MetaData/classes/class.ilMDCopyrightSelectionEntry.php');
             $found = false;
             foreach ($entries as $entry) {
                 $ttpl->setCurrentBlock('copyright_selection');
                 
                 if ($entry->getEntryId() == $default_id) {
                     $found = true;
                     $ttpl->setVariable('COPYRIGHT_CHECKED', 'checked="checked"');
                 }
                 $ttpl->setVariable('COPYRIGHT_ID', $entry->getEntryId());
                 $ttpl->setVariable('COPYRIGHT_TITLE', $entry->getTitle());
                 $ttpl->setVariable('COPYRIGHT_DESCRIPTION', $entry->getDescription());
                 $ttpl->setVariable('SPOST_VAR', $this->getPostVar());
                 $ttpl->parseCurrentBlock();
             }
             
             $ttpl->setCurrentBlock('copyright_selection');
             if (!$found) {
                 $ttpl->setVariable('COPYRIGHT_CHECKED', 'checked="checked"');
             }
             $ttpl->setVariable('COPYRIGHT_ID', 0);
             $ttpl->setVariable('COPYRIGHT_TITLE', $this->lng->txt('meta_cp_own'));
             $ttpl->setVariable('SPOST_VAR', $this->getPostVar());
             
             $ttpl->parseCurrentBlock();
         }
 
         
         if ($this->getCols() > 5) {
             $ttpl->setCurrentBlock("prop_ta_c");
             $ttpl->setVariable("COLS", $this->getCols());
             $ttpl->parseCurrentBlock();
         } else {
             $ttpl->touchBlock("prop_ta_w");
         }
                 
         $ttpl->setCurrentBlock("prop_copyright");
         $ttpl->setVariable("ROWS", $this->getRows());
         if (!$this->getDisabled()) {
             $ttpl->setVariable(
                 "POST_VAR",
                 $this->getPostVar()
             );
         }
         $ttpl->setVariable("ID", $this->getFieldId());
         if ($this->getDisabled()) {
             $ttpl->setVariable('DISABLED', 'disabled="disabled" ');
         }
         
         if ($this->getDisabled()) {
             $ttpl->setVariable(
                 "HIDDEN_INPUT",
                 $this->getHiddenTag($this->getPostVar(), $this->getValue())
             );
         }
         
         if (!$use_selection || !$found) {
             $ttpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($val["ta"]));
         }
         $ttpl->parseCurrentBlock();
         
         
         $a_tpl->setCurrentBlock("prop_generic");
         $a_tpl->setVariable("PROP_GENERIC", $ttpl->get());
         $a_tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ setCols()

ilCopyrightInputGUI::setCols ( $a_cols )

Set Cols.

Parameters

int $a_cols Cols

Definition at line 66 of file class.ilCopyrightInputGUI.php.

Referenced by ilMDEditorGUI\initQuickEditForm().

     {
         $this->cols = $a_cols;
     }

Here is the caller graph for this function:

◆ setRows()

ilCopyrightInputGUI::setRows ( $a_rows )

Set Rows.

Parameters

int $a_rows Rows

Definition at line 86 of file class.ilCopyrightInputGUI.php.

References rows.

     {
         $this->rows = $a_rows;
     }

◆ setValue()

ilCopyrightInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

Definition at line 46 of file class.ilCopyrightInputGUI.php.

Referenced by setValueByArray().

     {
         $this->value = $a_value;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilCopyrightInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

Definition at line 106 of file class.ilCopyrightInputGUI.php.

References ilFormPropertyGUI\getPostVar(), and setValue().

     {
         $this->setValue($a_values[$this->getPostVar()]);
     }

Here is the call graph for this function:

Field Documentation

◆ $cols

ilCopyrightInputGUI::$cols

protected

Definition at line 19 of file class.ilCopyrightInputGUI.php.

Referenced by getCols().

◆ $rows

ilCopyrightInputGUI::$rows

protected

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

Referenced by getRows().

◆ $settings

ilCopyrightInputGUI::$settings

protected

Definition at line 21 of file class.ilCopyrightInputGUI.php.

◆ $value

ilCopyrightInputGUI::$value

protected

Definition at line 18 of file class.ilCopyrightInputGUI.php.

Referenced by getValue().

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

Services/MetaData/classes/class.ilCopyrightInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getCols()

◆ getRows()

◆ getValue()

◆ insert()

◆ setCols()

◆ setRows()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $cols

◆ $rows

◆ $settings

◆ $value