Base.php

Go to the documentation of this file.

<?php
 
namespace Depage\XmlDb\XmlDoctypes;
 
use Depage\XmlDb\Interfaces\DoctypeInterface;

class Base implements DoctypeInterface
{
    // list of elements that may created by a user
    protected $availableNodes = [];
 
    // list of valid parents given by nodename
    protected $validParents = [
        '*' => [
            '*',
        ],
    ];
 
    // list of names of nodes not to be affected by whitespace stripping
    protected $preserveWhitespace = [];
 
    protected $xmlDb;
    protected $document;

    public function __construct($xmlDb, $document)
    {
        $this->xmlDb = $xmlDb;
        $this->document = $document;
    }

    public function getPermissions()
    {
        return (object) [
            'validParents' => $this->getValidParents(),
            'availableNodes' => $this->getAvailableNodes(),
        ];
    }

    public function getValidParents()
    {
        return $this->validParents;
    }

    public function getAvailableNodes()
    {
        return $this->availableNodes;
    }

    public function getPreserveWhitespace()
    {
        return $this->preserveWhitespace;
    }

    public function getNewNodeFor($name)
    {
        $result = false;
 
        if (isset($this->availableNodes[$name])) {
            $nodeInfo = $this->availableNodes[$name];
            $docInfo = $this->document->getNamespacesAndEntities();
 
            if (isset($nodeInfo->xmlTemplateData)) {
                $xml = $nodeInfo->xmlTemplateData;
            } else {
                $xml = "<$name {$docInfo->namespaces}";
                if (!empty($nodeInfo->newName)) {
                    $xml .= " name=\"" . htmlspecialchars($nodeInfo->newName) . "\"";
                }
                if (isset($nodeInfo->attributes)) {
                    foreach ($nodeInfo->attributes as $attr => $value) {
                        $xml .= " $attr=\"" . htmlspecialchars($value) . "\"";
                    }
                }
                $xml .= '/>';
            }
            $doc = new \DOMDocument();
            $doc->loadXML("<root xmlns:pg=\"http://cms.depagecms.net/ns/page\" xmlns:sec=\"http://cms.depagecms.net/ns/section\" xmlns:edit=\"http://cms.depagecms.net/ns/edit\">$xml</root>");
 
            $result = $doc->documentElement->childNodes;
        }
 
        return $result;
    }

    public function isAllowedIn($nodeName, $targetNodeName)
    {
        $result = false;
 
        if (isset($this->validParents['*'])) {
            $result = in_array('*', $this->validParents['*']) || in_array($targetNodeName, $this->validParents['*']);
        } elseif (isset($this->validParents[$nodeName])) {
            $result = in_array('*', $this->validParents[$nodeName]) || in_array($targetNodeName, $this->validParents[$nodeName]);
        }
 
        return $result;
    }

    public function isAllowedAdd($node, $targetId)
    {
        return $this->isAllowedIn(
            $node->nodeName,
            $this->document->getNodeNameById($targetId)
        );
    }

    public function isAllowedCopy($nodeId, $targetId)
    {
        return $this->isAllowedMove($nodeId, $targetId);
    }

    public function isAllowedMove($nodeId, $targetId)
    {
        return $this->isAllowedIn(
            $this->document->getNodeNameById($nodeId),
            $this->document->getNodeNameById($targetId)
        );
    }

    public function isAllowedDelete($nodeId)
    {
        return true;
    }

    public function onDocumentChange()
    {
        return true;
    }

    public function onAddNode(\DomNode $node, $targetId, $targetIndex, $extras)
    {
        return true;
    }

    public function onCopyNode($nodeId, $copyId)
    {
        return true;
    }

    public function onMoveNode($nodeId, $oldParentId)
    {
        return true;
    }

    public function onDeleteNode($nodeId, $parentId)
    {
        return true;
    }

    public function onSetAttribute($nodeId, $attrName, $oldVal, $newVal)
    {
        return true;
    }

    public function onHistorySave()
    {
        return true;
    }

    public function testDocument($xml)
    {
        return false;
    }

    public function testDocumentForHistory($xml)
    {
        return false;
    }
}