Difference between revisions of "representative-hcard-parsing"

From Microformats Wiki
representative-hcard-parsing
Jump to navigation Jump to search
m (Reverted edits by Jfm1991 (Talk) to last version by Tantek)
(needs update for microformats2)
Line 1: Line 1:
 
<entry-title>representative hCard parsing</entry-title>
 
<entry-title>representative hCard parsing</entry-title>
 +
 +
----
 +
NEEDS UPDATE for [[microformats2]] [[h-card]].
 +
----
  
 
Assuming you are already using code that properly implements [[hcard-parsing]], this page documents how to determine a [[representative hCard]] for a page using the current [[representative-hcard-brainstorming]] proposal.
 
Assuming you are already using code that properly implements [[hcard-parsing]], this page documents how to determine a [[representative hCard]] for a page using the current [[representative-hcard-brainstorming]] proposal.

Revision as of 07:22, 6 October 2014

<entry-title>representative hCard parsing</entry-title>


NEEDS UPDATE for microformats2 h-card.


Assuming you are already using code that properly implements hCard parsing, this page documents how to determine a representative hCard for a page using the current representative-hcard-brainstorming proposal.

representative hCard algorithm

After parsing the page:

  1. url uid source. The first hCard found which has a "url" property whose value is the url of the page (source) and is also a "uid" property for the hCard, is the representative hCard for the page.
  2. url and rel me. If the previous step didn't find a representative hCard, then the first hCard with a "url" property that also has the rel="me" relation is the representative hCard for the page.

open source implementations

The below open source implementations of representative hCard parsing have been contributed inline and are thus in the public domain per Microformats_Wiki:Copyrights.

Draft hKit (PHP5) code

I - (Tom) - have been working on implementing represenative hCard parsing in PHP so that a user can simply type in a URL pointing to a page with an hCard on it, and have their name and some details automatically filled in the form. The code below implements the following:

  1. If there is only one hCard on a page, it uses that.
  2. If there is more than one hCard on a page, it looks through to see if any of the cards have UID or URL fields that match the URL it searches, then selects that one if one exists.

It's experimental and quite 'alpha', so I'd suggest you test it and make adjustments as necessary.

<?php
// example hKit code to extract a representative hCard
// tom morris <http://tommorris.org>
// public domain 2007

// An hCard could have more than one url, so we use a multi-dimensional array search. - Sarven Capadisli

// From http://nl2.php.net/manual/en/function.array-search.php#80692
function multidimArrayLocate($array, $text){
  foreach($array as $key => $arrayValue){
    if (is_array($arrayValue)){
      if ($key == $text) $arrayResult[$key] = $arrayValue;
      $temp[$key] = multidimArrayLocate($arrayValue, $text);
      if ($temp[$key]) $arrayResult[$key] = $temp[$key];
    }
    else{
      if ($key == $text) $arrayResult[$key] = $arrayValue;
    }
  }
  return $arrayResult;
}

include("hkit.class.php");
$hkit = new hKit;
$result = $hkit->getByURL('hcard', $HTTP_GET_VARS['url']);
if (count($result) != 0) {
  if (count($result) == 1) {
    $repcard = $result[0];
  } else {
    foreach ($result as $card) {
      if (multidimArrayLocate($card, $HTTP_GET_VARS['url']) == true || $card['uid'] == $HTTP_GET_VARS['url']) {
        $repcard = $card;
      }
    }
  }
}
print_r($repcard);
?>

jQuery (JavaScript) code

The following JavaScript code follows the current proposal for finding a representative hCard. It requires the jQuery library, however, it can be easily switched over to another library.

  • If a vCard has a class="url" and class="uid" with an href value same as the source URI (current document), then that vCard is a representative hCard candidate, otherwise;
  • If a vCard has a class="url" and a rel="me" on the same element, then that vCard is a representative hCard candidate, otherwise;
  • There is no representative hCard.
  • Grab the first hCard from the list of candidates.
/***
    Note: Extracts representative hCard
    Author: Sarven Capadisli http://csarven.ca/
    License: Public Domain 2009-06-04
*/
var sourceURI = window.location.href;
var rep_hCard = new Array();

function rep_hCard_uidurlsource() {
    $('.vcard .uid[href='+sourceURI+']').each(function() {
        $(this).each(function() {
            if ($(this).closest('.vcard').find('.url[href='+sourceURI+']').length > 0) {
                rep_hCard.push($(this).closest('.vcard')[0]);
            }
        });
    });
    return (rep_hCard.length > 0) ? true : false;
}

function rep_hCard_urlme() {
    $('.vcard .url[rel=me]').each(function() {
        rep_hCard.push($(this).closest('.vcard')[0]);
    });
    return (rep_hCard.length > 0) ? true : false;
}

if (rep_hCard_uidurlsource() || rep_hCard_urlme()) {
    rep_hCard = $($(rep_hCard)[0]); 
    rep_hCard_url = (rep_hCard.find('.uid').length > 0) ? rep_hCard.find('.uid')[0].href : rep_hCard.find('.url[rel=me]')[0].href;
    hCard_fn = $('.fn', rep_hCard).text();
    hCard_photo_src = ($('.photo', rep_hCard).length > 0) ? $('.photo', rep_hCard)[0].src : '';
}
else {
    //no representative hCard
}

--Sarven Capadisli 04:24, 4 June 2009 (UTC)

see also