如何在$ _SESSION中序列化/保存DOMElement?

时间:2012-05-01 13:13:50

标签: php session dom serialization

我是PHP,DOM和PHP DOM实现的新手。我要做的是将DOMDocument的根元素保存在$_SESSION变量中,以便我可以访问它并在后续页面加载时修改它。

但是当我使用$_SESSION来保存DOMElement的状态时,我在PHP中遇到错误:

  

警告:DOMNode :: appendChild()[domnode.appendchild]:无法获取DOMElement

我已经读过PHP DOMDocument对象本身无法保存到$_SESSION。但是,可以通过保存DOMDocument的序列化来保存它(例如$_SESSION['dom'] = $dom->saveXML())。

我不知道将DOMElement保存到$_SESSION变量是否也是如此,但这就是我的尝试。我想要这样做的原因是使用带有一个附加属性的扩展类DOMElement。我希望通过在$ _SESSION中保存根DOMElement,我可以在以后检索元素并修改这个附加属性并执行测试,如果(additionalProperty === false){做某事; }。我还读到了通过保存DOMDocument并稍后检索它,所有元素都作为来自本机DOM类的对象返回。也就是说,即使我使用扩展类来创建元素,我随后需要的属性也是不可访问的,因为保存对扩展类对象的引用的变量已超出范围 - 这就是为什么我'我正在尝试这件事。我首先尝试使用扩展类(不包括在下面),但是出现了错误......所以我恢复使用DOMElement对象来查看是否存在问题,但我仍然遇到相同的错误。这是代码:

<?php
session_start();

$rootTag = 'root';
$doc = new DOMDocument;

if (!isset($_SESSION[$rootTag])) {
    $_SESSION[$rootTag] = new DOMElement($rootTag);
}

$root = $doc->appendChild($_SESSION[$rootTag]);
//$root = $doc->appendChild($doc->importNode($_SESSION[$rootTag], true));

$child = new DOMElement('child_element');
$n = $root->appendChild($child);

$ct = 0;
foreach ($root->childNodes as $ch) echo '<br/>'.$ch->tagName.' '.++$ct;

$_SESSION[$rootTag] = $doc->documentElement;
?>

此代码提供以下错误(取决于我是直接使用appendChild还是使用importNode使用注释的代码行):

Warning: DOMNode::appendChild() [domnode.appendchild]: Couldn't fetch DOMElement in C:\Program Files\wamp_server_2.2\www\test2.php on line 11

Warning: DOMDocument::importNode() [domdocument.importnode]: Couldn't fetch DOMElement in C:\Program Files\wamp_server_2.2\www\test2.php on line 12

我有几个问题。首先,导致此错误的原因是什么?如何解决?另外,如果我想做的事情是不可能的,那么如何在为每个元素使用自定义属性的同时实现保存DOM树的“状态”的总体目标呢?请注意,附加属性仅在程序中使用,而不是要保存在XML文件中的属性。此外,我不能每次都将DOM保存回文件,因为修改后的DOMDocument根据我正在使用的模式可能无效,直到稍后对DOMDocument执行了其他修改/添加时。这就是为什么我需要保存一个暂时无效的DOMDocument。谢谢你的建议!

EDITED: 在尝试了hakre的解决方案后,代码运行良好。然后我继续尝试使用扩展类DOMElement,并且,正如我所怀疑的那样,它没有用。这是新代码:

<?php
session_start();
//$_SESSION = array();
$rootTag = 'root';
$doc = new DOMDocument;

if (!isset($_SESSION[$rootTag])) {
    $root = new FreezableDOMElement($rootTag);
    $doc->appendChild($root);
} else {
    $doc->loadXML($_SESSION[$rootTag]);
    $root = $doc->documentElement;
}

$child = new FreezableDOMElement('child_element');
$n = $root->appendChild($child);

$ct = 0;
foreach ($root->childNodes as $ch) {
    $frozen = $ch->frozen ? 'is frozen' : 'is not frozen';
    echo '<br/>'.$ch->tagName.' '.++$ct.': '.$frozen;
    //echo '<br/>'.$ch->tagName.' '.++$ct;
}

$_SESSION[$rootTag] = $doc->saveXML();

/**********************************************************************************
 * FreezableDOMElement class
 *********************************************************************************/
class FreezableDOMElement extends DOMElement {
    public $frozen; // boolean value

    public function __construct($name) {
        parent::__construct($name);
        $this->frozen = false;
    }
}
?>

它给了我错误Undefined property: DOMElement::$frozen。就像我在原始帖子中提到的那样,在saveXMLloadXML之后,最初使用FreezableDOMElement实例化的元素返回类型DOMElement,这就是为什么frozen属性是未识别。有没有办法解决这个问题?

1 个答案:

答案 0 :(得分:4)

您无法在DOMElement内存储$_SESSION个对象。它最初会起作用,但是对于下一个请求,它将被取消设置,因为它无法序列化。

