ILIAS  release_8 Revision v8.23
Static Public Member Functions | Static Protected Member Functions | Private Attributes
ilPDFCompInstaller Class Reference
+ Collaboration diagram for ilPDFCompInstaller:

Static Public Member Functions

static registerPurpose (string $service, string $purpose, string $preferred)
 
static unregisterPurpose (string $service, string $purpose)
 
static unregisterPreferred (string $service, string $purpose, string $preferred)
 
static flushPurposes (string $service)
 
static isPurposeRegistered (string $service, string $purpose)
 
static getPurposesByService (string $service)
 
static getServices ()
 
static checkForMultipleServiceAndPurposeCombination ()
 
static doCleanUp ()
 
static updateFromXML (string $service, string $purpose, string $preferred)
 
static registerRenderer (string $renderer, string $path)
 
static registerRendererAvailability (string $renderer, string $service, string $purpose)
 

Static Protected Member Functions

static addPurpose (string $service, string $purpose)
 
static addPreferred (string $service, string $purpose, string $preferred)
 

Private Attributes

const PURPOSE_CONF_TABLE = "pdfgen_conf"
 
const PURPOSE_MAP_TABLE = "pdfgen_map"
 
const PURPOSE_PURPOSES_TABLE = "pdfgen_purposes"
 
const RENDERER_TABLE = "pdfgen_renderer"
 
const RENDERER_AVAIL_TABLE = "pdfgen_renderer_avail"
 

Detailed Description

Deprecated:

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

Member Function Documentation

◆ addPreferred()

static ilPDFCompInstaller::addPreferred ( string  $service,
string  $purpose,
string  $preferred 
)
staticprotected

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

References $DIC, $ilDB, and $service.

53  : void
54  {
55  global $DIC;
56  $ilDB = $DIC->database();
57  $ilDB->insert(
58  self::PURPOSE_MAP_TABLE,
59  [
60  'map_id' => ['int', $ilDB->nextId(self::PURPOSE_MAP_TABLE)],
61  'service' => ['text', $service],
62  'purpose' => ['text', $purpose],
63  'preferred' => ['text', $preferred],
64  'selected' => ['text', $preferred]
65  ]
66  );
67  }
$DIC
global $DIC
Definition: feed.php:28
$service
$service
Definition: ltiservices.php:43

◆ addPurpose()

static ilPDFCompInstaller::addPurpose ( string  $service,
string  $purpose 
)
staticprotected

Definition at line 38 of file class.ilPDFCompInstaller.php.

References $DIC, $ilDB, and $service.

38  : void
39  {
40  global $DIC;
41  $ilDB = $DIC->database();
42 
43  $ilDB->insert(
44  self::PURPOSE_PURPOSES_TABLE,
45  [
46  'purpose_id' => ['int', $ilDB->nextId(self::PURPOSE_PURPOSES_TABLE)],
47  'service' => ['text', $service],
48  'purpose' => ['text', $purpose],
49  ]
50  );
51  }
$DIC
global $DIC
Definition: feed.php:28
$service
$service
Definition: ltiservices.php:43

◆ checkForMultipleServiceAndPurposeCombination()

static ilPDFCompInstaller::checkForMultipleServiceAndPurposeCombination ( )
static

Definition at line 150 of file class.ilPDFCompInstaller.php.

References $DIC, $ilDB, and $query.

Referenced by ilObjPDFGenerationGUI\configForm().

150  : bool
151  {
152  global $DIC;
153  $ilDB = $DIC->database();
154  $query = 'SELECT service, purpose FROM ' . self::PURPOSE_PURPOSES_TABLE . ' GROUP BY service, purpose having count(*) > 1';
155  $result = $ilDB->query($query);
156  $row = $ilDB->fetchAssoc($result);
157 
158  return is_array($row) && !empty($row);
159  }
$DIC
global $DIC
Definition: feed.php:28
$query
$query
Definition: proxy_ylocal.php:13
+ Here is the caller graph for this function:

◆ doCleanUp()

static ilPDFCompInstaller::doCleanUp ( )
static

Definition at line 161 of file class.ilPDFCompInstaller.php.

References $DIC, $ilDB, and $query.

Referenced by ilObjPDFGenerationGUI\doCleanUp().

