Net::Yadis 1.0

Net::Yadis is a Perl module that performs the Yadis service discovery protocol, and parses XRDS xml documents.<br /><br />Methods<br /><br />discover<br /><br />This constructor performs the discovery protocol on a url and returns a yadis object that parses the XRDS document for you.<br /><br /> eval {<br /> $yadis=Net::Yadis->discover($url);<br /> }<br /> warn "Yadis failed: $@" if $@;<br /><br />Will die on errors: HTTP errors, missing Yadis magic, malformed XRDS<br /><br />new<br /><br />You may also skip discovery and go straight to xrds parsing with the new constructor.<br /><br /> $yadis = Net::Yadis->new($yadis_url, $xrds_url, $xml);<br /><br />$yadis_url<br /><br /> the identity URL<br /><br />$xrds_url<br /><br /> where we got the xrds document<br /><br />$xml<br /><br /> the XRDS xml as text<br /><br />We don't trap death from XML::XPath; malformed xml causes this<br /><br />Accessor methods<br /><br />xml<br /><br /> The XML text of the XRDS document.<br /><br />url<br /><br /> The Yadis URL.<br /><br />xrds_url<br /><br /> The URL where the XRDS document was found.<br /><br />xrds_xpath<br /><br />The XML::XPath object used internally is made available to allow custom XPath queries.<br /><br />services<br /><br />An array of Net::Yadis::Service objects representing the services advertised in the XRDS file.<br /><br />filter_services<br /><br />Pass in a filter function reference to this guy. The filter function must take a Net::Yadis::Service object, and return a scalar of some sort or undef. The scalars returned from the filter will be returned in an array from this method.<br /><br />Example<br /><br /> my $filter = sub {<br /> my $service = shift;<br /> if ($service->is_type($typere)) {<br /> # here we simply return the service object, but you may return<br /> # something else if you wish to extract the data and discard<br /> # the xpath object contained in the service object.<br /> return $service;<br /> }<br /> else {<br /> return undef;<br /> }<br /> };<br /><br /> my $typeservices = $yadis->filter_services($filter);<br /><br />services_of_type<br /><br />A predefined filtering method that takes a regexp for filtering service types.<br /><br />service_of_type<br /><br />Hey, a perl generator! sequential calls will return the services one at a time, in ascending priority order with ties randomly decided. make sure that the type argument is identical for each call, or the list will start again from the top. You'll have to store the yadis object in a session for this guy to be useful.<br />

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	Array,  Discovery,  Document,  Filter,  Filtering,  Function,  Malformed,  Object,  Protocol,  Return,  Returned,  Service,  Services,  Undef,  Urlxrds Url,  Xmlxpath,  Yadis
Users rating:	0/10