ILIAS  release_8 Revision v8.24
Public Member Functions | Protected Member Functions | Protected Attributes
ilBiblEntryTablePresentationGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

+ Collaboration diagram for ilBiblEntryTablePresentationGUI:

Public Member Functions

 __construct (ilBiblEntry $entry, ilBiblFactoryFacadeInterface $facade)
 ilBiblEntryTablePresentationGUI constructor. More...
 
 getHtml ()
 
 setHtml (string $html)
 
 getEntry ()
 
 setEntry (\ilBiblEntry $entry)
 

Protected Member Functions

 render ()
 

Protected Attributes

ilBiblEntry $entry
 
string $html = ''
 
ilBiblFactoryFacadeInterface $facade
 

Detailed Description

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 ilBiblEntryTablePresentationGUI

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

Definition at line 24 of file class.ilBiblEntryTablePresentationGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilBiblEntryTablePresentationGUI::__construct ( ilBiblEntry  $entry,
ilBiblFactoryFacadeInterface  $facade 
)

ilBiblEntryTablePresentationGUI constructor.

Definition at line 33 of file class.ilBiblEntryTablePresentationGUI.php.

34 {
35 $this->entry = $entry;
36 $this->facade = $facade;
37 $this->render();
38 }

References $entry, $facade, and render().

+ Here is the call graph for this function:

Member Function Documentation

◆ getEntry()

ilBiblEntryTablePresentationGUI::getEntry ( )

Definition at line 119 of file class.ilBiblEntryTablePresentationGUI.php.

119 : \ilBiblEntry
120 {
121 return $this->entry;
122 }
ilBiblEntry
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: class.ilBiblEntry.php:24

References $entry.

Referenced by render().

+ Here is the caller graph for this function:

◆ getHtml()

ilBiblEntryTablePresentationGUI::getHtml ( )

Definition at line 109 of file class.ilBiblEntryTablePresentationGUI.php.

109 : string
110 {
111 return $this->html;
112 }

References $html.

◆ render()

ilBiblEntryTablePresentationGUI::render ( )
protected
Deprecated:
Has to be refactored. Active records verwenden statt array

Definition at line 43 of file class.ilBiblEntryTablePresentationGUI.php.

