Auth_OpenID_Parse Klassenreferenz

Öffentliche Methoden
	Auth_OpenID_Parse ()
	tagMatcher ($tag_name, $close_tags=null)
	openTag ($tag_name)
	closeTag ($tag_name)
	htmlBegin ($s)
	htmlEnd ($s)
	headFind ()
	replaceEntities ($str)
	removeQuotes ($str)
	parseLinkAttrs ($html)
	relMatches ($rel_attr, $target_rel)
	linkHasRel ($link_attrs, $target_rel)
	findLinksRel ($link_attrs_list, $target_rel)
	findFirstHref ($link_attrs_list, $target_rel)
Datenfelder
	$_re_flags = "si"
	$_removed_re
	$_tag_expr = "<%s\b(?!:)([^>]*?)(?:\/>|>(.*?)(?:<\/?%s\s*>|\Z))"
	$_attr_find = '\b(\w+)=("[^"]*"|\'[^\']*\'|[^\'"\s\/<>]+)'
	$_open_tag_expr = "<%s\b"
	$_close_tag_expr = "<((\/%s\b)|(%s[^>\/]*\/))>"

---

Ausführliche Beschreibung

Require Auth_OpenID::arrayGet().

Definiert in Zeile 87 der Datei Parse.php.

---

Dokumentation der Elementfunktionen

Auth_OpenID_Parse

(

)

Definiert in Zeile 111 der Datei Parse.php.

    {
        $this->_link_find = sprintf("/<link\b(?!:)([^>]*)(?!<)>/%s",
                                    $this->_re_flags);

        $this->_entity_replacements = array(
                                            'amp' => '&',
                                            'lt' => '<',
                                            'gt' => '>',
                                            'quot' => '"'
                                            );

        $this->_attr_find = sprintf("/%s/%s",
                                    $this->_attr_find,
                                    $this->_re_flags);

        $this->_removed_re = sprintf("/%s/%s",
                                     $this->_removed_re,
                                     $this->_re_flags);

        $this->_ent_replace =
            sprintf("&(%s);", implode("|",
                                      $this->_entity_replacements));
    }

closeTag

(

$

tag_name

)

Definiert in Zeile 161 der Datei Parse.php.

    {
        $expr = sprintf($this->_close_tag_expr, $tag_name, $tag_name);
        return sprintf("/%s/%s", $expr, $this->_re_flags);
    }

findFirstHref	(	$	link_attrs_list,
		$	target_rel
	)

Definiert in Zeile 318 der Datei Parse.php.

    {
        // Return the value of the href attribute for the first link
        // tag in the list that has target_rel as a relationship.
        // XXX: TESTME
        $matches = $this->findLinksRel($link_attrs_list,
                                       $target_rel);
        if (!$matches) {
            return null;
        }
        $first = $matches[0];
        return Auth_OpenID::arrayGet($first, 'href', null);
    }

findLinksRel	(	$	link_attrs_list,
		$	target_rel
	)

Definiert in Zeile 303 der Datei Parse.php.

    {
        // Filter the list of link attributes on whether it has
        // target_rel as a relationship.
        // XXX: TESTME
        $result = array();
        foreach ($link_attrs_list as $attr) {
            if ($this->linkHasRel($attr, $target_rel)) {
                $result[] = $attr;
            }
        }

        return $result;
    }

headFind

(

)

Definiert in Zeile 191 der Datei Parse.php.

    {
        return $this->tagMatcher('head', array('body', 'html'));
    }

htmlBegin

(

$

s

)

Definiert in Zeile 167 der Datei Parse.php.

    {
        $matches = array();
        $result = preg_match($this->openTag('html'), $s,
                             $matches, PREG_OFFSET_CAPTURE);
        if ($result === false || !$matches) {
            return false;
        }
        // Return the offset of the first match.
        return $matches[0][1];
    }

htmlEnd

(

$

s

)

Definiert in Zeile 179 der Datei Parse.php.

    {
        $matches = array();
        $result = preg_match($this->closeTag('html'), $s,
                             $matches, PREG_OFFSET_CAPTURE);
        if ($result === false || !$matches) {
            return false;
        }
        // Return the offset of the first match.
        return $matches[count($matches) - 1][1];
    }

linkHasRel	(	$	link_attrs,
		$	target_rel
	)

Definiert in Zeile 294 der Datei Parse.php.

    {
        // Does this link have target_rel as a relationship?
        // XXX: TESTME
        $rel_attr = Auth_OpeniD::arrayGet($link_attrs, 'rel', null);
        return ($rel_attr && $this->relMatches($rel_attr,
                                               $target_rel));
    }

openTag

(

$

tag_name

)

