Open Journal Systems  3.3.0
Context.php
1 <?php
2 /*
3  * citeproc-php
4  *
5  * @link http://github.com/seboettg/citeproc-php for the source repository
6  * @copyright Copyright (c) 2016 Sebastian Böttger.
7  * @license https://opensource.org/licenses/MIT
8  */
9 
10 namespace Seboettg\CiteProc;
11 
25 
32 class Context
33 {
37  private $macros;
38 
42  private $locale;
43 
47  private $bibliography;
48 
52  private $citation;
53 
57  private $sorting;
58 
62  private $mode;
63 
67  private $citationItems;
68 
72  private $results;
73 
77  private $root;
78 
82  private $globalOptions;
83 
87  private $bibliographySpecificOptions;
88 
92  private $citationSpecificOptions;
93 
97  private $renderingState;
98 
102  private $cssStyle;
103 
107  private $info;
108 
112  protected $markupExtension = [];
113 
117  private $citationsAsArray = false;
118 
119  public function __construct($locale = null)
120  {
121  if (!empty($locale)) {
122  $this->locale = $locale;
123  }
124 
125  $this->macros = new ArrayList();
126  $this->citationItems = new DataList();
127  $this->results = new ArrayList();
128  $this->renderingState = RenderingState::RENDERING();
129  }
130 
131  public function addMacro($key, $macro)
132  {
133  $this->macros->add($key, $macro);
134  }
135 
140  public function getMacro($key)
141  {
142  return $this->macros->get($key);
143  }
144 
148  public function setLocale(Locale $locale)
149  {
150  $this->locale = $locale;
151  }
152 
156  public function getLocale()
157  {
158  return $this->locale;
159  }
160 
164  public function getBibliography()
165  {
166  return $this->bibliography;
167  }
168 
172  public function setBibliography(Bibliography $bibliography)
173  {
174  $this->bibliography = $bibliography;
175  }
176 
180  public function getCitation()
181  {
182  return $this->citation;
183  }
184 
188  public function setCitation($citation)
189  {
190  $this->citation = $citation;
191  }
192 
196  public function setCitationsAsArray($citationsAsArray = true)
197  {
198  $this->citationsAsArray = $citationsAsArray;
199  }
200 
201  public function isCitationsAsArray()
202  {
203  return $this->citationsAsArray;
204  }
205 
206  public function setSorting($sorting)
207  {
208  $this->sorting = $sorting;
209  }
210 
211  public function getSorting()
212  {
213  return $this->sorting;
214  }
215 
220  public function getMode()
221  {
222  return $this->mode;
223  }
224 
228  public function setMode($mode)
229  {
230  $this->mode = $mode;
231  }
232 
237  public function isModeCitation()
238  {
239  return $this->mode === "citation";
240  }
241 
246  public function isModeBibliography()
247  {
248  return $this->mode === "bibliography";
249  }
250 
254  public function getCitationItems()
255  {
256  return $this->citationItems;
257  }
258 
262  public function setCitationItems(&$citationItems)
263  {
264  $this->citationItems = $citationItems;
265  }
266 
267  public function hasCitationItems()
268  {
269  return ($this->citationItems->count() > 0);
270  }
271 
275  public function getMacros()
276  {
277  return $this->macros;
278  }
279 
283  public function getResults()
284  {
285  return $this->results;
286  }
287 
291  public function getRoot()
292  {
293  return $this->root;
294  }
295 
299  public function setRoot(Root $root)
300  {
301  $this->root = $root;
302  }
303 
307  public function getGlobalOptions()
308  {
309  return $this->globalOptions;
310  }
311 
315  public function setGlobalOptions(GlobalOptions $globalOptions)
316  {
317  $this->globalOptions = $globalOptions;
318  }
319 
323  public function getRenderingState()
324  {
325  return $this->renderingState;
326  }
327 
331  public function setRenderingState(RenderingState $renderingState)
332  {
333  $this->renderingState = $renderingState;
334  }
335 
339  public function getBibliographySpecificOptions()
340  {
341  return $this->bibliographySpecificOptions;
342  }
343 
347  public function setBibliographySpecificOptions(BibliographyOptions $bibliographySpecificOptions)
348  {
349  $this->bibliographySpecificOptions = $bibliographySpecificOptions;
350  }
351 
355  public function getCitationSpecificOptions()
356  {
357  return $this->citationSpecificOptions;
358  }
359 
363  public function setCitationSpecificOptions(CitationOptions $citationSpecificOptions)
364  {
365  $this->citationSpecificOptions = $citationSpecificOptions;
366  }
367 
371  public function setCssStyle(CssStyle $cssStyle)
372  {
373  $this->cssStyle = $cssStyle;
374  }
375 
379  public function getCssStyle()
380  {
381  return $this->cssStyle;
382  }
383 
384  public function setInfo(Info $info)
385  {
386  $this->info = $info;
387  }
388 
389  public function getInfo()
390  {
391  return $this->info;
392  }
393 
397  public function getMarkupExtension()
398  {
399  return $this->markupExtension;
400  }
401 
405  public function setMarkupExtension($markupExtension)
406  {
407  $this->markupExtension = $markupExtension;
408  }
409 }
Seboettg\CiteProc\Context\setGlobalOptions
setGlobalOptions(GlobalOptions $globalOptions)
Definition: Context.php:366
Seboettg\CiteProc\Context\getCitationSpecificOptions
getCitationSpecificOptions()
Definition: Context.php:406
Seboettg\CiteProc\Context\getMacro
getMacro($key)
Definition: Context.php:191
Seboettg\CiteProc\Style\Macro
Definition: Macro.php:37
Seboettg\CiteProc\Context\getResults
getResults()
Definition: Context.php:334
Seboettg\CiteProc\Context\getCitation
getCitation()
Definition: Context.php:231
Seboettg\CiteProc\Style\Options\GlobalOptions
Definition: GlobalOptions.php:19
Seboettg\CiteProc\Context
Definition: Context.php:32
Seboettg\CiteProc\Context\getRoot
getRoot()
Definition: Context.php:342
Seboettg\CiteProc\Locale\Locale
Definition: Locale.php:33
Seboettg\CiteProc\Root\Info
Definition: Info.php:15
Seboettg\CiteProc\Context\getLocale
getLocale()
Definition: Context.php:207
Seboettg\CiteProc\Context\isModeCitation
isModeCitation()
Definition: Context.php:288
Seboettg\CiteProc
Definition: CiteProc.php:10
Seboettg\CiteProc\Context\setSorting
setSorting($sorting)
Definition: Context.php:257
Seboettg\CiteProc\Context\getBibliography
getBibliography()
Definition: Context.php:215
Seboettg\CiteProc\Style\Bibliography
Definition: Bibliography.php:31
Seboettg\CiteProc\Context\setCitationItems
setCitationItems(&$citationItems)
Definition: Context.php:313
Seboettg\CiteProc\Root\Root
Definition: Root.php:19
Seboettg\CiteProc\Style\Options\BibliographyOptions
Definition: BibliographyOptions.php:19
Seboettg\CiteProc\Context\setMode
setMode($mode)
Definition: Context.php:279
Seboettg\CiteProc\Context\__construct
__construct($locale=null)
Definition: Context.php:170
Seboettg\CiteProc\Context\setRenderingState
setRenderingState(RenderingState $renderingState)
Definition: Context.php:382
Seboettg\CiteProc\Context\getCitationItems
getCitationItems()
Definition: Context.php:305
Seboettg\CiteProc\Style\Citation
Definition: Citation.php:31
Seboettg\CiteProc\Context\getGlobalOptions
getGlobalOptions()
Definition: Context.php:358
Seboettg\CiteProc\Context\setCssStyle
setCssStyle(CssStyle $cssStyle)
Definition: Context.php:422
Seboettg\CiteProc\Context\isModeBibliography
isModeBibliography()
Definition: Context.php:297
Seboettg\CiteProc\RenderingState
Definition: RenderingState.php:27
Seboettg\CiteProc\Context\getRenderingState
getRenderingState()
Definition: Context.php:374
Seboettg\CiteProc\Data\DataList
Definition: DataList.php:22
Seboettg\CiteProc\Context\setBibliographySpecificOptions
setBibliographySpecificOptions(BibliographyOptions $bibliographySpecificOptions)
Definition: Context.php:398
Seboettg\CiteProc\Context\setInfo
setInfo(Info $info)
Definition: Context.php:435
Seboettg\CiteProc\Context\setCitationSpecificOptions
setCitationSpecificOptions(CitationOptions $citationSpecificOptions)
Definition: Context.php:414
Seboettg\CiteProc\Context\hasCitationItems
hasCitationItems()
Definition: Context.php:318
Seboettg\CiteProc\Styles\Css\CssStyle
Definition: CssStyle.php:19
Seboettg\CiteProc\Context\getMacros
getMacros()
Definition: Context.php:326
Seboettg\CiteProc\Context\getCssStyle
getCssStyle()
Definition: Context.php:430
Seboettg\CiteProc\Context\getMarkupExtension
getMarkupExtension()
Definition: Context.php:448
Seboettg\CiteProc\Context\setRoot
setRoot(Root $root)
Definition: Context.php:350
Seboettg\CiteProc\Context\setBibliography
setBibliography(Bibliography $bibliography)
Definition: Context.php:223
Seboettg\CiteProc\Context\$markupExtension
$markupExtension
Definition: Context.php:160
Seboettg\CiteProc\Context\getInfo
getInfo()
Definition: Context.php:440
Seboettg\CiteProc\Context\getSorting
getSorting()
Definition: Context.php:262
Seboettg\CiteProc\Context\setCitation
setCitation($citation)
Definition: Context.php:239
Seboettg\CiteProc\Style\Options\CitationOptions
Definition: CitationOptions.php:19
Seboettg\CiteProc\Context\setCitationsAsArray
setCitationsAsArray($citationsAsArray=true)
Definition: Context.php:247
Seboettg\Collection\ArrayList
Definition: ArrayList.php:20
Seboettg\CiteProc\Context\isCitationsAsArray
isCitationsAsArray()
Definition: Context.php:252
Seboettg\CiteProc\Context\getMode
getMode()
Definition: Context.php:271
Seboettg\CiteProc\Context\getBibliographySpecificOptions
getBibliographySpecificOptions()
Definition: Context.php:390
Seboettg\CiteProc\RenderingState\RENDERING
const RENDERING
Definition: RenderingState.php:29
Seboettg\CiteProc\Context\setMarkupExtension
setMarkupExtension($markupExtension)
Definition: Context.php:456
Seboettg\CiteProc\Context\addMacro
addMacro($key, $macro)
Definition: Context.php:182
Seboettg\CiteProc\Context\setLocale
setLocale(Locale $locale)
Definition: Context.php:199
Seboettg\CiteProc\Style\Sort\Sort
Definition: Sort.php:34