43 : void
44 {
45 $attributes = $this->facade->entryFactory()->loadParsedAttributesByEntryId($this->getEntry()->getId());
46 //Get the model which declares which attributes to show in the overview table and how to show them
47 //example for overviewModels: $overviewModels['bib']['default'] => "[<strong>|bib_default_author|</strong>: ][|bib_default_title|. ]<Emph>[|bib_default_publisher|][, |bib_default_year|][, |bib_default_address|].</Emph>"
48 $overviewModels = $this->facade->overviewModelFactory()->getAllOverviewModelsByType($this->facade->type());
49 //get design for specific entry type or get filetypes default design if type is not specified
50 $entryType = $this->getEntry()->getType();
51 //if there is no model for the specific entrytype (book, article, ....) the entry overview will be structured by the default entrytype from the given filetype (ris, bib, ...)
52 if (!($overviewModels[$this->facade->typeFactory()->getDataTypeIdentifierByInstance($this->facade->entryFactory()->getFileType())][$entryType] ?? false)) {
53 $entryType = 'default';
54 }
55 $single_entry = $overviewModels[$entryType];
56 //split the model into single attributes (which begin and end with a bracket, eg [|bib_default_title|. ] )
57 //such values are saved in $placeholders[0] while the same values but whithout brackets are saved in $placeholders[1] (eg |bib_default_title|. )
58 preg_match_all('/\[(.*?)\]/', $single_entry, $placeholders);
59 foreach ($placeholders[1] as $key => $placeholder) {
60 //cut a moedel attribute like |bib_default_title|. in three pieces while $cuts[1] is the attribute key for the actual value and $cuts[0] is what comes before respectively $cuts[2] is what comes after the value if it is not empty.
61 $cuts = explode('|', $placeholder);
62 //if attribute key does not exist, because it comes from the default entry (e.g. ris_default_u2), we replace 'default' with the entrys type (e.g. ris_book_u2)
63 if (!($attributes[$cuts[1]] ?? false)) {
64 $attribute_elements = explode('_', $cuts[1]);
65 $attribute_elements[1] = strtolower($this->getEntry()->getType());
66 $cuts[1] = implode('_', $attribute_elements);
67 }
68 if (($attributes[$cuts[1]] ?? false)) {
69 //if the attribute for the attribute key exists, replace one attribute in the overview text line of a single entry with its actual value and the text before and after the value given by the model
70 $single_entry = str_replace($placeholders[0][$key], $cuts[0] . $attributes[$cuts[1]]
71 . $cuts[2], $single_entry);
72 // replace the <emph> tags with a span, in order to make text italic by css
73 do {
74 $first_sign_after_begin_emph_tag = strpos(strtolower($single_entry), '<emph>')
75 + 6;
76 $last_sign_after_end_emph_tag = strpos(strtolower($single_entry), '</emph>');
77 $italic_text_length = $last_sign_after_end_emph_tag
78 - $first_sign_after_begin_emph_tag;
79 //would not be true if there is no <emph> tag left
80 if ($last_sign_after_end_emph_tag) {
81 $italic_text = substr($single_entry, $first_sign_after_begin_emph_tag, $italic_text_length);
82 //parse
83 $it_tpl = new ilTemplate(
84 "tpl.bibliographic_italicizer.html",
85 true,
86 true,
87 "Modules/Bibliographic"
88 );
89 $it_tpl->setCurrentBlock("italic_section");
90 $it_tpl->setVariable('ITALIC_STRING', $italic_text);
91 $it_tpl->parseCurrentBlock();
92 //replace the emph tags and the text between with the parsed text from il_tpl
93 $text_before_emph_tag = substr($single_entry, 0, $first_sign_after_begin_emph_tag
94 - 6);
95 $text_after_emph_tag = substr($single_entry, $last_sign_after_end_emph_tag
96 + 7);
97 $single_entry = $text_before_emph_tag . $it_tpl->get()
98 . $text_after_emph_tag;
99 }
100 } while ($last_sign_after_end_emph_tag);
101 } else {
102 //if the attribute for the attribute key does not exist, just remove this attribute-key from the overview text line of a single entry
103 $single_entry = str_replace($placeholders[0][$key], '', $single_entry);
104 }
105 }
106 $this->setHtml($single_entry);
107 }
ilTemplate
special template class to simplify handling of ITX/PEAR
Definition: class.ilTemplate.php:17
$attributes
$attributes
Definition: metadata.php:248
ILIAS\LTI\ToolProvider\$key
string $key
Consumer key/client ID value.
Definition: System.php:193

References $attributes, ILIAS\LTI\ToolProvider\$key, getEntry(), ILIAS\Survey\Mode\getId(), and setHtml().

Referenced by __construct().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setEntry()

ilBiblEntryTablePresentationGUI::setEntry ( \ilBiblEntry  $entry)

Definition at line 124 of file class.ilBiblEntryTablePresentationGUI.php.

124 : void
125 {
126 $this->entry = $entry;
127 }

References $entry.

◆ setHtml()

ilBiblEntryTablePresentationGUI::setHtml ( string  $html)

Definition at line 114 of file class.ilBiblEntryTablePresentationGUI.php.

114 : void
115 {
116 $this->html = $html;
117 }

References $html, and ILIAS\Repository\html().

Referenced by render().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $entry

ilBiblEntry ilBiblEntryTablePresentationGUI::$entry
protected

Definition at line 26 of file class.ilBiblEntryTablePresentationGUI.php.

Referenced by __construct(), getEntry(), and setEntry().

◆ $facade

ilBiblFactoryFacadeInterface ilBiblEntryTablePresentationGUI::$facade
protected

Definition at line 28 of file class.ilBiblEntryTablePresentationGUI.php.

Referenced by __construct().

◆ $html

string ilBiblEntryTablePresentationGUI::$html = ''
protected

Definition at line 27 of file class.ilBiblEntryTablePresentationGUI.php.

Referenced by getHtml(), and setHtml().

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