161  : void
162  {
163  global $DIC;
164  $ilDB = $DIC->database();
165  $query = 'SELECT service, purpose FROM ' . self::PURPOSE_PURPOSES_TABLE . ' GROUP BY service, purpose having count(*) > 1';
166  $result = $ilDB->query($query);
167  while ($row = $ilDB->fetchAssoc($result)) {
168  self::unregisterPurpose($row['service'], $row['purpose']);
169  self::addPurpose($row['service'], $row['purpose']);
170  }
171 
172  $query = 'SELECT service, purpose, preferred FROM ' . self::PURPOSE_MAP_TABLE . ' GROUP BY service, purpose, preferred having count(*) > 1';
173 
174  $result = $ilDB->query($query);
175  while ($row = $ilDB->fetchAssoc($result)) {
176  self::unregisterPreferred($row['service'], $row['purpose'], $row['preferred']);
177  self::addPreferred($row['service'], $row['purpose'], $row['preferred']);
178  }
179  }
$DIC
global $DIC
Definition: feed.php:28
$query
$query
Definition: proxy_ylocal.php:13
+ Here is the caller graph for this function:

◆ flushPurposes()

static ilPDFCompInstaller::flushPurposes ( string  $service)
static

Definition at line 88 of file class.ilPDFCompInstaller.php.

References $DIC, and $ilDB.

88  : void
89  {
90  global $DIC;
91  $ilDB = $DIC->database();
92 
93  $ilDB->manipulate("DELETE FROM " . self::PURPOSE_PURPOSES_TABLE . " WHERE service = " . $ilDB->quote(
94  $service,
95  "text"
96  ));
97  }
$DIC
global $DIC
Definition: feed.php:28
$service
$service
Definition: ltiservices.php:43

◆ getPurposesByService()

static ilPDFCompInstaller::getPurposesByService ( string  $service)
static
Parameters
string$service
Returns
string[]

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

References $DIC, $ilDB, and $query.

116  : array
117  {
118  global $DIC;
119  $ilDB = $DIC->database();
120 
121  $query = 'SELECT purpose FROM ' . self::PURPOSE_PURPOSES_TABLE . ' WHERE service = ' . $ilDB->quote(
122  $service,
123  'text'
124  );
125  $result = $ilDB->query($query);
126  $purposes = [];
127  while ($row = $ilDB->fetchAssoc($result)) {
128  $purposes[] = $row['purpose'];
129  }
130  return $purposes;
131  }
$DIC
global $DIC
Definition: feed.php:28
$query
$query
Definition: proxy_ylocal.php:13
$service
$service
Definition: ltiservices.php:43

◆ getServices()

static ilPDFCompInstaller::getServices ( )
static
Returns
string[]

Definition at line 136 of file class.ilPDFCompInstaller.php.

References $DIC, $ilDB, and $query.

136  : array
137  {
138  global $DIC;
139  $ilDB = $DIC->database();
140 
141  $query = 'SELECT service FROM ' . self::PURPOSE_PURPOSES_TABLE . ' GROUP BY service';
142  $result = $ilDB->query($query);
143  $services = [];
144  while ($row = $ilDB->fetchAssoc($result)) {
145  $services[] = $row['service'];
146  }
147  return $services;
148  }
$DIC
global $DIC
Definition: feed.php:28
$query
$query
Definition: proxy_ylocal.php:13

◆ isPurposeRegistered()

static ilPDFCompInstaller::isPurposeRegistered ( string  $service,
string  $purpose 
)
static

Definition at line 99 of file class.ilPDFCompInstaller.php.

References $DIC, $ilDB, $query, and ILIAS\Repository\int().

99  : bool
100  {
101  global $DIC;
102  $ilDB = $DIC->database();
103 
104  $query = 'SELECT count(*) num FROM ' . self::PURPOSE_PURPOSES_TABLE . ' WHERE service = '
105  . $ilDB->quote($service, 'text') . ' AND purpose = ' . $ilDB->quote($purpose, 'text');
106  $result = $ilDB->query($query);
107  $row = $ilDB->fetchAssoc($result);
108 
109  return is_array($row) && (int) $row['num'] !== 0;
110  }
$DIC
global $DIC
Definition: feed.php:28
$query
$query
Definition: proxy_ylocal.php:13
$service
$service
Definition: ltiservices.php:43
+ Here is the call graph for this function:

◆ registerPurpose()

static ilPDFCompInstaller::registerPurpose ( string  $service,
string  $purpose,
string  $preferred 
)
static

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

32  : void
33  {
34  self::addPurpose($service, $purpose);
35  self::addPreferred($service, $purpose, $preferred);
36  }
$service
$service
Definition: ltiservices.php:43

◆ registerRenderer()

static ilPDFCompInstaller::registerRenderer ( string  $renderer,
string  $path 
)
static

Definition at line 191 of file class.ilPDFCompInstaller.php.

