indieweb/representative-h-card

0.1.3 2023-05-24 15:33 UTC

This package is auto-updated.

Last update: 2024-10-24 18:31:35 UTC


README

Build Status Packagist

Given a parsed mf2 document, return the representative h-card for the page.

Installation

Install via composer:

{
  "indieweb/representative-h-card": "0.1.*"
}

Or just require the one file:

require_once('src/mf2/representative-h-card.php');

Usage

This function accepts a PHP array in the format returned by the microformats2 parser.

$url = 'http://aaronparecki.com/';
$html = file_get_contents($url);
$parsed = Mf2\parse($html, $url);
$representative = Mf2\HCard\representative($parsed, $url);
print_r($representative);

The function will find the representative h-card (according to the representative h-card parsing rules) and will return the h-card that is found.

Array
(
    [type] => Array
        (
            [0] => h-card
        )
    [properties] => Array
        (
            [name] => Array
                (
                    [0] => Aaron Parecki
                )
            [photo] => Array
                (
                    [0] => http://aaronparecki.com/images/aaronpk.png
                )
            [url] => Array
                (
                    [0] => http://aaronparecki.com/
                )
            [uid] => Array
                (
                    [0] => http://aaronparecki.com/
                )
        )
)