bavix / advanced-html-dom

src/AdvancedHtmlDom/AdvancedHtmlBase.php

<?php

namespace Bavix\AdvancedHtmlDom;

class AdvancedHtmlBase
{

    /**
     * @var
     */
    public $doc;

    /**
     * @var
     */
    public $dom;

    /**
     * @var
     */
    public $node;

    /**
     * @var bool
     */
    public $is_text = false;

    /**
     * @see https://github.com/monkeysuffrage/advanced_html_dom/issues/19
     */
    public function __destruct()
    {
        $this->doc = $this->dom = $this->node = null;
        unset($this->doc, $this->dom, $this->node);
        Cleanup::all();
    }

    /**
     * @return string
     */
    public function __toString()
    {
        return (string)$this->html();
    }

    /**
     * @return mixed
     */
    public function html()
    {
        return $this->doc->dom->saveXML($this->node);
    }

    /**
     * @return $this
     */
    public function remove()
    {
        $this->node->parentNode->removeChild($this->node);

        return $this;
    }

    /**
     * @return Str
     */
    public function str()
    {
        return new Str($this->text);

The property text does not exist on Bavix\AdvancedHtmlDom\AdvancedHtmlBase. Since you implemented __get, consider adding a @property annotation.

    }

    /**
     * @param $re
     *
     * @return bool
     */
    public function match($re)
    {
        $str = new Str($this->text);

The property text does not exist on Bavix\AdvancedHtmlDom\AdvancedHtmlBase. Since you implemented __get, consider adding a @property annotation.

        return $str->match($re);
    }

    /**
     * @param $re
     *
     * @return mixed
     */
    public function scan($re)
    {
        $str = new Str($this->text);

The property text does not exist on Bavix\AdvancedHtmlDom\AdvancedHtmlBase. Since you implemented __get, consider adding a @property annotation.

        return $str->scan($re);
    }

    /**
     * @param $str
     *
     * @return string
     */
    public function clean($str)
    {
        return $this->trim(\preg_replace('/\s+/', ' ', $str));
    }

    /**
     * @param $str
     *
     * @return string
     */
    public function trim($str)
    {
        return \trim($str);
    }