References $DIC, $ilDB, and $path.

191  : void
192  {
193  global $DIC;
194  $ilDB = $DIC->database();
195 
196  $ilDB->insert(
197  self::RENDERER_TABLE,
198  [
199  'renderer_id' => ['int', $ilDB->nextId(self::RENDERER_TABLE)],
200  'renderer' => ['text', $renderer],
201  'path' => ['text', $path]
202  ]
203  );
204  }
$path
$path
Definition: ltiservices.php:32
$DIC
global $DIC
Definition: feed.php:28

◆ registerRendererAvailability()

static ilPDFCompInstaller::registerRendererAvailability ( string  $renderer,
string  $service,
string  $purpose 
)
static

Definition at line 206 of file class.ilPDFCompInstaller.php.

References $DIC, $ilDB, and $service.

206  : void
207  {
208  global $DIC;
209  $ilDB = $DIC->database();
210 
211  $ilDB->insert(
212  self::RENDERER_AVAIL_TABLE,
213  [
214  'availability_id' => ['int', $ilDB->nextId(self::RENDERER_AVAIL_TABLE)],
215  'service' => ['text', $service],
216  'purpose' => ['text', $purpose],
217  'renderer' => ['text', $renderer]
218  ]
219  );
220  }
$DIC
global $DIC
Definition: feed.php:28
$service
$service
Definition: ltiservices.php:43

◆ unregisterPreferred()

static ilPDFCompInstaller::unregisterPreferred ( string  $service,
string  $purpose,
string  $preferred 
)
static

Definition at line 78 of file class.ilPDFCompInstaller.php.

References $DIC, and $ilDB.

78  : void
79  {
80  global $DIC;
81  $ilDB = $DIC->database();
82 
83  $ilDB->manipulate("DELETE FROM " . self::PURPOSE_MAP_TABLE .
84  " WHERE service = " . $ilDB->quote($service, "text") . " AND purpose = " . $ilDB->quote($purpose, "text") .
85  " AND preferred = " . $ilDB->quote($preferred, "text"));
86  }
$DIC
global $DIC
Definition: feed.php:28
$service
$service
Definition: ltiservices.php:43

◆ unregisterPurpose()

static ilPDFCompInstaller::unregisterPurpose ( string  $service,
string  $purpose 
)
static

Definition at line 69 of file class.ilPDFCompInstaller.php.

References $DIC, and $ilDB.

69  : void
70  {
71  global $DIC;
72  $ilDB = $DIC->database();
73 
74  $ilDB->manipulate("DELETE FROM " . self::PURPOSE_PURPOSES_TABLE .
75  " WHERE service = " . $ilDB->quote($service, "text") . " AND purpose = " . $ilDB->quote($purpose, "text"));
76  }
$DIC
global $DIC
Definition: feed.php:28
$service
$service
Definition: ltiservices.php:43

◆ updateFromXML()

static ilPDFCompInstaller::updateFromXML ( string  $service,
string  $purpose,
string  $preferred 
)
static

Definition at line 181 of file class.ilPDFCompInstaller.php.

References $parts.

Referenced by ilPDFGenerationDefinitionProcessor\beginTag().

181  : void
182  {
183  $parts = explode('/', $service);
184  $service = $parts[1];
185 
186  if (!self::isPurposeRegistered($service, $purpose)) {
187  self::registerPurpose($service, $purpose, $preferred);
188  }
189  }
$parts
if($clientAssertionType !='urn:ietf:params:oauth:client-assertion-type:jwt-bearer'|| $grantType !='client_credentials') $parts
Definition: ltitoken.php:64
$service
$service
Definition: ltiservices.php:43
+ Here is the caller graph for this function:

Field Documentation

◆ PURPOSE_CONF_TABLE

const ilPDFCompInstaller::PURPOSE_CONF_TABLE = "pdfgen_conf"
private

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

◆ PURPOSE_MAP_TABLE

const ilPDFCompInstaller::PURPOSE_MAP_TABLE = "pdfgen_map"
private

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

◆ PURPOSE_PURPOSES_TABLE

const ilPDFCompInstaller::PURPOSE_PURPOSES_TABLE = "pdfgen_purposes"
private

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

◆ RENDERER_AVAIL_TABLE

const ilPDFCompInstaller::RENDERER_AVAIL_TABLE = "pdfgen_renderer_avail"
private

Definition at line 30 of file class.ilPDFCompInstaller.php.

◆ RENDERER_TABLE

const ilPDFCompInstaller::RENDERER_TABLE = "pdfgen_renderer"
private

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

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