]>
Commit | Line | Data |
---|---|---|
87090d8a | 1 | <?php |
2 | /** | |
3 | * ePub OPF file structure | |
4 | * | |
5 | * @author A. Grandt <php@grandt.com> | |
6 | * @copyright 2009-2014 A. Grandt | |
7 | * @license GNU LGPL, Attribution required for commercial implementations, requested for everything else. | |
8 | * @version 3.20 | |
9 | */ | |
10 | class Opf { | |
11 | const _VERSION = 3.20; | |
12 | ||
13 | /* Core Media types. | |
14 | * These types are the only guaranteed mime types any ePub reader must understand. | |
15 | * Any other type muse define a fall back whose fallback chain will end in one of these. | |
16 | */ | |
17 | const TYPE_GIF = "image/gif"; | |
18 | const TYPE_JPEG = "image/jpeg"; | |
19 | const TYPE_PNG = "image/png"; | |
20 | const TYPE_SVG = "image/svg+xml"; | |
21 | const TYPE_XHTML = "application/xhtml+xml"; | |
22 | const TYPE_DTBOOK = "application/x-dtbook+xml"; | |
23 | const TYPE_CSS = "text/css"; | |
24 | const TYPE_XML = "application/xml"; | |
25 | const TYPE_OEB1_DOC = "text/x-oeb1-document"; // Deprecated | |
26 | const TYPE_OEB1_CSS = "text/x-oeb1-css"; // Deprecated | |
27 | const TYPE_NCX = "application/x-dtbncx+xml"; | |
28 | ||
29 | private $bookVersion = EPub::BOOK_VERSION_EPUB2; | |
30 | private $ident = "BookId"; | |
31 | ||
32 | public $date = NULL; | |
33 | public $metadata = NULL; | |
34 | public $manifest = NULL; | |
35 | public $spine = NULL; | |
36 | public $guide = NULL; | |
37 | ||
38 | /** | |
39 | * Class constructor. | |
40 | * | |
41 | * @return void | |
42 | */ | |
43 | function __construct($ident = "BookId", $bookVersion = EPub::BOOK_VERSION_EPUB2) { | |
44 | $this->setIdent($ident); | |
45 | $this->setVersion($bookVersion); | |
46 | $this->metadata = new Metadata(); | |
47 | $this->manifest = new Manifest(); | |
48 | $this->spine = new Spine(); | |
49 | $this->guide = new Guide(); | |
50 | } | |
51 | ||
52 | /** | |
53 | * Class destructor | |
54 | * | |
55 | * @return void | |
56 | */ | |
57 | function __destruct() { | |
58 | unset ($this->bookVersion, $this->ident, $this->date, $this->metadata, $this->manifest, $this->spine, $this->guide); | |
59 | } | |
60 | ||
61 | /** | |
62 | * | |
63 | * Enter description here ... | |
64 | * | |
65 | * @param string $ident | |
66 | */ | |
67 | function setVersion($bookVersion) { | |
68 | $this->bookVersion = is_string($bookVersion) ? trim($bookVersion) : EPub::BOOK_VERSION_EPUB2; | |
69 | } | |
70 | ||
71 | function isEPubVersion2() { | |
72 | return $this->bookVersion === EPub::BOOK_VERSION_EPUB2; | |
73 | } | |
74 | ||
75 | /** | |
76 | * | |
77 | * Enter description here ... | |
78 | * | |
79 | * @param string $ident | |
80 | */ | |
81 | function setIdent($ident = "BookId") { | |
82 | $this->ident = is_string($ident) ? trim($ident) : "BookId"; | |
83 | } | |
84 | ||
85 | /** | |
86 | * | |
87 | * Enter description here ... | |
88 | * | |
89 | * @return string | |
90 | */ | |
91 | function finalize() { | |
92 | $opf = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n" | |
93 | . "<package xmlns=\"http://www.idpf.org/2007/opf\" unique-identifier=\"" . $this->ident . "\" version=\"" . $this->bookVersion . "\">\n"; | |
94 | ||
95 | $opf .= $this->metadata->finalize($this->bookVersion, $this->date); | |
96 | $opf .= $this->manifest->finalize($this->bookVersion); | |
97 | $opf .= $this->spine->finalize(); | |
98 | ||
99 | if ($this->guide->length() > 0) { | |
100 | $opf .= $this->guide->finalize(); | |
101 | } | |
102 | ||
103 | return $opf . "</package>\n"; | |
104 | } | |
105 | ||
106 | // Convenience functions: | |
107 | ||
108 | /** | |
109 | * | |
110 | * Enter description here ... | |
111 | * | |
112 | * @param string $title | |
113 | * @param string $language | |
114 | * @param string $identifier | |
115 | * @param string $identifierScheme | |
116 | */ | |
117 | function initialize($title, $language, $identifier, $identifierScheme) { | |
118 | $this->metadata->addDublinCore(new DublinCore("title", $title)); | |
119 | $this->metadata->addDublinCore(new DublinCore("language", $language)); | |
120 | ||
121 | $dc = new DublinCore("identifier", $identifier); | |
122 | $dc->addAttr("id", $this->ident); | |
123 | $dc->addOpfAttr("scheme", $identifierScheme); | |
124 | $this->metadata->addDublinCore($dc); | |
125 | } | |
126 | ||
127 | /** | |
128 | * | |
129 | * Enter description here ... | |
130 | * | |
131 | * @param string $id | |
132 | * @param string $href | |
133 | * @param string $mediaType | |
134 | */ | |
135 | function addItem($id, $href, $mediaType, $properties = NULL) { | |
136 | $this->manifest->addItem(new Item($id, $href, $mediaType, $properties)); | |
137 | } | |
138 | ||
139 | /** | |
140 | * | |
141 | * Enter description here ... | |
142 | * | |
143 | * @param string $idref | |
144 | * @param bool $linear | |
145 | */ | |
146 | function addItemRef($idref, $linear = TRUE) { | |
147 | $this->spine->addItemref(new Itemref($idref, $linear)); | |
148 | } | |
149 | ||
150 | /** | |
151 | * | |
152 | * Enter description here ... | |
153 | * | |
154 | * @param string $type | |
155 | * @param string $title | |
156 | * @param string $href | |
157 | */ | |
158 | function addReference($type, $title, $href) { | |
159 | $this->guide->addReference(new Reference($type, $title, $href)); | |
160 | } | |
161 | ||
162 | /** | |
163 | * | |
164 | * Enter description here ... | |
165 | * | |
166 | * @param string $name | |
167 | * @param string $value | |
168 | */ | |
169 | function addDCMeta($name, $value) { | |
170 | $this->metadata->addDublinCore(new DublinCore($name, $value)); | |
171 | } | |
172 | ||
173 | /** | |
174 | * | |
175 | * Enter description here ... | |
176 | * | |
177 | * @param string $name | |
178 | * @param string $content | |
179 | */ | |
180 | function addMeta($name, $content) { | |
181 | $this->metadata->addMeta($name, $content); | |
182 | } | |
183 | ||
184 | /** | |
185 | * | |
186 | * Enter description here ... | |
187 | * | |
188 | * @param string $name | |
189 | * @param string $fileAs | |
190 | * @param string $role Use the MarcCode constants | |
191 | */ | |
192 | function addCreator($name, $fileAs = NULL, $role = NULL) { | |
193 | $dc = new DublinCore(DublinCore::CREATOR, trim($name)); | |
194 | ||
195 | if ($fileAs !== NULL) { | |
196 | $dc->addOpfAttr("file-as", trim($fileAs)); | |
197 | } | |
198 | ||
199 | if ($role !== NULL) { | |
200 | $dc->addOpfAttr("role", trim($role)); | |
201 | } | |
202 | ||
203 | $this->metadata->addDublinCore($dc); | |
204 | } | |
205 | ||
206 | /** | |
207 | * | |
208 | * Enter description here ... | |
209 | * | |
210 | * @param string $name | |
211 | * @param string $fileAs | |
212 | * @param string $role Use the MarcCode constants | |
213 | */ | |
214 | function addColaborator($name, $fileAs = NULL, $role = NULL) { | |
215 | $dc = new DublinCore(DublinCore::CONTRIBUTOR, trim($name)); | |
216 | ||
217 | if ($fileAs !== NULL) { | |
218 | $dc->addOpfAttr("file-as", trim($fileAs)); | |
219 | } | |
220 | ||
221 | if ($role !== NULL) { | |
222 | $dc->addOpfAttr("role", trim($role)); | |
223 | } | |
224 | ||
225 | $this->metadata->addDublinCore($dc); | |
226 | } | |
227 | } | |
228 | ||
229 | /** | |
230 | * ePub OPF Metadata structures | |
231 | */ | |
232 | class Metadata { | |
233 | const _VERSION = 3.00; | |
234 | ||
235 | private $dc = array(); | |
236 | private $meta = array(); | |
237 | ||
238 | /** | |
239 | * Class constructor. | |
240 | * | |
241 | * @return void | |
242 | */ | |
243 | function __construct() { | |
244 | } | |
245 | ||
246 | /** | |
247 | * Class destructor | |
248 | * | |
249 | * @return void | |
250 | */ | |
251 | function __destruct() { | |
252 | unset ($this->dc, $this->meta); | |
253 | } | |
254 | ||
255 | /** | |
256 | * | |
257 | * Enter description here ... | |
258 | * | |
259 | * @param DublinCore $dc | |
260 | */ | |
261 | function addDublinCore($dc) { | |
262 | if ($dc != NULL && is_object($dc) && get_class($dc) === "DublinCore") { | |
263 | $this->dc[] = $dc; | |
264 | } | |
265 | } | |
266 | ||
267 | /** | |
268 | * | |
269 | * Enter description here ... | |
270 | * | |
271 | * @param string $name | |
272 | * @param string $content | |
273 | */ | |
274 | function addMeta($name, $content) { | |
275 | $name = is_string($name) ? trim($name) : NULL; | |
276 | if (isset($name)) { | |
277 | $content = is_string($content) ? trim($content) : NULL; | |
278 | } | |
279 | if (isset($content)) { | |
280 | $this->meta[] = array ($name => $content); | |
281 | } | |
282 | } | |
283 | ||
284 | /** | |
285 | * | |
286 | * @param string $bookVersion | |
287 | * @param int $date | |
288 | * @return string | |
289 | */ | |
290 | function finalize($bookVersion = EPub::BOOK_VERSION_EPUB2, $date = NULL) { | |
291 | $metadata = "\t<metadata xmlns:dc=\"http://purl.org/dc/elements/1.1/\"\n"; | |
292 | if ($bookVersion === EPub::BOOK_VERSION_EPUB2) { | |
293 | $metadata .= "\t\txmlns:opf=\"http://www.idpf.org/2007/opf\"\n\t\txmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n"; | |
294 | } else { | |
295 | $metadata .= "\t\txmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n"; | |
296 | if (!isset($date)) { | |
297 | $date = time(); | |
298 | } | |
299 | $metadata .= "\t\t<meta property=\"dcterms:modified\">" . gmdate("Y-m-d\TH:i:s\Z", $date) . "</meta>\n"; | |
300 | } | |
301 | ||
302 | foreach ($this->dc as $dc) { | |
303 | $metadata .= $dc->finalize($bookVersion); | |
304 | } | |
305 | ||
306 | foreach ($this->meta as $data) { | |
307 | list($name, $content) = each($data); | |
308 | $metadata .= "\t\t<meta name=\"" . $name . "\" content=\"" . $content . "\" />\n"; | |
309 | } | |
310 | ||
311 | return $metadata . "\t</metadata>\n"; | |
312 | } | |
313 | } | |
314 | ||
315 | /** | |
316 | * ePub OPF Dublin Core (dc:) Metadata structures | |
317 | */ | |
318 | class DublinCore { | |
319 | const _VERSION = 3.00; | |
320 | ||
321 | const CONTRIBUTOR = "contributor"; | |
322 | const COVERAGE = "coverage"; | |
323 | const CREATOR = "creator"; | |
324 | const DATE = "date"; | |
325 | const DESCRIPTION = "description"; | |
326 | const FORMAT = "format"; | |
327 | const IDENTIFIER = "identifier"; | |
328 | const LANGUAGE = "language"; | |
329 | const PUBLISHER = "publisher"; | |
330 | const RELATION = "relation"; | |
331 | const RIGHTS = "rights"; | |
332 | const SOURCE = "source"; | |
333 | const SUBJECT = "subject"; | |
334 | const TITLE = "title"; | |
335 | const TYPE = "type"; | |
336 | ||
337 | private $dcName = NULL; | |
338 | private $dcValue = NULL; | |
339 | private $attr = array(); | |
340 | private $opfAttr = array(); | |
341 | ||
342 | /** | |
343 | * Class constructor. | |
344 | * | |
345 | * @return void | |
346 | */ | |
347 | function __construct($name, $value) { | |
348 | $this->setDc($name, $value); | |
349 | } | |
350 | ||
351 | /** | |
352 | * Class destructor | |
353 | * | |
354 | * @return void | |
355 | */ | |
356 | function __destruct() { | |
357 | unset ($this->dcName, $this->dcValue, $this->attr, $this->opfAttr); | |
358 | } | |
359 | ||
360 | /** | |
361 | * | |
362 | * Enter description here ... | |
363 | * | |
364 | * @param string $name | |
365 | * @param string $value | |
366 | */ | |
367 | function setDc($name, $value) { | |
368 | $this->dcName = is_string($name) ? trim($name) : NULL; | |
369 | if (isset($this->dcName)) { | |
370 | $this->dcValue = isset($value) ? (string)$value : NULL; | |
371 | } | |
372 | if (! isset($this->dcValue)) { | |
373 | $this->dcName = NULL; | |
374 | } | |
375 | } | |
376 | ||
377 | /** | |
378 | * | |
379 | * Enter description here ... | |
380 | * | |
381 | * @param string $attrName | |
382 | * @param string $attrValue | |
383 | */ | |
384 | function addAttr($attrName, $attrValue) { | |
385 | $attrName = is_string($attrName) ? trim($attrName) : NULL; | |
386 | if (isset($attrName)) { | |
387 | $attrValue = is_string($attrValue) ? trim($attrValue) : NULL; | |
388 | } | |
389 | if (isset($attrValue)) { | |
390 | $this->attr[$attrName] = $attrValue; | |
391 | } | |
392 | } | |
393 | ||
394 | /** | |
395 | * | |
396 | * Enter description here ... | |
397 | * | |
398 | * @param string $opfAttrName | |
399 | * @param string $opfAttrValue | |
400 | */ | |
401 | function addOpfAttr($opfAttrName, $opfAttrValue) { | |
402 | $opfAttrName = is_string($opfAttrName) ? trim($opfAttrName) : NULL; | |
403 | if (isset($opfAttrName)) { | |
404 | $opfAttrValue = is_string($opfAttrValue) ? trim($opfAttrValue) : NULL; | |
405 | } | |
406 | if (isset($opfAttrValue)) { | |
407 | $this->opfAttr[$opfAttrName] = $opfAttrValue; | |
408 | } | |
409 | } | |
410 | ||
411 | ||
412 | /** | |
413 | * | |
414 | * @param string $bookVersion | |
415 | * @return string | |
416 | */ | |
417 | function finalize($bookVersion = EPub::BOOK_VERSION_EPUB2) { | |
418 | $dc = "\t\t<dc:" . $this->dcName; | |
419 | ||
420 | if (sizeof($this->attr) > 0) { | |
421 | while (list($name, $content) = each($this->attr)) { | |
422 | $dc .= " " . $name . "=\"" . $content . "\""; | |
423 | } | |
424 | } | |
425 | ||
426 | if ($bookVersion === EPub::BOOK_VERSION_EPUB2 && sizeof($this->opfAttr) > 0) { | |
427 | while (list($name, $content) = each($this->opfAttr)) { | |
428 | $dc .= " opf:" . $name . "=\"" . $content . "\""; | |
429 | } | |
430 | } | |
431 | ||
432 | return $dc . ">" . $this->dcValue . "</dc:" . $this->dcName . ">\n"; | |
433 | } | |
434 | } | |
435 | ||
436 | /** | |
437 | * ePub OPF Manifest structure | |
438 | */ | |
439 | class Manifest { | |
440 | const _VERSION = 3.00; | |
441 | ||
442 | private $items = array(); | |
443 | ||
444 | /** | |
445 | * Class constructor. | |
446 | * | |
447 | * @return void | |
448 | */ | |
449 | function __construct() { | |
450 | } | |
451 | ||
452 | /** | |
453 | * Class destructor | |
454 | * | |
455 | * @return void | |
456 | */ | |
457 | function __destruct() { | |
458 | unset ($this->items); | |
459 | } | |
460 | ||
461 | /** | |
462 | * | |
463 | * Enter description here ... | |
464 | * | |
465 | * @param Item $item | |
466 | */ | |
467 | function addItem($item) { | |
468 | if ($item != NULL && is_object($item) && get_class($item) === "Item") { | |
469 | $this->items[] = $item; | |
470 | } | |
471 | } | |
472 | ||
473 | /** | |
474 | * | |
475 | * @param string $bookVersion | |
476 | * @return string | |
477 | */ | |
478 | function finalize($bookVersion = EPub::BOOK_VERSION_EPUB2) { | |
479 | $manifest = "\n\t<manifest>\n"; | |
480 | foreach ($this->items as $item) { | |
481 | $manifest .= $item->finalize($bookVersion); | |
482 | } | |
483 | return $manifest . "\t</manifest>\n"; | |
484 | } | |
485 | } | |
486 | ||
487 | /** | |
488 | * ePub OPF Item structure | |
489 | */ | |
490 | class Item { | |
491 | const _VERSION = 3.00; | |
492 | ||
493 | private $id = NULL; | |
494 | private $href = NULL; | |
495 | private $mediaType = NULL; | |
496 | private $properties = NULL; | |
497 | private $requiredNamespace = NULL; | |
498 | private $requiredModules = NULL; | |
499 | private $fallback = NULL; | |
500 | private $fallbackStyle = NULL; | |
501 | ||
502 | /** | |
503 | * Class constructor. | |
504 | * | |
505 | * @return void | |
506 | */ | |
507 | function __construct($id, $href, $mediaType, $properties = NULL) { | |
508 | $this->setId($id); | |
509 | $this->setHref($href); | |
510 | $this->setMediaType($mediaType); | |
511 | $this->setProperties($properties); | |
512 | } | |
513 | ||
514 | /** | |
515 | * Class destructor | |
516 | * | |
517 | * @return void | |
518 | */ | |
519 | function __destruct() { | |
520 | unset ($this->id, $this->href, $this->mediaType); | |
521 | unset ($this->properties, $this->requiredNamespace, $this->requiredModules, $this->fallback, $this->fallbackStyle); | |
522 | } | |
523 | ||
524 | /** | |
525 | * | |
526 | * Enter description here ... | |
527 | * | |
528 | * @param string $id | |
529 | */ | |
530 | function setId($id) { | |
531 | $this->id = is_string($id) ? trim($id) : NULL; | |
532 | } | |
533 | ||
534 | /** | |
535 | * | |
536 | * Enter description here ... | |
537 | * | |
538 | * @param string $href | |
539 | */ | |
540 | function setHref($href) { | |
541 | $this->href = is_string($href) ? trim($href) : NULL; | |
542 | } | |
543 | ||
544 | /** | |
545 | * | |
546 | * Enter description here ... | |
547 | * | |
548 | * @param string $mediaType | |
549 | */ | |
550 | function setMediaType($mediaType) { | |
551 | $this->mediaType = is_string($mediaType) ? trim($mediaType) : NULL; | |
552 | } | |
553 | ||
554 | /** | |
555 | * | |
556 | * Enter description here ... | |
557 | * | |
558 | * @param string $properties | |
559 | */ | |
560 | function setProperties($properties) { | |
561 | $this->properties = is_string($properties) ? trim($properties) : NULL; | |
562 | } | |
563 | ||
564 | /** | |
565 | * | |
566 | * Enter description here ... | |
567 | * | |
568 | * @param string $requiredNamespace | |
569 | */ | |
570 | function setRequiredNamespace($requiredNamespace) { | |
571 | $this->requiredNamespace = is_string($requiredNamespace) ? trim($requiredNamespace) : NULL; | |
572 | } | |
573 | ||
574 | /** | |
575 | * | |
576 | * Enter description here ... | |
577 | * | |
578 | * @param string $requiredModules | |
579 | */ | |
580 | function setRequiredModules($requiredModules) { | |
581 | $this->requiredModules = is_string($requiredModules) ? trim($requiredModules) : NULL; | |
582 | } | |
583 | ||
584 | /** | |
585 | * | |
586 | * Enter description here ... | |
587 | * | |
588 | * @param string $fallback | |
589 | */ | |
590 | function setfallback($fallback) { | |
591 | $this->fallback = is_string($fallback) ? trim($fallback) : NULL; | |
592 | } | |
593 | ||
594 | /** | |
595 | * | |
596 | * Enter description here ... | |
597 | * | |
598 | * @param string $fallbackStyle | |
599 | */ | |
600 | function setFallbackStyle($fallbackStyle) { | |
601 | $this->fallbackStyle = is_string($fallbackStyle) ? trim($fallbackStyle) : NULL; | |
602 | } | |
603 | ||
604 | /** | |
605 | * | |
606 | * @param string $bookVersion | |
607 | * @return string | |
608 | */ | |
609 | function finalize($bookVersion = EPub::BOOK_VERSION_EPUB2) { | |
610 | $item = "\t\t<item id=\"" . $this->id . "\" href=\"" . $this->href . "\" media-type=\"" . $this->mediaType . "\" "; | |
611 | if ($bookVersion === EPub::BOOK_VERSION_EPUB3 && isset($this->properties)) { | |
612 | $item .= "properties=\"" . $this->properties . "\" "; | |
613 | } | |
614 | if (isset($this->requiredNamespace)) { | |
615 | $item .= "\n\t\t\trequired-namespace=\"" . $this->requiredNamespace . "\" "; | |
616 | if (isset($this->requiredModules)) { | |
617 | $item .= "required-modules=\"" . $this->requiredModules . "\" "; | |
618 | } | |
619 | } | |
620 | if (isset($this->fallback)) { | |
621 | $item .= "\n\t\t\tfallback=\"" . $this->fallback . "\" "; | |
622 | } | |
623 | if (isset($this->fallbackStyle)) { | |
624 | $item .= "\n\t\t\tfallback-style=\"" . $this->fallbackStyle . "\" "; | |
625 | } | |
626 | return $item . "/>\n"; | |
627 | } | |
628 | } | |
629 | ||
630 | /** | |
631 | * ePub OPF Spine structure | |
632 | */ | |
633 | class Spine { | |
634 | const _VERSION = 1.00; | |
635 | ||
636 | private $itemrefs = array(); | |
637 | private $toc = NULL; | |
638 | ||
639 | /** | |
640 | * Class constructor. | |
641 | * | |
642 | * @return void | |
643 | */ | |
644 | function __construct($toc = "ncx") { | |
645 | $this->setToc($toc); | |
646 | } | |
647 | ||
648 | /** | |
649 | * Class destructor | |
650 | * | |
651 | * @return void | |
652 | */ | |
653 | function __destruct() { | |
654 | unset ($this->itemrefs, $this->toc); | |
655 | } | |
656 | ||
657 | /** | |
658 | * | |
659 | * Enter description here ... | |
660 | * | |
661 | * @param string $toc | |
662 | */ | |
663 | function setToc($toc) { | |
664 | $this->toc = is_string($toc) ? trim($toc) : NULL; | |
665 | } | |
666 | ||
667 | /** | |
668 | * | |
669 | * Enter description here ... | |
670 | * | |
671 | * @param Itemref $itemref | |
672 | */ | |
673 | function addItemref($itemref) { | |
674 | if ($itemref != NULL | |
675 | && is_object($itemref) | |
676 | && get_class($itemref) === "Itemref" | |
677 | && !isset($this->itemrefs[$itemref->getIdref()])) { | |
678 | $this->itemrefs[$itemref->getIdref()] = $itemref; | |
679 | } | |
680 | } | |
681 | ||
682 | /** | |
683 | * | |
684 | * Enter description here ... | |
685 | * | |
686 | * @return string | |
687 | */ | |
688 | function finalize() { | |
689 | $spine = "\n\t<spine toc=\"" . $this->toc . "\">\n"; | |
690 | foreach ($this->itemrefs as $itemref) { | |
691 | $spine .= $itemref->finalize(); | |
692 | } | |
693 | return $spine . "\t</spine>\n"; | |
694 | } | |
695 | } | |
696 | ||
697 | /** | |
698 | * ePub OPF ItemRef structure | |
699 | */ | |
700 | class Itemref { | |
701 | const _VERSION = 3.00; | |
702 | ||
703 | private $idref = NULL; | |
704 | private $linear = TRUE; | |
705 | ||
706 | /** | |
707 | * Class constructor. | |
708 | * | |
709 | * @return void | |
710 | */ | |
711 | function __construct($idref, $linear = TRUE) { | |
712 | $this->setIdref($idref); | |
713 | $this->setLinear($linear); | |
714 | } | |
715 | ||
716 | /** | |
717 | * Class destructor | |
718 | * | |
719 | * @return void | |
720 | */ | |
721 | function __destruct() { | |
722 | unset ($this->idref, $this->linear); | |
723 | } | |
724 | ||
725 | /** | |
726 | * | |
727 | * Enter description here ... | |
728 | * | |
729 | * @param string $idref | |
730 | */ | |
731 | function setIdref($idref) { | |
732 | $this->idref = is_string($idref) ? trim($idref) : NULL; | |
733 | } | |
734 | ||
735 | /** | |
736 | * | |
737 | * Enter description here ... | |
738 | * | |
739 | * @return string $idref | |
740 | */ | |
741 | function getIdref() { | |
742 | return $this->idref; | |
743 | } | |
744 | ||
745 | /** | |
746 | * | |
747 | * Enter description here ... | |
748 | * | |
749 | * @param bool $linear | |
750 | */ | |
751 | function setLinear($linear = TRUE) { | |
752 | $this->linear = $linear === TRUE; | |
753 | } | |
754 | ||
755 | /** | |
756 | * | |
757 | * Enter description here ... | |
758 | * | |
759 | * @return string | |
760 | */ | |
761 | function finalize() { | |
762 | $itemref = "\t\t<itemref idref=\"" . $this->idref . "\""; | |
763 | if ($this->linear == FALSE) { | |
764 | return $itemref .= " linear=\"no\" />\n"; | |
765 | } | |
766 | return $itemref . " />\n"; | |
767 | } | |
768 | } | |
769 | ||
770 | /** | |
771 | * ePub OPF Guide structure | |
772 | */ | |
773 | class Guide { | |
774 | const _VERSION = 3.00; | |
775 | ||
776 | private $references = array(); | |
777 | ||
778 | /** | |
779 | * Class constructor. | |
780 | * | |
781 | * @return void | |
782 | */ | |
783 | function __construct() { | |
784 | } | |
785 | ||
786 | /** | |
787 | * Class destructor | |
788 | * | |
789 | * @return void | |
790 | */ | |
791 | function __destruct() { | |
792 | unset ($this->references); | |
793 | } | |
794 | ||
795 | /** | |
796 | * | |
797 | * Enter description here ... | |
798 | * | |
799 | */ | |
800 | function length() { | |
801 | return sizeof($this->references); | |
802 | } | |
803 | ||
804 | /** | |
805 | * | |
806 | * Enter description here ... | |
807 | * | |
808 | * @param Reference $reference | |
809 | */ | |
810 | function addReference($reference) { | |
811 | if ($reference != NULL && is_object($reference) && get_class($reference) === "Reference") { | |
812 | $this->references[] = $reference; | |
813 | } | |
814 | } | |
815 | ||
816 | /** | |
817 | * | |
818 | * Enter description here ... | |
819 | * | |
820 | * @return string | |
821 | */ | |
822 | function finalize() { | |
823 | $ref = ""; | |
824 | if (sizeof($this->references) > 0) { | |
825 | $ref = "\n\t<guide>\n"; | |
826 | foreach ($this->references as $reference) { | |
827 | $ref .= $reference->finalize(); | |
828 | } | |
829 | $ref .= "\t</guide>\n"; | |
830 | } | |
831 | return $ref; | |
832 | } | |
833 | } | |
834 | ||
835 | /** | |
836 | * Reference constants | |
837 | */ | |
838 | class Reference { | |
839 | const _VERSION = 1.00; | |
840 | ||
841 | /* REFERENCE types are derived from the "Chicago Manual of Style" | |
842 | */ | |
843 | ||
844 | /** Acknowledgements page */ | |
845 | const ACKNOWLEDGEMENTS = "acknowledgements"; | |
846 | ||
847 | /** Bibliography page */ | |
848 | const BIBLIOGRAPHY = "bibliography"; | |
849 | ||
850 | /** Colophon page */ | |
851 | const COLOPHON = "colophon"; | |
852 | ||
853 | /** Copyright page */ | |
854 | const COPYRIGHT_PAGE = "copyright-page"; | |
855 | ||
856 | /** Dedication */ | |
857 | const DEDICATION = "dedication"; | |
858 | ||
859 | /** Epigraph */ | |
860 | const EPIGRAPH = "epigraph"; | |
861 | ||
862 | /** Foreword */ | |
863 | const FOREWORD = "foreword"; | |
864 | ||
865 | /** Glossary page */ | |
866 | const GLOSSARY = "glossary"; | |
867 | ||
868 | /** back-of-book style index */ | |
869 | const INDEX = "index"; | |
870 | ||
871 | /** List of illustrations */ | |
872 | const LIST_OF_ILLUSTRATIONS = "loi"; | |
873 | ||
874 | /** List of tables */ | |
875 | const LIST_OF_TABLES = "lot"; | |
876 | ||
877 | /** Notes page */ | |
878 | const NOTES = "notes"; | |
879 | ||
880 | /** Preface page */ | |
881 | const PREFACE = "preface"; | |
882 | ||
883 | /** Table of contents */ | |
884 | const TABLE_OF_CONTENTS = "toc"; | |
885 | ||
886 | /** Page with possibly title, author, publisher, and other metadata */ | |
887 | const TITLE_PAGE = "titlepage"; | |
888 | ||
889 | /** First page of the book, ie. first page of the first chapter */ | |
890 | const TEXT = "text"; | |
891 | ||
892 | // ****************** | |
893 | // ePub3 constants | |
894 | // ****************** | |
895 | ||
896 | // Document partitions | |
897 | /** The publications cover(s), jacket information, etc. This is officially in ePub3, but works for ePub 2 as well */ | |
898 | const COVER = "cover"; | |
899 | ||
900 | /** Preliminary material to the content body, such as tables of contents, dedications, etc. */ | |
901 | const FRONTMATTER = "frontmatter"; | |
902 | ||
903 | /** The main (body) content of a document. */ | |
904 | const BODYMATTER = "bodymatter"; | |
905 | ||
906 | /** Ancillary material occurring after the document body, such as indices, appendices, etc. */ | |
907 | const BACKMATTER = "backmatter"; | |
908 | ||
909 | ||
910 | private $type = NULL; | |
911 | private $title = NULL; | |
912 | private $href = NULL; | |
913 | ||
914 | /** | |
915 | * Class constructor. | |
916 | * | |
917 | * @param string $type | |
918 | * @param string $title | |
919 | * @param string $href | |
920 | */ | |
921 | function __construct($type, $title, $href) { | |
922 | $this->setType($type); | |
923 | $this->setTitle($title); | |
924 | $this->setHref($href); | |
925 | } | |
926 | ||
927 | /** | |
928 | * Class destructor | |
929 | * | |
930 | * @return void | |
931 | */ | |
932 | function __destruct() { | |
933 | unset ($this->type, $this->title, $this->href); | |
934 | } | |
935 | ||
936 | /** | |
937 | * | |
938 | * Enter description here ... | |
939 | * | |
940 | * @param string $type | |
941 | */ | |
942 | function setType($type) { | |
943 | $this->type = is_string($type) ? trim($type) : NULL; | |
944 | } | |
945 | ||
946 | /** | |
947 | * | |
948 | * Enter description here ... | |
949 | * | |
950 | * @param string $title | |
951 | */ | |
952 | function setTitle($title) { | |
953 | $this->title = is_string($title) ? trim($title) : NULL; | |
954 | } | |
955 | ||
956 | /** | |
957 | * | |
958 | * Enter description here ... | |
959 | * | |
960 | * @param string $href | |
961 | */ | |
962 | function setHref($href) { | |
963 | $this->href = is_string($href) ? trim($href) : NULL; | |
964 | } | |
965 | ||
966 | /** | |
967 | * | |
968 | * Enter description here ... | |
969 | * | |
970 | * @return string | |
971 | */ | |
972 | function finalize() { | |
973 | return "\t\t<reference type=\"" . $this->type . "\" title=\"" . $this->title . "\" href=\"" . $this->href . "\" />\n"; | |
974 | } | |
975 | } | |
976 | ||
977 | /** | |
978 | * Common Marc codes. | |
979 | * Ref: http://www.loc.gov/marc/relators/ | |
980 | */ | |
981 | class MarcCode { | |
982 | const _VERSION = 3.00; | |
983 | ||
984 | /** | |
985 | * Adapter | |
986 | * | |
987 | * Use for a person who | |
988 | * 1) reworks a musical composition, usually for a different medium, or | |
989 | * 2) rewrites novels or stories for motion pictures or other audiovisual medium. | |
990 | */ | |
991 | const ADAPTER = "adp"; | |
992 | ||
993 | /** | |
994 | * Annotator | |
995 | * | |
996 | * Use for a person who writes manuscript annotations on a printed item. | |
997 | */ | |
998 | const ANNOTATOR = "ann"; | |
999 | ||
1000 | /** | |
1001 | * Arranger | |
1002 | * | |
1003 | * Use for a person who transcribes a musical composition, usually for a different | |
1004 | * medium from that of the original; in an arrangement the musical substance remains | |
1005 | * essentially unchanged. | |
1006 | */ | |
1007 | const ARRANGER = "arr"; | |
1008 | ||
1009 | /** | |
1010 | * Artist | |
1011 | * | |
1012 | * Use for a person (e.g., a painter) who conceives, and perhaps also implements, | |
1013 | * an original graphic design or work of art, if specific codes (e.g., [egr], | |
1014 | * [etr]) are not desired. For book illustrators, prefer Illustrator [ill]. | |
1015 | */ | |
1016 | const ARTIST = "art"; | |
1017 | ||
1018 | /** | |
1019 | * Associated name | |
1020 | * | |
1021 | * Use as a general relator for a name associated with or found in an item or | |
1022 | * collection, or which cannot be determined to be that of a Former owner [fmo] | |
1023 | * or other designated relator indicative of provenance. | |
1024 | */ | |
1025 | const ASSOCIATED_NAME = "asn"; | |
1026 | ||
1027 | /** | |
1028 | * Author | |
1029 | * | |
1030 | * Use for a person or corporate body chiefly responsible for the intellectual | |
1031 | * or artistic content of a work. This term may also be used when more than one | |
1032 | * person or body bears such responsibility. | |
1033 | */ | |
1034 | const AUTHOR = "aut"; | |
1035 | ||
1036 | /** | |
1037 | * Author in quotations or text extracts | |
1038 | * | |
1039 | * Use for a person whose work is largely quoted or extracted in a works to which | |
1040 | * he or she did not contribute directly. Such quotations are found particularly | |
1041 | * in exhibition catalogs, collections of photographs, etc. | |
1042 | */ | |
1043 | const AUTHOR_IN_QUOTES = "aqt"; | |
1044 | ||
1045 | /** | |
1046 | * Author of afterword, colophon, etc. | |
1047 | * | |
1048 | * Use for a person or corporate body responsible for an afterword, postface, | |
1049 | * colophon, etc. but who is not the chief author of a work. | |
1050 | */ | |
1051 | const AUTHOR_OF_AFTERWORD = "aft"; | |
1052 | ||
1053 | /** | |
1054 | * Author of introduction, etc. | |
1055 | * | |
1056 | * Use for a person or corporate body responsible for an introduction, preface, | |
1057 | * foreword, or other critical matter, but who is not the chief author. | |
1058 | */ | |
1059 | const AUTHOR_OF_INTRO = "aui"; | |
1060 | ||
1061 | /** | |
1062 | * Bibliographic antecedent | |
1063 | * | |
1064 | * Use for the author responsible for a work upon which the work represented by | |
1065 | * the catalog record is based. This can be appropriate for adaptations, sequels, | |
1066 | * continuations, indexes, etc. | |
1067 | */ | |
1068 | const BIB_ANTECEDENT = "ant"; | |
1069 | ||
1070 | /** | |
1071 | * Book producer | |
1072 | * | |
1073 | * Use for the person or firm responsible for the production of books and other | |
1074 | * print media, if specific codes (e.g., [bkd], [egr], [tyd], [prt]) are not desired. | |
1075 | */ | |
1076 | const BOOK_PRODUCER = "bkp"; | |
1077 | ||
1078 | /** | |
1079 | * Collaborator | |
1080 | * | |
1081 | * Use for a person or corporate body that takes a limited part in the elaboration | |
1082 | * of a work of another author or that brings complements (e.g., appendices, notes) | |
1083 | * to the work of another author. | |
1084 | */ | |
1085 | const COLABORATOR = "clb"; | |
1086 | ||
1087 | /** | |
1088 | * Commentator | |
1089 | * | |
1090 | * Use for a person who provides interpretation, analysis, or a discussion of the | |
1091 | * subject matter on a recording, motion picture, or other audiovisual medium. | |
1092 | * Compiler [com] Use for a person who produces a work or publication by selecting | |
1093 | * and putting together material from the works of various persons or bodies. | |
1094 | */ | |
1095 | const COMMENTATOR = "cmm"; | |
1096 | ||
1097 | /** | |
1098 | * Designer | |
1099 | * | |
1100 | * Use for a person or organization responsible for design if specific codes (e.g., | |
1101 | * [bkd], [tyd]) are not desired. | |
1102 | */ | |
1103 | const DESIGNER = "dsr"; | |
1104 | ||
1105 | /** | |
1106 | * Editor | |
1107 | * | |
1108 | * Use for a person who prepares for publication a work not primarily his/her own, | |
1109 | * such as by elucidating text, adding introductory or other critical matter, or | |
1110 | * technically directing an editorial staff. | |
1111 | */ | |
1112 | const EDITORT = "edt"; | |
1113 | ||
1114 | /** | |
1115 | * Illustrator | |
1116 | * | |
1117 | * Use for the person who conceives, and perhaps also implements, a design or | |
1118 | * illustration, usually to accompany a written text. | |
1119 | */ | |
1120 | const ILLUSTRATOR = "ill"; | |
1121 | ||
1122 | /** | |
1123 | * Lyricist | |
1124 | * | |
1125 | * Use for the writer of the text of a song. | |
1126 | */ | |
1127 | const LYRICIST = "lyr"; | |
1128 | ||
1129 | /** | |
1130 | * Metadata contact | |
1131 | * | |
1132 | * Use for the person or organization primarily responsible for compiling and | |
1133 | * maintaining the original description of a metadata set (e.g., geospatial | |
1134 | * metadata set). | |
1135 | */ | |
1136 | const METADATA_CONTACT = "mdc"; | |
1137 | ||
1138 | /** | |
1139 | * Musician | |
1140 | * | |
1141 | * Use for the person who performs music or contributes to the musical content | |
1142 | * of a work when it is not possible or desirable to identify the function more | |
1143 | * precisely. | |
1144 | */ | |
1145 | const MUSICIAN = "mus"; | |
1146 | ||
1147 | /** | |
1148 | * Narrator | |
1149 | * | |
1150 | * Use for the speaker who relates the particulars of an act, occurrence, or | |
1151 | * course of events. | |
1152 | */ | |
1153 | const NARRATOR = "nrt"; | |
1154 | ||
1155 | /** | |
1156 | * Other | |
1157 | * | |
1158 | * Use for relator codes from other lists which have no equivalent in the MARC | |
1159 | * list or for terms which have not been assigned a code. | |
1160 | */ | |
1161 | const OTHER = "oth"; | |
1162 | ||
1163 | /** | |
1164 | * Photographer | |
1165 | * | |
1166 | * Use for the person or organization responsible for taking photographs, whether | |
1167 | * they are used in their original form or as reproductions. | |
1168 | */ | |
1169 | const PHOTOGRAPHER = "pht"; | |
1170 | ||
1171 | /** | |
1172 | * Printer | |
1173 | * | |
1174 | * Use for the person or organization who prints texts, whether from type or plates. | |
1175 | */ | |
1176 | const PRINTER = "prt"; | |
1177 | ||
1178 | /** | |
1179 | * Redactor | |
1180 | * | |
1181 | * Use for a person who writes or develops the framework for an item without | |
1182 | * being intellectually responsible for its content. | |
1183 | */ | |
1184 | const REDACTOR = "red"; | |
1185 | ||
1186 | /** | |
1187 | * Reviewer | |
1188 | * | |
1189 | * Use for a person or corporate body responsible for the review of book, motion | |
1190 | * picture, performance, etc. | |
1191 | */ | |
1192 | const REVIEWER = "rev"; | |
1193 | ||
1194 | /** | |
1195 | * Sponsor | |
1196 | * | |
1197 | * Use for the person or agency that issued a contract, or under whose auspices | |
1198 | * a work has been written, printed, published, etc. | |
1199 | */ | |
1200 | const SPONSOR = "spn"; | |
1201 | ||
1202 | /** | |
1203 | * Thesis advisor | |
1204 | * | |
1205 | * Use for the person under whose supervision a degree candidate develops and | |
1206 | * presents a thesis, memoir, or text of a dissertation. | |
1207 | */ | |
1208 | const THESIS_ADVISOR = "ths"; | |
1209 | ||
1210 | /** | |
1211 | * Transcriber | |
1212 | * | |
1213 | * Use for a person who prepares a handwritten or typewritten copy from original | |
1214 | * material, including from dictated or orally recorded material. | |
1215 | */ | |
1216 | const TRANSCRIBER = "trc"; | |
1217 | ||
1218 | /** | |
1219 | * Translator | |
1220 | * | |
1221 | * Use for a person who renders a text from one language into another, or from | |
1222 | * an older form of a language into the modern form. | |
1223 | */ | |
1224 | const TRANSLATOR = "trl"; | |
1225 | } | |
1226 | ?> |