    /**
     * @param $key
     * @param $args
     *
     * @return AHTMLNode[]|AHTMLNodeList|null
     */
    public function __call($key, $args)
    {
        $key = \strtolower(\str_replace('_', '', $key));
        switch ($key) {
            case 'innertext':
                return ($this->is_text || !$this->children->length) ? $this->text() : $this->find('./text()|./*')->outertext;

The property length does not exist on Bavix\AdvancedHtmlDom\AHTMLNodeList. Since you implemented __get, consider adding a @property annotation.

The property outertext does not exist on Bavix\AdvancedHtmlDom\AHTMLNodeList. Since you implemented __get, consider adding a @property annotation.

The property children does not exist on Bavix\AdvancedHtmlDom\AdvancedHtmlBase. Since you implemented __get, consider adding a @property annotation.

            case 'plaintext':
                return $this->text();
            case 'outertext':
            case 'html':
            case 'save':
                return $this->html();
            case 'innerhtml':
                $ret = '';
                foreach ($this->node->childNodes as $child) {
                    $ret .= $this->doc->dom->saveHTML($child);
                }

                return $ret;

            case 'tag':
                return $this->node->nodeName;
            case 'next':
                return $this->at('./following-sibling::*[1]|./following-sibling::text()[1]|./following-sibling::comment()[1]');

The method at() does not exist on Bavix\AdvancedHtmlDom\AdvancedHtmlBase. Since you implemented __call, consider adding a @method annotation.

            case 'index':
                return $this->search('./preceding-sibling::*')->length + 1;

The method search() does not exist on Bavix\AdvancedHtmlDom\AdvancedHtmlBase. Since you implemented __call, consider adding a @method annotation.

            /*
            DOMNode::insertBefore — Adds a new child
            */

            // simple-html-dom junk methods
            case 'clear':
                return;

            // search functions
            case 'at':
            case 'getelementbytagname':
                return $this->find($args[0], 0);

            case 'search':
            case 'getelementsbytagname':
                return isset($args[1]) ? $this->find($args[0], $args[1]) : $this->find($args[0]);

            case 'getelementbyid':
                return $this->find('#' . $args[0], 0);
            case 'getelementsbyid':
                return isset($args[1]) ? $this->find('#' . $args[0], $args[1]) : $this->find('#' . $args[0]);

            // attributes
            case 'hasattribute':
                return !$this->is_text && $this->node->hasAttribute($args[0]);

            case 'getattribute':
                $arg = $args[0];

                return $this->$arg;
            case 'setattribute':
                $arg0 = $args[0];
                $arg1 = $args[1];

                return $this->$arg0 = $arg1;
            case 'removeattribute':
                $arg = $args[0];

                return $this->$arg = null;

            // wrap
            case 'wrap':
                return $this->replace('<' . $args[0] . '>' . $this . '</' . $args[0] . '>');

The method replace() does not exist on Bavix\AdvancedHtmlDom\AdvancedHtmlBase. Since you implemented __call, consider adding a @method annotation.

            case 'unwrap':
                return $this->parent->replace($this);

The property parent does not exist on Bavix\AdvancedHtmlDom\AdvancedHtmlBase. Since you implemented __get, consider adding a @property annotation.

            case 'str':
                return new Str($this->text);

The property text does not exist on Bavix\AdvancedHtmlDom\AdvancedHtmlBase. Since you implemented __get, consider adding a @property annotation.

            // heirarchy
            case 'firstchild':
                return $this->at('> *');
            case 'lastchild':
                return $this->at('> *:last');
            case 'nextsibling':
                return $this->at('+ *');
            case 'prevsibling':
                return $this->at('./preceding-sibling::*[1]');
            case 'parent':
                return $this->at('./..');
            case 'children':
            case 'childnodes':
                $nl = $this->search('./*');

                return isset($args[0]) ? $nl[$args[0]] : $nl;
            case 'child': // including text/comment nodes
                $nl = $this->search('./*|./text()|./comment()');

                return isset($args[0]) ? $nl[$args[0]] : $nl;

        }

        // $doc->spans[x]
        if (\preg_match(TAGS_REGEX, $key, $m)) {
            return $this->find($m[1]);
        }
        if (\preg_match(TAG_REGEX, $key, $m)) {
            return $this->find($m[1], 0);
        }

        if (\preg_match('/(clean|trim|str)(.*)/', $key, $m) && isset($m[2])) {
            list($arg0, $arg1, $arg2) = $m;

            return $this->$arg1($this->$arg2);
        }

        if (\in_array($key, ['dom', 'node', 'doc'])) {
            return null;
        }

        if (!\preg_match(ATTRIBUTE_REGEX, $key, $m)) {
            \trigger_error('Unknown method or property: ' . $key, E_USER_WARNING);
        }
        if (!$this->node || $this->is_text) {
            return null;
        }

        return $this->node->getAttribute($key);
    }

    /**
     * @return mixed
     */
    public function text()
    {
        return $this->node->nodeValue;
    }

    // magic methods

    /**
     * @param      $css
     * @param null $index

Are you sure the doc-type for parameter $index is correct as it would always require null to be passed?

     *
     * @return array|AHTMLNode|AHTMLNodeList
     */
    public function find($css, $index = null)
    {
        $xpath = CSS::xpath_for($css);

        if (!isset($this->doc, $this->doc->xpath)) {
            return null;
        }

        if (null === $index) {

The condition null === $index is always true.

            return new AHTMLNodeList($this->doc->xpath->query($xpath, $this->node), $this->doc);
        }

        $nl = $this->doc->xpath->query($xpath, $this->node);
        if ($index < 0) {
            $index = $nl->length + $index;
        }
        $node = $nl->item($index);

        return $node ? new AHTMLNode($node, $this->doc) : null;
    }

    /**
     * @param $key
     *
     * @return mixed
     */
    public function __get($key)
    {
        return $this->$key();
    }

    /**
     * @param $name
     * @param $value
     */
    public function __set($name, $value)
    {
        throw new \InvalidArgumentException(__METHOD__);
    }

    /**
     * @param $name
     *
     * @return bool
     */
    public function __isset($name)
    {
        return true;
    }
}