Page MenuHomePhabricator
Files F1821286

ContextStackTrait.php
No OneTemporary
Actions

ContextStackTrait.php
View Options

<?php
namespace Sabre\Xml;
/**
* Context Stack
*
* The Context maintains information about a document during either reading or
* writing.
*
* During this process, it may be neccesary to override this context
* information.
*
* This trait allows easy access to the context, and allows the end-user to
* override its settings for document fragments, and easily restore it again
* later.
*
* @copyright Copyright (C) 2009-2015 fruux GmbH (https://fruux.com/).
* @author Evert Pot (http://evertpot.com/)
* @license http://sabre.io/license/ Modified BSD License
*/
trait ContextStackTrait {
/**
* This is the element map. It contains a list of XML elements (in clark
* notation) as keys and PHP class names as values.
*
* The PHP class names must implement Sabre\Xml\Element.
*
* Values may also be a callable. In that case the function will be called
* directly.
*
* @var array
*/
public $elementMap = [];
/**
* A contextUri pointing to the document being parsed / written.
* This uri may be used to resolve relative urls that may appear in the
* document.
*
* The reader and writer don't use this property, but as it's an extremely
* common use-case for parsing XML documents, it's added here as a
* convenience.
*
* @var string
*/
public $contextUri;
/**
* This is a list of namespaces that you want to give default prefixes.
*
* You must make sure you create this entire list before starting to write.
* They should be registered on the root element.
*
* @var array
*/
public $namespaceMap = [];
/**
* Backups of previous contexts.
*
* @var array
*/
protected $contextStack = [];
/**
* Create a new "context".
*
* This allows you to safely modify the elementMap, contextUri or
* namespaceMap. After you're done, you can restore the old data again
* with popContext.
*
* @return null
*/
function pushContext() {
$this->contextStack[] = [
$this->elementMap,
$this->contextUri,
$this->namespaceMap
];
}
/**
* Restore the previous "context".
*
* @return null
*/
function popContext() {
list(
$this->elementMap,
$this->contextUri,
$this->namespaceMap
) = array_pop($this->contextStack);
}
}

File Metadata

Mime Type
text/x-php
Expires
Mon, Dec 23, 3:01 PM (1 h, 40 m ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
915635
Default Alt Text
ContextStackTrait.php (2 KB)

Event Timeline