File GedcomxFile/GedcomxFile.php

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206

<?php

namespace Gedcomx\GedcomxFile;

use \ZipArchive;

/**
 * Class GedcomxFile
 * @package Gedcomx\GedcomxFile
 *
 * Provides methods for working with a GedcomX file.
 */
class GedcomxFile
{
    /**
     * The handle to the .gedx archive
     *
     * @var ZipArchive
     */
    private $archive;
    /**
     * The file attributes based on the manifest file.
     *
     * @var \Gedcomx\GedcomxFile\GedcomxFileEntry[]
     */
    private $entries;
    /**
     * Attributes from the manifest file
     *
     * @var array
     */
    private $attributes;
    /**
     * Warning messages generated during parsing.
     *
     * @var string[]
     */
    private $warnings;
    /**
     * @var \Gedcomx\GedcomxFile\GedcomxEntryDeserializer
     */
    private $deserializer;
    /**
     * @var Manifest
     */
    private $manifest;

    /**
     * Create a new instance of a GedcomxFile
     *
     * @param string                                        $filepath     The path to the .gedx file
     * @param \Gedcomx\GedcomxFile\GedcomxEntryDeserializer $deserializer The class to use for deserialization.
     *                                                                    Defaults to DefaultXMLSerialization
     *
     * @throws \Gedcomx\GedcomxFile\GedcomxFileException
     */
    public function __construct($filepath, GedcomxEntryDeserializer $deserializer = null)
    {
        $this->deserializer = $deserializer;
        if( $this->deserializer == null){
            $this->deserializer = new DefaultXMLSerialization();
        }

        $this->archive = new ZipArchive();
        $result = $this->archive->open($filepath);
        if ( $result !== true) {
            throw new GedcomxFileException($result);
        }

        $this->loadEntries();
    }

    /**
     * Return the entries found in the archive
     *
     * @return GedcomxFileEntry[]
     */
    public function getEntries()
    {
        return $this->entries;
    }

    /**
     * Return attributes from the manifest file
     *
     * @return array
     */
    public function getAttributes()
    {
        return $this->attributes;
    }

    /**
     * Return any warnings generated during parsing
     *
     * @return array
     */
    public function getWarnings()
    {
        return $this->warnings;
    }

    /**
     * Add an attribute to the list
     *
     * @param string $key
     * @param string $value
     */
    public function addAttribute($key, $value)
    {
        $this->attributes[$key] = $value;
    }

    /**
     * Return the value of an attribute
     *
     * @param string $key
     *
     * @return string|null
     */
    public  function getAttribute($key)
    {
        if( $this->manifest != null) {
            return $this->manifest->getAttribute($key);
        }

        return null;
    }

    /**
     * Deserialize a GedcomX resource
     *
     * @param \Gedcomx\GedcomxFile\GedcomxFileEntry $entry
     *
     * @return mixed
     */
    public function readResource(GedcomxFileEntry $entry)
    {
        return $this->deserializer->deserialize($entry->getContents());
    }

    /**
     * Close the archive file.
     */
    public function close()
    {
        if ($this->archive != null) {
            $this->archive->close();
        }
    }

    /**
     * Read the archive contents
     */
    private function loadEntries()
    {
        $this->readManifest();

        $i = 0;
        do {
            $name = $this->archive->getNameIndex($i);
            if ($name !== false && $name != 'META-INF/MANIFEST.MF') {
                $this->entries[] = $this->readEntry($name);
            }
            $i++;
        } while ($name !== false);
    }

    /**
     * Look for the manifest file and parse it if found.
     */
    private function readManifest()
    {
        $index = $this->archive->locateName("manifest.mf", ZipArchive::FL_NOCASE|ZipArchive::FL_NODIR);
        if ($index === false) {
            $this->warnings[] = "No MANIFEST.MF file was found.";
            return;
        }

        $this->manifest = new Manifest();
        $this->manifest->parse($this->archive->getFromIndex($index));
    }

    /**
     * Read an entry from the archive and look for manifest properties.
     *
     * @param string $name
     *
     * @return \Gedcomx\GedcomxFile\GedcomxFileEntry
     */
    public function readEntry($name)
    {
        $entry = new GedcomxFileEntry($name);
        $entry->setContents($this->archive->getFromName($name));
        $manifestAttrs = $this->manifest->getEntryAttributes($name);
        if ($manifestAttrs != null) {
            foreach ($manifestAttrs as $attr) {
                $entry->addAttribute($attr->getKey(), $attr->getValue());
            }
        } else {
            $this->warnings[] = 'No manifest attributes found for ' . $name;
        }

        return $entry;
    }
}

Namespaces

Classes

Interfaces

Exceptions