Added an "iBooks" metadata helper

Also started on a "Rendition" metadata helper

src/PHPePub/Helpers/IBooksHelper.php

@@ -0,0 +1,199 @@
+<?php
+namespace PHPePub\Helpers;
+
+use PHPePub\Core\EPub;
+use PHPePub\Helpers\enums\Boolean;
+
+/*
+    <display_options>
+         <platform name="*">
+              <option name="fixed-layout">true</option>
+              <option name="specified-fonts">true</option>
+         </platform>
+         <platform name="ipad">
+              <option name="open-to-spread">true</option>
+              <option name="orientation-lock">landscape-only"</option>
+              <option name="interactive">true</option>
+         </platform>
+    </display_options>
+
+http://www.fantasycastlebooks.com/Tutorials/ibooks-tutorial-part2.html
+http://www.fantasycastlebooks.com/Tutorials/ibooks-tutorial-update.html
+ */
+/**
+ * Helper for iBooks 2 and 3 books.
+ * Helper to generate com.apple.ibooks.display-options.xml for ePub2 books.
+
+ * @author    A. Grandt <[email protected]>
+ * @copyright 2009- A. Grandt
+ * @license   GNU LGPL 2.1
+ */
+class IBooksHelper {
+    const EPUB2_IBOOK_FILE_NAME = "com.apple.ibooks.display-options.xml";
+
+    /**
+     * Add with: $book->addCustomPrefix(iBooks::EPUB3_IBOOK_PREFIX_NAME, iBooks::EPUB3_IBOOK_PREFIX_URI);
+     */
+    const EPUB3_IBOOK_PREFIX_NAME = "ibooks";
+    const EPUB3_IBOOK_PREFIX_URI = "http://vocabulary.itunes.apple.com/rdf/ibooks/vocabulary-extensions-1.0";
+
+    const ORIENTATION_NONE = "none";
+    const ORIENTATION_PORTRAIT_ONLY = "portrait-only";
+    const ORIENTATION_LANDSCAPE_ONLY = "landscape-only";
+
+    const PLATFORM_ALL = "*";
+    const PLATFORM_IPHONE = "iphone";
+    const PLATFORM_IPAD = "ipad";
+
+    /**
+     * Enable fixed layout on iBooks
+     * Values: true/false
+     * Default: false
+     */
+    const EPUB2_FIXED_LAYOUT = "fixed-layout";
+
+    /**
+     * If you use embedded fonts, iBooks requires this property to display them.
+     * Values: true/false
+     * Default: false
+     */
+    const EPUB2_SPECIFIED_FONTS = "specified-fonts";
+
+    /**
+     * Open the book to a full two-page spread, or zoom to a page?
+     * Values: true/false
+     * Default: false
+     */
+    const EPUB2_OPEN_TO_SPREAD = "open-to-spread";
+
+    /**
+     * Lock orientation on the devices.
+     * Values: "none", "portrait-only", "landscape-only"
+     * Default: "none"
+     */
+    const EPUB2_ORIENTATION_LOCK = "orientation-lock";
+
+    /**
+     * Allow active content, such as scripting and canvas.
+     * Values: true/false
+     * Default: false
+     */
+    const EPUB2_INTERACTIVE = "interactive";
+
+    /**
+     * Enable fixed layout on iBooks
+     * Values: true/false
+     * Default: false
+     */
+    const EPUB3_FIXED_LAYOUT = "ibooks:fixed-layout";
+
+    /**
+     * Lock orientation on iPhone devices. Omit this property if there is no orientation lock.
+     * Values: "portrait-only", "landscape-only"
+     * Default: "none"
+     */
+    const EPUB3_IPHONE_ORIENTATION_LOCK = "ibooks:iphone-orientation-lock";
+
+    /**
+     * Lock orientation on iPad devices. Omit this property if there is no orientation lock.
+     * Values: "portrait-only", "landscape-only"
+     * Default: "none"
+     */
+    const EPUB3_IPAD_ORIENTATION_LOCK = "ibooks:ipad-orientation-lock";
+
+    /**
+     * If you use embedded fonts, iBooks requires this property to display them.
+     * Values: true/false
+     * Default: false
+     */
+    const EPUB3_SPECIFIED_FONTS = "ibooks:specified-fonts";
+
+    /**
+     * Tell iBooks if it is to display the "faux" book binding.
+     * Values: true/false
+     * Default: true
+     */
+    const EPUB3_BINDING = "ibooks:binding";
+
+    /**
+     * You can add a version number to your title in order to distinguish a new edition, with either major or minor changes. Readers who have purchased the book will be notified automatically that an updated file is available, and upon download the new version will replace their earlier one.
+     *
+     * The version number is in the typical 3 level major.minor.release format: ####.####.####
+     */
+    const EPUB3_VERSION = "ibooks:version";
+
+    /**
+     * Add iBooks prefix to the ePub book
+     *
+     * @param EPub $book
+     */
+    public static function addPrefix($book) {
+        if (!$book->isEPubVersion2()) {
+            $book->addCustomPrefix(self::EPUB3_IBOOK_PREFIX_NAME, self::EPUB3_IBOOK_PREFIX_URI);
+        }
+    }
+
+    /**
+     * @param EPub   $book
+     * @param string $property
+     * @param string $value
+     */
+    public static function addProperty($book, $property, $value) {
+        if (!$book->isEPubVersion2()) {
+            $book->addCustomMetaProperty($property, $value);
+        }
+    }
+
+    /**
+     * @param EPub $book
+     * @param bool $value
+     */
+    public static function setFixedLayout($book, $value) {
+        if (!$book->isEPubVersion2()) {
+            $book->addCustomMetaProperty(self::EPUB3_FIXED_LAYOUT, Boolean::getBoolean($value));
+        }
+    }
+
+    /**
+     * @param EPub   $book
+     * @param string $value "portrait-only", "landscape-only"
+     */
+    public static function setIPhoneOrientationLock($book, $value) {
+        if (!$book->isEPubVersion2() && $value === self::ORIENTATION_PORTRAIT_ONLY || $value === self::ORIENTATION_LANDSCAPE_ONLY) {
+            $book->addCustomMetaProperty(self::EPUB3_IPHONE_ORIENTATION_LOCK, $value);
+        }
+    }
+
+    /**
+     * @param EPub   $book
+     * @param string $value "portrait-only", "landscape-only"
+     */
+    public static function setIPadOrientationLock($book, $value) {
+        if (!$book->isEPubVersion2() && $value === self::ORIENTATION_PORTRAIT_ONLY || $value === self::ORIENTATION_LANDSCAPE_ONLY) {
+            $book->addCustomMetaProperty(self::EPUB3_IPAD_ORIENTATION_LOCK, $value);
+        }
+    }
+
+    /**
+     * @param EPub $book
+     * @param bool $value
+     */
+    public static function setSpecifiedFonts($book, $value) {
+        if (!$book->isEPubVersion2()) {
+            $book->addCustomMetaProperty(self::EPUB3_SPECIFIED_FONTS, Boolean::getBoolean($value));
+        }
+    }
+
+    /**
+     * @param EPub $book
+     * @param bool $value
+     */
+    public static function setBinding($book, $value) {
+        if (!$book->isEPubVersion2()) {
+            $book->addCustomMetaProperty(self::EPUB3_BINDING, Boolean::getBoolean($value));
+        }
+    }
+
+    // TODO Add ePub2 implementation is the iBooks xml file.
+
+}

src/PHPePub/Helpers/Rendition/RenditionHelper.php

@@ -2,17 +2,18 @@
 namespace PHPePub\Helpers\Rendition;
 
 use PHPePub\Core\EPub;
-use PHPePub\Core\StaticData;
 
 /**
  * Helper for Rendition ePub3 extensions.
  *
+ *   http://www.idpf.org/epub/fxl/#property-defs
+ *
  * @author    A. Grandt <[email protected]>
  * @copyright 2015- A. Grandt
  * @license   GNU LGPL 2.1
  */
 class RenditionHelper {
-    // http://www.idpf.org/epub/fxl/#property-defs
+
     const RENDITION_PREFIX_NAME = "rendition";
     const RENDITION_PREFIX_URI = "http://www.idpf.org/vocab/rendition/#";