Sid Gifari File Manager

Sid Gifari File Manager

🏠 Root / home / genremedia08 / musicjukebox.overlookedtracks.com / vendor / jetbrains / phpstorm-stubs / SimpleXML /

Editing: SimpleXML.php

<?php

// Start of SimpleXML v.0.1
use JetBrains\PhpStorm\Internal\LanguageLevelTypeAware;
use JetBrains\PhpStorm\Internal\PhpStormStubsElementAvailable;
use JetBrains\PhpStorm\Internal\TentativeType;
use JetBrains\PhpStorm\Pure;

/**
 * Represents an element in an XML document.
 * @link https://php.net/manual/en/class.simplexmlelement.php
 */
class SimpleXMLElement implements Traversable, ArrayAccess, Countable, Iterator, Stringable, RecursiveIterator
{
    /**
     * Creates a new SimpleXMLElement object
     * @link https://php.net/manual/en/simplexmlelement.construct.php
     * @param string $data A well-formed XML string or the path or URL to an XML document if data_is_url is TRUE.
     * @param int $options Optionally used to specify additional Libxml parameters.
     * @param bool $dataIsURL By default, data_is_url is FALSE.
     * Use TRUE to specify that data is a path or URL to an XML document instead of string data.
     * @param string $namespaceOrPrefix Namespace prefix or URI.
     * @param bool $isPrefix TRUE if ns is a prefix, FALSE if it's a URI; defaults to FALSE.
     * @throws Exception if the XML data could not be parsed.
     * @since 5.0.1
     */
    #[Pure]
    public function __construct(
        #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $data,
        #[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $options = 0,
        #[LanguageLevelTypeAware(['8.0' => 'bool'], default: '')] $dataIsURL = false,
        #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $namespaceOrPrefix = "",
        #[LanguageLevelTypeAware(['8.0' => 'bool'], default: '')] $isPrefix = false
    ) {}

/**
     * Provides access to element's children
     * private Method not callable directly, stub exists for typehint only
     * @param string $name child name
     * @return static
     */
    private function __get($name) {}

/**
 * Return a well-formed XML string based on SimpleXML element
 * @link https://php.net/manual/en/simplexmlelement.asxml.php
 * @param string $filename [optional] 
 * If specified, the function writes the data to the file rather than
 * returning it.
 * 
 * @return string|bool If the filename isn't specified, this function
 * returns a string on success and FALSE on error. If the
 * parameter is specified, it returns TRUE if the file was written
 * successfully and FALSE otherwise.
 * @since 5.0.1
 */
 #[TentativeType]
 public function asXML(#[LanguageLevelTypeAware(['8.0' => 'string|null'], default: '')] $filename = null): string|bool {}

/**
 * Alias of SimpleXMLElement::asXML
 * Return a well-formed XML string based on SimpleXML element
 * @link https://php.net/manual/en/simplexmlelement.savexml.php
 * @param string $filename [optional] 
 * If specified, the function writes the data to the file rather than
 * returning it.
 * 
 * @return string|bool If the filename isn't specified, this function
 * returns a string on success and false on error. If the
 * parameter is specified, it returns true if the file was written
 * successfully and false otherwise.
 */
 #[TentativeType]
 public function saveXML(#[LanguageLevelTypeAware(['8.0' => 'string|null'], default: '')] $filename = null): string|bool {}

/**
 * Runs XPath query on XML data
 * @link https://php.net/manual/en/simplexmlelement.xpath.php
 * @param string $expression 
 * An XPath path
 * 
 * @return static[]|false|null an array of SimpleXMLElement objects or FALSE in
 * case of an error.
 */
 #[TentativeType]
 public function xpath(#[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $expression): array|false|null {}

/**
 * Creates a prefix/ns context for the next XPath query
 * @link https://php.net/manual/en/simplexmlelement.registerxpathnamespace.php
 * @param string $prefix 
 * The namespace prefix to use in the XPath query for the namespace given in
 * ns.
 * 
 * @param string $namespace 
 * The namespace to use for the XPath query. This must match a namespace in
 * use by the XML document or the XPath query using
 * prefix will not return any results.
 * 
 * @return bool TRUE on success or FALSE on failure.
 */
 #[TentativeType]
 public function registerXPathNamespace(
 #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $prefix,
 #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $namespace
 ): bool {}

/**
 * Identifies an element's attributes
 * @link https://php.net/manual/en/simplexmlelement.attributes.php
 * @param string $namespaceOrPrefix [optional] 
 * An optional namespace for the retrieved attributes
 * 
 * @param bool $isPrefix [optional] 
 * Default to FALSE
 * 
 * @return static|null a SimpleXMLElement object that can be
 * iterated over to loop through the attributes on the tag.
 * 
 * 
 * Returns NULL if called on a SimpleXMLElement
 * object that already represents an attribute and not a tag.
 * @since 5.0.1
 */
 #[TentativeType]
 public function attributes(
 #[LanguageLevelTypeAware(['8.0' => 'string|null'], default: '')] $namespaceOrPrefix = null,
 #[LanguageLevelTypeAware(['8.0' => 'bool'], default: '')] $isPrefix = false
 ): ?static {}

/**
 * Finds children of given node
 * @link https://php.net/manual/en/simplexmlelement.children.php
 * @param string $namespaceOrPrefix [optional] 
 * An XML namespace.
 * 
 * @param bool $isPrefix [optional] 
 * If is_prefix is TRUE,
 * ns will be regarded as a prefix. If FALSE,
 * ns will be regarded as a namespace
 * URL.
 * 
 * @return static|null a SimpleXMLElement element, whether the node
 * has children or not.
 * @since 5.0.1
 */
 #[Pure]
 #[TentativeType]
 public function children(
 #[LanguageLevelTypeAware(['8.0' => 'string|null'], default: '')] $namespaceOrPrefix = null,
 #[LanguageLevelTypeAware(['8.0' => 'bool'], default: '')] $isPrefix = false
 ): ?static {}

/**
 * Returns namespaces used in document
 * @link https://php.net/manual/en/simplexmlelement.getnamespaces.php
 * @param bool $recursive [optional] 
 * If specified, returns all namespaces used in parent and child nodes.
 * Otherwise, returns only namespaces used in root node.
 * 
 * @return array The getNamespaces method returns an array of
 * namespace names with their associated URIs.
 * @since 5.1.2
 */
 #[Pure]
 #[TentativeType]
 public function getNamespaces(#[LanguageLevelTypeAware(['8.0' => 'bool'], default: '')] $recursive = false): array {}

/**
 * Returns namespaces declared in document
 * @link https://php.net/manual/en/simplexmlelement.getdocnamespaces.php
 * @param bool $recursive [optional] 
 * If specified, returns all namespaces declared in parent and child nodes.
 * Otherwise, returns only namespaces declared in root node.
 * 
 * @param bool $fromRoot [optional] 
 * Allows you to recursively check namespaces under a child node instead of
 * from the root of the XML doc.
 * 
 * @return array The getDocNamespaces method returns an array
 * of namespace names with their associated URIs.
 * @since 5.1.2
 */
 #[Pure]
 #[TentativeType]
 public function getDocNamespaces(
 #[LanguageLevelTypeAware(['8.0' => 'bool'], default: '')] $recursive = false,
 #[LanguageLevelTypeAware(['8.0' => 'bool'], default: '')] $fromRoot = true
 ): array|false {}

/**
     * Gets the name of the XML element
     * @link https://php.net/manual/en/simplexmlelement.getname.php
     * @return string The getName method returns as a string the
     * name of the XML tag referenced by the SimpleXMLElement object.
     * @since 5.1.3
     */
    #[Pure]
    #[TentativeType]
    public function getName(): string {}

/**
 * Adds a child element to the XML node
 * @link https://php.net/manual/en/simplexmlelement.addchild.php
 * @param string $qualifiedName 
 * The name of the child element to add.
 * 
 * @param string $value [optional] 
 * If specified, the value of the child element.
 * 
 * @param string $namespace [optional] 
 * If specified, the namespace to which the child element belongs.
 * 
 * @return static|null The addChild method returns a SimpleXMLElement
 * object representing the child added to the XML node.
 * @since 5.1.3
 */
 #[TentativeType]
 public function addChild(
 #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $qualifiedName,
 #[LanguageLevelTypeAware(['8.0' => 'string|null'], default: '')] $value = null,
 #[LanguageLevelTypeAware(['8.0' => 'string|null'], default: '')] $namespace = null
 ): ?static {}

/**
 * Adds an attribute to the SimpleXML element
 * @link https://php.net/manual/en/simplexmlelement.addattribute.php
 * @param string $qualifiedName 
 * The name of the attribute to add.
 * 
 * @param string $value 
 * The value of the attribute.
 * 
 * @param string $namespace [optional] 
 * If specified, the namespace to which the attribute belongs.
 * 
 * @return void No value is returned.
 * @since 5.1.3
 */
 #[TentativeType]
 public function addAttribute(
 #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $qualifiedName,
 #[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] $value = null,
 #[PhpStormStubsElementAvailable(from: '8.0')] string $value,
 #[LanguageLevelTypeAware(['8.0' => 'string|null'], default: '')] $namespace = null
 ): void {}

/**
     * Returns the string content
     * @link https://php.net/manual/en/simplexmlelement.tostring.php
     * @return string the string content on success or an empty string on failure.
     * @since 5.3
     */
    #[TentativeType]
    public function __toString(): string {}

/**
 * Counts the children of an element
 * @link https://php.net/manual/en/simplexmlelement.count.php
 * @return int<0,max> the number of elements of an element.
 */
 #[Pure]
 #[TentativeType]
 public function count(): int {}

/**
     * Class provides access to children by position, and attributes by name
     * private Method not callable directly, stub exists for typehint only
     * @param string|int $offset
     * @return bool true on success or false on failure.
     */
    #[Pure]
    public function offsetExists($offset) {}

/**
     * Class provides access to children by position, and attributes by name
     * private Method not callable directly, stub exists for typehint only
     * @param string|int $offset
     * @return static Either a named attribute or an element from a list of children
     */
    #[Pure]
    public function offsetGet($offset) {}

/**
     * Class provides access to children by position, and attributes by name
     * private Method not callable directly, stub exists for typehint only
     * @param string|int $offset
     * @param mixed $value
     * @return void
     */
    public function offsetSet($offset, $value) {}

/**
     * Class provides access to children by position, and attributes by name
     * private Method not callable directly, stub exists for typehint only
     * @param string|int $offset
     * @return void
     */
    public function offsetUnset($offset) {}

/**
     * Rewind to the first element
     * @link https://php.net/manual/en/simplexmliterator.rewind.php
     * @return void No value is returned.
     */
    #[TentativeType]
    public function rewind(): void {}

/**
 * Check whether the current element is valid
 * @link https://php.net/manual/en/simplexmliterator.valid.php
 * @return bool TRUE if the current element is valid, otherwise FALSE
 */
 #[Pure]
 #[TentativeType]
 public function valid(): bool {}

/**
 * Returns the current element
 * @link https://php.net/manual/en/simplexmliterator.current.php
 * @return static|null the current element as a SimpleXMLElement object or NULL on failure.
 */
 #[Pure]
 #[TentativeType]
 public function current(): ?static {}

/**
 * Return current key
 * @link https://php.net/manual/en/simplexmliterator.key.php
 * @return string|false the XML tag name of the element referenced by the current SimpleXMLIterator object
 */
 #[TentativeType]
 #[LanguageLevelTypeAware(['8.0' => 'string'], default: 'string|false')]
 public function key() {}

/**
     * Move to next element
     * @link https://php.net/manual/en/simplexmliterator.next.php
     * @return void No value is returned.
     */
    #[TentativeType]
    public function next(): void {}

/**
     * @return bool
     * @since 8.0
     */
    #[Pure]
    #[TentativeType]
    public function hasChildren(): bool {}

/**
     * @since 8.0
     */
    #[Pure]
    #[TentativeType]
    public function getChildren(): ?SimpleXMLElement {}
}

/**
 * The SimpleXMLIterator provides recursive iteration over all nodes of a SimpleXMLElement object.
 * @link https://php.net/manual/en/class.simplexmliterator.php
 */
class SimpleXMLIterator extends SimpleXMLElement implements RecursiveIterator, Countable, Stringable
{
 /**
 * Rewind to the first element
 * @link https://php.net/manual/en/simplexmliterator.rewind.php
 * @return void No value is returned.
 */
 public function rewind() {}

/**
 * Returns the current element
 * @link https://php.net/manual/en/simplexmliterator.current.php
 * @return static|null the current element as a SimpleXMLIterator object or NULL on failure.
 */
 #[Pure]
 public function current() {}

/**
 * Return current key
 * @link https://php.net/manual/en/simplexmliterator.key.php
 * @return string|false the XML tag name of the element referenced by the current SimpleXMLIterator object or FALSE
 */
 public function key() {}

/**
     * Move to next element
     * @link https://php.net/manual/en/simplexmliterator.next.php
     * @return void No value is returned.
     */
    public function next() {}

/**
 * Checks whether the current element has sub elements.
 * @link https://php.net/manual/en/simplexmliterator.haschildren.php
 * @return bool TRUE if the current element has sub-elements, otherwise FALSE
 */
 #[Pure]
 public function hasChildren() {}

/**
 * Returns the sub-elements of the current element
 * @link https://php.net/manual/en/simplexmliterator.getchildren.php
 * @return SimpleXMLIterator a SimpleXMLIterator object containing
 * the sub-elements of the current element.
 */
 #[Pure]
 public function getChildren() {}

/**
     * Counts the children of an element
     * @link https://php.net/manual/en/simplexmlelement.count.php
     * @return int the number of elements of an element.
     */
    #[Pure]
    public function count() {}
}

/**
 * Interprets an XML file into an object
 * @link https://php.net/manual/en/function.simplexml-load-file.php
 * @param string $filename 
 * Path to the XML file
 * 
 * 
 * Libxml 2 unescapes the URI, so if you want to pass e.g.
 * b&c as the URI parameter a,
 * you have to call
 * simplexml_load_file(rawurlencode('https://example.com/?a=' .
 * urlencode('b&c'))). Since PHP 5.1.0 you don't need to do
 * this because PHP will do it for you.
 * 
 * @param string|null $class_name [optional] 
 * You may use this optional parameter so that
 * simplexml_load_file will return an object of
 * the specified class. That class should extend the
 * SimpleXMLElement class.
 * 
 * @param int $options [optional] 
 * Since PHP 5.1.0 and Libxml 2.6.0, you may also use the
 * options parameter to specify additional Libxml parameters.
 * 
 * @param string $namespace_or_prefix [optional] 
 * Namespace prefix or URI.
 * 
 * @param bool $is_prefix [optional] 
 * TRUE if ns is a prefix, FALSE if it's a URI;
 * defaults to FALSE.
 * 
 * @return SimpleXMLElement|false an object of class SimpleXMLElement with
 * properties containing the data held within the XML document, or FALSE on failure.
 */
function simplexml_load_file(string $filename, ?string $class_name = "SimpleXMLElement", int $options = 0, string $namespace_or_prefix = "", bool $is_prefix = false): SimpleXMLElement|false {}

/**
 * Interprets a string of XML into an object
 * @link https://php.net/manual/en/function.simplexml-load-string.php
 * @param string $data 
 * A well-formed XML string
 * 
 * @param string|null $class_name [optional] 
 * You may use this optional parameter so that
 * simplexml_load_string will return an object of
 * the specified class. That class should extend the
 * SimpleXMLElement class.
 * 
 * @param int $options [optional] 
 * Since PHP 5.1.0 and Libxml 2.6.0, you may also use the
 * options parameter to specify additional Libxml parameters.
 * 
 * @param string $namespace_or_prefix [optional] 
 * Namespace prefix or URI.
 * 
 * @param bool $is_prefix [optional] 
 * TRUE if ns is a prefix, FALSE if it's a URI;
 * defaults to FALSE.
 * 
 * @return SimpleXMLElement|false an object of class SimpleXMLElement with
 * properties containing the data held within the xml document, or FALSE on failure.
 */
function simplexml_load_string(string $data, ?string $class_name = "SimpleXMLElement", int $options = 0, string $namespace_or_prefix = "", bool $is_prefix = false): SimpleXMLElement|false {}

/**
 * Get a SimpleXMLElement object from a DOM node.
 * @link https://php.net/manual/en/function.simplexml-import-dom.php
 * @param SimpleXMLElement|DOMNode $node 
 * A DOM Element node
 * 
 * @param string|null $class_name [optional] 
 * You may use this optional parameter so that
 * simplexml_import_dom will return an object of
 * the specified class. That class should extend the
 * SimpleXMLElement class.
 * 
 * @return SimpleXMLElement|null a SimpleXMLElement or FALSE on failure.
 */
function simplexml_import_dom(SimpleXMLElement|DOMNode $node, ?string $class_name = "SimpleXMLElement"): ?SimpleXMLElement {}

// End of SimpleXML v.0.1