Definiert in Zeile 155 der Datei Parse.php.

    {
        $expr = sprintf($this->_open_tag_expr, $tag_name);
        return sprintf("/%s/%s", $expr, $this->_re_flags);
    }

parseLinkAttrs

(

$

html

)

Find all link tags in a string representing a HTML document and return a list of their attributes.

Parameter:

string

$html The text to parse

Rückgabe:

array $list An array of arrays of attributes, one for each link tag

Definiert in Zeile 227 der Datei Parse.php.

    {
        $stripped = preg_replace($this->_removed_re,
                                 "",
                                 $html);

        $html_begin = $this->htmlBegin($stripped);
        $html_end = $this->htmlEnd($stripped);

        if ($html_begin === false) {
            return array();
        }

        if ($html_end === false) {
            $html_end = strlen($stripped);
        }

        $stripped = substr($stripped, $html_begin,
                           $html_end - $html_begin);

        // Try to find the <HEAD> tag.
        $head_re = $this->headFind();
        $head_matches = array();
        if (!preg_match($head_re, $stripped, $head_matches)) {
            return array();
        }

        $link_data = array();
        $link_matches = array();

        if (!preg_match_all($this->_link_find, $head_matches[0],
                            $link_matches)) {
            return array();
        }

        foreach ($link_matches[0] as $link) {
            $attr_matches = array();
            preg_match_all($this->_attr_find, $link, $attr_matches);
            $link_attrs = array();
            foreach ($attr_matches[0] as $index => $full_match) {
                $name = $attr_matches[1][$index];
                $value = $this->replaceEntities(
                              $this->removeQuotes($attr_matches[2][$index]));

                $link_attrs[strtolower($name)] = $value;
            }
            $link_data[] = $link_attrs;
        }

        return $link_data;
    }

relMatches	(	$	rel_attr,
		$	target_rel
	)

Definiert in Zeile 279 der Datei Parse.php.

    {
        // Does this target_rel appear in the rel_str?
        // XXX: TESTME
        $rels = preg_split("/\s+/", trim($rel_attr));
        foreach ($rels as $rel) {
            $rel = strtolower($rel);
            if ($rel == $target_rel) {
                return 1;
            }
        }

        return 0;
    }

removeQuotes

(

$

str

)

Definiert in Zeile 204 der Datei Parse.php.

    {
        $matches = array();
        $double = '/^"(.*)"$/';
        $single = "/^\'(.*)\'$/";

        if (preg_match($double, $str, $matches)) {
            return $matches[1];
        } else if (preg_match($single, $str, $matches)) {
            return $matches[1];
        } else {
            return $str;
        }
    }

replaceEntities

(

$

str

)

Definiert in Zeile 196 der Datei Parse.php.

    {
        foreach ($this->_entity_replacements as $old => $new) {
            $str = preg_replace(sprintf("/&%s;/", $old), $new, $str);
        }
        return $str;
    }

tagMatcher	(	$	tag_name,
		$	close_tags = null
	)

Returns a regular expression that will match a given tag in an SGML string.

Definiert in Zeile 140 der Datei Parse.php.

    {
        $expr = $this->_tag_expr;

        if ($close_tags) {
            $options = implode("|", array_merge(array($tag_name), $close_tags));
            $closer = sprintf("(?:%s)", $options);
        } else {
            $closer = $tag_name;
        }

        $expr = sprintf($expr, $tag_name, $closer);
        return sprintf("/%s/%s", $expr, $this->_re_flags);
    }

---

Dokumentation der Datenelemente

$_attr_find = '\b(\w+)=("[^"]*"|\'[^\']*\'|[^\'"\s\/<>]+)'

Definiert in Zeile 106 der Datei Parse.php.

$_close_tag_expr = "<((\/%s\b)|(%s[^>\/]*\/))>"

Definiert in Zeile 109 der Datei Parse.php.

$_open_tag_expr = "<%s\b"

Definiert in Zeile 108 der Datei Parse.php.

$_re_flags = "si"

Specify some flags for use with regex matching.

Definiert in Zeile 92 der Datei Parse.php.

$_removed_re

Initialisierung:

           "<!--.*?-->|<!\[CDATA\[.*?\]\]>|<script\b(?!:)[^>]*>.*?<\/script>"

Stuff to remove before we start looking for tags

Definiert in Zeile 97 der Datei Parse.php.

$_tag_expr = "<%s\b(?!:)([^>]*?)(?:\/>|>(.*?)(?:<\/?%s\s*>|\Z))"

Starts with the tag name at a word boundary, where the tag name is not a namespace

Definiert in Zeile 104 der Datei Parse.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• Auth/OpenID/Parse.php