Net_WebFinger
[ class tree: Net_WebFinger ] [ index: Net_WebFinger ] [ all elements ]
Packages:
Net_WebFinger


Classes:
Net_WebFinger
Net_WebFinger_Error
Net_WebFinger_Reaction
Files:
custom-http-adapter.php
Error.php
Reaction.php
webfinger-cli.php
WebFinger.php

Class: Net_WebFinger_Reaction

Source Location: /Net_WebFinger-0.3.0/src/Net/WebFinger/Reaction.php

Class Overview

XML_XRD
   |
   --Net_WebFinger_Reaction

The reaction (=result) of a (web)finger action.


Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 59]
The reaction (=result) of a (web)finger action.

Returned by Net_WebFinger::finger().

Usage examples:

Check if the data have been exchanged in a secure manner: 

  1.  if (!$react->secure) {
    2. 

  2.      die("Be suspicious! Data may not be trusted.\n");
    3. 

  3.  }
    4.

Get the OpenID of the user: 

  1.  if ($react->openid) {
    2. 

  2.      echo 'The user\'s OpenID is ' . $react->openid . "\n";
    3. 

  3.  }
    4.

Other short names are

  • contacts (Portable Contacts)
  • hcard
  • profile
  • xfn
Access any relation by their URL: 
  1.  $foo = $react->get('http://this.is.some.foo/#spec');
    2. 

  2.  if ($foo !== null) {
    3. 

  3.      //do something
    4. 

  4.  }
    5.



[ Top ]

Class Variables

$error =

[line 80]

Message describing the error that occured during fingering.

When no error happened, this variable is NULL.

A webfinger error object is an exception, so you can use 

  1. $react->error->getMessage()
    2.
to get the error.

To get the reason for the error, an error object may have an encapsulated exception: 

  1.  if ($react->error->getPrevious()) {
    2. 

  2.      echo 'Reason for this error: '
    3. 

  3.      . $react->error->getPrevious()->getMessage()) . "\n";
    4. 

  4.  }
    5.

  • Access: public

Type:   Net_WebFinger_Error


[ Top ]

$secure =  true

[line 94]

If the WebFinger result has been obtained from secure sources.

There might be a man-in-the-middle attack if it is not secure.

The result is considered secure when the XRD files have been obtained via HTTPS or the files were signed with XML signatures.

Also, the XRD files need to have the correct subject (or alias) set.

  • Access: public

Type:   boolean


[ Top ]

$shortNameMap = array(
        'contacts' => 'http://portablecontacts.net/spec/1.0',
        'hcard'    => 'http://microformats.org/profile/hcard',
        'openid'   => 'http://specs.openid.net/auth/2.0/provider',
        'profile'  => 'http://webfinger.net/rel/profile-page',
        'xfn'      => 'http://gmpg.org/xfn/11',
    )

[line 111]

Provides short names for common link relations.

Keys in this array may be used as class variable.


Type:   array


[ Top ]

$url =

[line 101]

URL from which the data have been fetched
  • Access: public

Type:   string


[ Top ]


Method Detail

__get   [line 150]

string __get( string $variable)

Easy property access to common link relations.

Parameters:

string   $variable   —   Requested class variable

[ Top ]

__isset   [line 134]

boolean __isset( string $variable)

Check if a given short name exists.

If it exists, you can use e.g. 

  1. $react->openid
    2.
to get the openid URL. Note that this only checks if the short variable name exists, not if the variable has a value.


Parameters:

string   $variable   —   Requested class variable

[ Top ]
Documentation generated on Sat, 04 May 2013 12:30:03 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.