就像你在问题中所写的DOMDocument一样。

将其存储为XML,或封装序列化机制。

你基本上面临三个问题:

  • 序列化DOMDocument(您执行此操作)
  • 序列化FreezableDOMElement(您执行此操作)
  • 将私人成员FreezableDOMElement::$frozen与文档保持一致。

如上所述,序列化不是开箱即用的。此外,DOMDocument不会保留您的FreezableDOMElement甚至没有序列化。以下示例演示实例未自动保留,返回默认值FALSEDemo):

class FreezableDOMElement extends DOMElement
{
    private $frozen = FALSE;

    public function getFrozen()
    {
        return $this->frozen;
    }

    public function setFrozen($frozen)
    {
        $this->frozen = (bool)$frozen;
    }
}

class FreezableDOMDocument extends DOMDocument
{
    public function __construct()
    {
        parent::__construct();
        $this->registerNodeClass('DOMElement', 'FreezableDOMElement');
    }
}

$doc = new FreezableDOMDocument();
$doc->loadXML('<root><child></child></root>');

# own objects do not persist
$doc->documentElement->setFrozen(TRUE);
printf("Element is frozen (should): %d\n", $doc->documentElement->getFrozen()); # it is not (0)

由于PHP到目前为止还没有支持setUserData(DOM Level 3),一种方法是将附加信息存储在带有该元素的namespaced属性中。这也可以通过在序列化对象时创建XML字符串并在反序列化时加载它来序列化(请参阅Serializable)。然后,这解决了所有三个问题(Demo):

class FreezableDOMElement extends DOMElement
{
    public function getFrozen()
    {
        return $this->getFrozenAttribute()->nodeValue === 'YES';
    }

    public function setFrozen($frozen)
    {
        $this->getFrozenAttribute()->nodeValue = $frozen ? 'YES' : 'NO';
    }

    private function getFrozenAttribute()
    {
        return $this->getSerializedAttribute('frozen');
    }

    protected function getSerializedAttribute($localName)
    {
        $namespaceURI = FreezableDOMDocument::NS_URI;
        $prefix = FreezableDOMDocument::NS_PREFIX;

        if ($this->hasAttributeNS($namespaceURI, $localName)) {
            $attrib = $this->getAttributeNodeNS($namespaceURI, $localName);
        } else {
            $this->ownerDocument->documentElement->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:' . $prefix, $namespaceURI);
            $attrib = $this->ownerDocument->createAttributeNS($namespaceURI, $prefix . ':' . $localName);
            $attrib = $this->appendChild($attrib);
        }
        return $attrib;
    }
}

class FreezableDOMDocument extends DOMDocument implements Serializable
{
    const NS_URI = '/frozen.org/freeze/2';
    const NS_PREFIX = 'freeze';

    public function __construct()
    {
        parent::__construct();
        $this->registerNodeClasses();
    }

    private function registerNodeClasses()
    {
        $this->registerNodeClass('DOMElement', 'FreezableDOMElement');
    }

    /**
     * @return DOMNodeList
     */
    private function getNodes()
    {
        $xp = new DOMXPath($this);
        return $xp->query('//*');
    }

    public function serialize()
    {
        return parent::saveXML();
    }

    public function unserialize($serialized)
    {
        parent::__construct();
        $this->registerNodeClasses();
        $this->loadXML($serialized);
    }

    public function saveBareXML()
    {
        $doc = new DOMDocument();
        $doc->loadXML(parent::saveXML());
        $xp = new DOMXPath($doc);
        foreach ($xp->query('//@*[namespace-uri()=\'' . self::NS_URI . '\']') as $attr) {
            /* @var $attr DOMAttr */
            $attr->parentNode->removeAttributeNode($attr);
        }
        $doc->documentElement->removeAttributeNS(self::NS_URI, self::NS_PREFIX);
        return $doc->saveXML();
    }

    public function saveXMLDirect()
    {
        return parent::saveXML();
    }
}

$doc = new FreezableDOMDocument();
$doc->loadXML('<root><child></child></root>');
$doc->documentElement->setFrozen(TRUE);
$child = $doc->getElementsByTagName('child')->item(0);
$child->setFrozen(TRUE);

echo "Plain XML:\n", $doc->saveXML(), "\n";
echo "Bare XML:\n", $doc->saveBareXML(), "\n";

$serialized = serialize($doc);

echo "Serialized:\n", $serialized, "\n";

$newDoc = unserialize($serialized);

printf("Document Element is frozen (should be): %s\n", $newDoc->documentElement->getFrozen() ? 'YES' : 'NO');
printf("Child Element is frozen (should be): %s\n", $newDoc->getElementsByTagName('child')->item(0)->getFrozen() ? 'YES' : 'NO');

这不是功能完整,而是一个有效的演示。无需额外的“冻结”数据就可以获得完整的XML。