XML_FOAF
[ class tree: XML_FOAF ] [ index: XML_FOAF ] [ all elements ]

Class: XML_FOAF

Source Location: XML/FOAF.php

Class Overview

XML_FOAF_Common
   |
   --XML_FOAF

FOAF Creator


Author(s):

Version:

  • 0.2

Copyright:

  • Copyright 2003 Davey Shafik and Synaptic Media. All Rights Reserved.

Variables

Methods


Inherited Variables

Inherited Methods

Class: XML_FOAF_Common

XML_FOAF_Common::isAllowedForAgent()
Check if a property is allows for the current foaf:Agent

Class Details

[line 40]
FOAF Creator



Tags:

todo:  Implement PEAR_Error handling
example:  Basic Usage of XML_FOAF
copyright:  Copyright 2003 Davey Shafik and Synaptic Media. All Rights Reserved.
version:  0.2
author:  Davey <mailto:davey@php.net>


[ Top ]


Class Variables

$children = array()

[line 59]



Tags:

var:  Contains XML_Tree Child nodes for all FOAF elements

Type:   array


[ Top ]

$foaf =  null

[line 47]



Tags:

var:  object containing the FOAF RDF/XML Tree

Type:   object XML_Tree


[ Top ]

$namespaces = array()

[line 53]



Tags:

var:  Contains all namespaces in use

Type:   array


[ Top ]

$xml_tree =  null

[line 65]



Tags:

var:  object for the FOAF

Type:   object XML_Tree


[ Top ]



Class Methods


constructor XML_FOAF [line 82]

XML_FOAF XML_FOAF( )

XML_FOAF PHP4 Compatible Constructor



Tags:

see:  XML_FOAF::__construct


[ Top ]

method addAimChatID [line 373]

void addAimChatID( string $aim_chat_id)

Add a foaf:aimChatID element



Tags:

link:  FOAF Specification - foaf:aimChatID
access:  public
foafstatus:  testing


Parameters:

string   $aim_chat_id   An AIM Username

[ Top ]

method addChild [line 990]

boolean addChild( mixed &$xml_tree)

Add an XML_Tree, XML_Tree_Node object or XML String to the FOAF



Tags:

access:  public


Parameters:

mixed   $xml_tree   XML_Tree, XML_Tree_Node or XML String

[ Top ]

method addCurrentProject [line 819]

boolean addCurrentProject( string $uri)

Add a foaf:currentProject element



Tags:

link:  FOAF Specification - foaf:currentProject
access:  public
foafstatus:  testing
todo:  Return a PEAR_Error instead of false


Parameters:

string   $uri   URI to a current projects homepage

[ Top ]

method addDepiction [line 148]

void addDepiction( string $uri)

Add a foaf:depiction element



Tags:

link:  FOAF Specification - foaf:depiction
access:  public
foafstatus:  Testing


Parameters:

string   $uri   URI For the Depicted image

[ Top ]

method addFundedBy [line 163]

void addFundedBy( string $uri)

Add a foaf:fundedBy element



Tags:

link:  FOAF Specification - foaf:fundedBy
access:  public
foafstatus:  Unstable


Parameters:

string   $uri   URI for the funder

[ Top ]

method addHomepage [line 545]

void addHomepage( string $uri)

Add a foaf:homepage element



Tags:

link:  FOAF Specification - foaf:homepage
access:  public
foafstatus:  stable


Parameters:

string   $uri   URI for the Homepage

[ Top ]

method addIcqChatID [line 388]

void addIcqChatID( string $icq_chat_id)

Add a foaf:icqChatID element



Tags:

link:  FOAF Specification - foaf:icqChatID
access:  public
foafstatus:  testing


Parameters:

string   $icq_chat_id   An ICQ Number

[ Top ]

method addImg [line 698]

boolean addImg( string $uri)

Add a foaf:img element



Tags:

link:  FOAF Specification - foaf:img
access:  public
foafstatus:  testing
todo:  Return a PEAR_Error instead of false


Parameters:

string   $uri   URI for the img being depicted

[ Top ]

method addInterest [line 888]

boolean addInterest( string $uri)

Add a foaf:interest element



Tags:

link:  http://xmlns.com/foaf/0.1/#term_interest
access:  public
foafstatus:  testing
todo:  Return a PEAR_Error instead of false


Parameters:

string   $uri   URI with Info about the Interest

[ Top ]

method addJabberID [line 358]

void addJabberID( mixed $jabber_id, string $jabbed_id)

Add a foaf:jabberID element



Tags:

link:  FOAF Specification - foaf:jabberID
access:  public
foafstatus:  testing


Parameters:

string   $jabbed_id   A Jabber ID

[ Top ]

method addKnows [line 975]

boolean &addKnows( object &$foaf_agent)

set a foaf:knows



Tags:

link:  FOAF Specification - foaf:knows
access:  public
foafstatus:  testing


Parameters:

object   $foaf_agent   XML_FOAF Object for the foaf:knows Agent

[ Top ]

method addLogo [line 178]

void addLogo( string $uri)

Add a foaf:logo element



Tags:

link:  FOAF Specification - foaf:logo
access:  public
foafstatus:  Testing


Parameters:

string   $uri   URI for Logo Image

[ Top ]

method addMade [line 574]

void addMade( string $uri)

Add a foaf:made element



Tags:

link:  http://xmlns.com/foaf/0.1/#term_made
access:  public
foafstatus:  testing


Parameters:

string   $uri   URI for the thing foaf:Agent made

[ Top ]

method addMbox [line 300]

void addMbox( string $mbox, [boolean $sha1 = false], [boolean $is_sha1_hash = false])

Add a foaf:mbox or foaf:mbox_sha1sum element



Tags:

link:  FOAF Specification - foaf:mbox
link:  FOAF Specification - foaf:mbox_sha1sum
see:  XML_FOAF::setMboxSha1Sum
access:  public
foafstatus:  testing


Parameters:

string   $mbox   Mailbox, either a mailto:addr, addr or an sha1 sum of mailto:addr
boolean   $sha1   Whether or not to use foaf:mbox_sha1sum
boolean   $is_sha1_hash   Whether or not given $mbox is already an sha1 sum

[ Top ]

method addMboxSha1Sum [line 328]

void addMboxSha1Sum( string $mbox, [mixed $is_sha1_sum = false], boolean $is_sha1_hash)

Add a foaf:mbox_sha1sum element



Tags:

link:  FOAF Specification - foaf:mbox_sha1sum
access:  public
foafstatus:  testing


Parameters:

string   $mbox   Mailbox, either a mailto:addr, addr or an sha1 sum of mailto:addr
boolean   $is_sha1_hash   Whether or not given $mbox is already an sha1 sum

[ Top ]

method addMember [line 909]

boolean &addMember( object &$foaf_agent)

Add a foaf:member element



Tags:

link:  FOAF Specification - foaf:member
access:  public
foafstatus:  unstable
todo:  Return a PEAR_Error instead of false


Parameters:

object   $foaf_agent   XML_FOAF object (with a foaf:agent set)

[ Top ]

method addMsnChatID [line 418]

void addMsnChatID( string $msn_chat_id)

Add a foaf:msnChatID element



Tags:

link:  FOAF Specification - foaf:msnChatID
access:  public
foafstatus:  testing


Parameters:

string   $msn_chat_id   A MSN Chat username

[ Top ]

method addMyersBriggs [line 719]

boolean addMyersBriggs( string $myers_briggs)

Add a foaf:myersBriggs elements



Tags:

link:  FOAF Specification - foaf:myersBriggs
link:  Myers Briggs - Working out your type
access:  public
foafstatus:  testing
todo:  Return a PEAR_Error instead of false


Parameters:

string   $myers_briggs   Myers Briggs Personality classification

[ Top ]

method addNick [line 248]

void addNick( string $nick)

Add a foaf:nick element



Tags:

link:  FOAF Specification - foaf:nick
access:  public
foafstatus:  testing


Parameters:

string   $nick   foaf:Agents Nickname

[ Top ]

method addOnlineAccount [line 440]

void addOnlineAccount( string $account_name, [string $account_service_homepage = null], [mixed $account_type = null], string $acount_type)

Add a foaf:OnlineAccount element



Tags:

link:  FOAF Specification - foaf:accountName
link:  FOAF Specification - foaf:OnlineAccount
link:  FOAF Specification - foaf:holdsAccount
link:  FOAF Specification - foaf:accountServiceHomepage
see:  XML_FOAF::setYahooChatID, XML_FOAF::setJabberID, XML_FOAF::setOnlineGamingAccount, XML_FOAF::setOnlineEcommerceAccount
access:  public
see:  XML_FOAF::setOnlineChatAccount, XML_FOAF::setMsnChatID, XML_FOAF::setIcqChatID, XML_FOAF::setAimChatID
foafstatus:  unstable


Parameters:

string   $account_name   Account Name
string   $account_service_homepage   URI to Account Service Homepage
string   $acount_type   Account type (e.g http://xmlns.com/foaf/0.1/OnlineChatAccount)

[ Top ]

method addOnlineChatAccount [line 470]

void addOnlineChatAccount( string $account_name, string $account_service_homepage)

Add a foaf:OnlineChatAccount element



Tags:

link:  FOAF Specification - foaf:accountName
link:  FOAF Specification - foaf:OnlineChatAccount
link:  FOAF Specification - foaf:holdsAccount
link:  FOAF Specification - foaf:accountServiceHomepage
see:  XML_FOAF::setYahooChatID, XML_FOAF::setJabberID, XML_FOAF::setOnlineGamingAccount, XML_FOAF::setOnlineEcommerceAccount
access:  public
see:  XML_FOAF::setOnlineAccount, XML_FOAF::setMsnChatID, XML_FOAF::setIcqChatID, XML_FOAF::setAimChatID
foafstatus:  unstable


Parameters:

string   $account_name   Account Name
string   $account_service_homepage   URI Tto Account Service Homepage

[ Top ]

method addOnlineEcommerceAccount [line 524]

void addOnlineEcommerceAccount( string $account_name, string $account_service_homepage)

Add a foaf:OnlineEcommerceAccount element



Tags:

link:  FOAF Specification - foaf:accountName
link:  FOAF Specification - foaf:OnlineChatAccount
link:  FOAF Specification - foaf:holdsAccount
link:  FOAF Specification - foaf:accountServiceHomepage
see:  XML_FOAF::setYahooChatID, XML_FOAF::setJabberID, XML_FOAF::setOnlineChatAccount, XML_FOAF::setOnlineGamingAccount
access:  public
see:  XML_FOAF::setOnlineAccount, XML_FOAF::setMsnChatID, XML_FOAF::setIcqChatID, XML_FOAF::setAimChatID
foafstatus:  unstable


Parameters:

string   $account_name   Account Name
string   $account_service_homepage   URI Tto Account Service Homepage

[ Top ]

method addOnlineGamingAccount [line 497]

void addOnlineGamingAccount( string $account_name, string $account_service_homepage)

Add a foaf:OnlineGamingAccount element



Tags:

link:  FOAF Specification - foaf:accountName
link:  FOAF Specification - foaf:OnlineChatAccount
link:  FOAF Specification - foaf:holdsAccount
link:  FOAF Specification - foaf:accountServiceHomepage
see:  XML_FOAF::setYahooChatID, XML_FOAF::setJabberID, XML_FOAF::setOnlineChatAccount, XML_FOAF::setOnlineEcommerceAccount
access:  public
see:  XML_FOAF::setOnlineAccount, XML_FOAF::setMsnChatID, XML_FOAF::setIcqChatID, XML_FOAF::setAimChatID
foafstatus:  unstable


Parameters:

string   $account_name   Account Name
string   $account_service_homepage   URI Tto Account Service Homepage

[ Top ]

method addPage [line 195]

void addPage( string $document_uri, [string $title = null], [string $description = null])

Add a foaf:page element



Tags:

link:  FOAF Specification - foaf:page
access:  public
foafstatus:  Testing


Parameters:

string   $document_uri   URI for the Document being reference
string   $title   Title for the Document
string   $description   Description for the Document

[ Top ]

method addPastProject [line 839]

boolean addPastProject( string $uri)

Add a foaf:pastProject element



Tags:

link:  FOAF Specification - foaf:pastProject
access:  public
foafstatus:  testing
todo:  Return a PEAR_Error instead of false


Parameters:

string   $uri   URI to a past projects homepage

[ Top ]

method addPhone [line 278]

void addPhone( string $phone)

Add a foaf:phone element



Tags:

link:  FOAF Specification - foaf:phone
access:  public
foafstatus:  testing


Parameters:

string   $phone   foaf:Agents Phone Number

[ Top ]

method addPublications [line 799]

boolean addPublications( string $uri)

Add a foaf:publications elements



Tags:

link:  FOAF Specification - foaf:publications
access:  public
foafstatus:  unstable
todo:  Return a PEAR_Error instead of false


Parameters:

string   $uri   URI to the publications

[ Top ]

method addSchoolHomepage [line 779]

boolean addSchoolHomepage( string $uri)

Add a foaf:schoolHomepage element



Tags:

link:  FOAF Specification - foaf:schoolHomepage
access:  public
foafstatus:  testing
todo:  Return a PEAR_Error instead of false


Parameters:

string   $uri   URI for School Homepage

[ Top ]

method addSeeAlso [line 960]

boolean addSeeAlso( string $uri)

set rdfs:seeAlso



Tags:

link:  RDF Schema Specification - rdfs:seeAlso
access:  public


Parameters:

string   $uri   URI for the resource

[ Top ]

method addTheme [line 218]

void addTheme( string $uri)

Add a foaf:theme element



Tags:

link:  FOAF Specification - foaf:theme
access:  public
foafstatus:  unstable


Parameters:

string   $uri   URI for the Theme

[ Top ]

method addWeblog [line 560]

void addWeblog( string $uri)

Add a foaf:weblog element



Tags:

link:  FOAF Specification - foaf:weblog
access:  public
foafstatus:  testing


Parameters:

string   $uri   URI for the weblog

[ Top ]

method addWorkInfoHomepage [line 759]

boolean addWorkInfoHomepage( string $uri)

Add a foaf:workInfoHomepage element



Tags:

link:  FOAF Specification - foaf:workInfoHomepage
access:  public
foafstatus:  testing
todo:  Return a PEAR_Error instead of false


Parameters:

string   $uri   URI for Work Information Homepage

[ Top ]

method addWorkplaceHomepage [line 739]

boolean addWorkplaceHomepage( string $uri)

Add a foaf:workplaceHome element



Tags:

link:  FOAF Specification - foaf:workplaceHomepage
access:  public
foafstatus:  testing
todo:  Return a PEAR_Error instead of false


Parameters:

string   $uri   URI for the Workplace Homepage

[ Top ]

method addXmlns [line 1069]

boolean addXmlns( string $qualifier, string $uri)

Set an XML Namespace



Tags:

access:  public


Parameters:

string   $qualifier   XML Namespace qualifier
string   $uri   XML Namespace URI

[ Top ]

method addYahooChatID [line 403]

void addYahooChatID( string $yahoo_chat_id)

Add a foaf:yahooChatID element



Tags:

link:  FOAF Specification - foaf:yahooChatID
access:  public
foafstatus:  testing


Parameters:

string   $yahoo_chat_id   A Yahoo! Messenger ID

[ Top ]

method dump [line 1019]

boolean dump( [boolean $without_rdf = false])

Echo the FOAF RDF/XML tree



Tags:

access:  public


Parameters:

boolean   $without_rdf   Ouput RDF/XML inside <rdf:RDF> root elements

[ Top ]

method get [line 1054]

string get( [boolean $without_rdf = false])

Alias for toXML



Tags:

access:  public


Parameters:

boolean   $without_rdf   Return RDF/XML inside <rdf:RDF> root element

[ Top ]

method newAgent [line 100]

void newAgent( [string $agent_type = 'Person'])

Create new FOAF Agent



Tags:



Parameters:

string   $agent_type   Agent type, this can be Person, Organization, Group, Agent.

[ Top ]

method setBasedNear [line 863]

boolean setBasedNear( float $geo_lat, float $geo_long)

set foaf:basedNear



Tags:

link:  GeoInfo Wiki
link:  Using foaf:based_near
link:  An RDF Geo Vocabulary: Point/lat/long/alt
link:  FOAF Specification - foaf:basedNear
foafstatus:  unstable
access:  public
todo:  Return a PEAR_Error instead of false


Parameters:

float   $geo_lat   Latitute for the geo:Point
float   $geo_long   Longitude for the geo:Point

[ Top ]

method setFamilyName [line 658]

boolean setFamilyName( string $family_name)

set foaf:familyName



Tags:

link:  FOAF Specification - foaf:familyName
access:  public
foafstatus:  testing
todo:  Return a PEAR_Error instead of false


Parameters:

string   $family_name   foaf:Agents Family name

[ Top ]

method setFirstName [line 618]

boolean setFirstName( string $first_name)

set foaf:firstName



Tags:

link:  FOAF Specification - foaf:firstName
see:  XML_FOAF::setGivenName, XML_FOAF::setName
access:  public
foafstatus:  testing
todo:  Return a PEAR_Error instead of false


Parameters:

string   $first_name   foaf:Agents First Name

[ Top ]

method setGeekcode [line 597]

boolean setGeekcode( string $geek_code)

set foaf:geekcode



Tags:

link:  Geek Code official website
link:  FOAF Specification - foaf:geekcode
link:  Geek Code Generator
access:  public
foafstatus:  testing
todo:  Return a PEAR_Error instead of false


Parameters:

string   $geek_code   foaf:Agents Geek Code

[ Top ]

method setGender [line 343]

void setGender( string $gender)

set foaf:gender



Tags:

link:  FOAF Specification - foaf:gender
access:  public
foafstatus:  testing


Parameters:

string   $gender   foaf:Agents Gender (typically 'male' or 'female')

[ Top ]

method setGivenName [line 263]

void setGivenName( string $given_name)

set foaf:givenname



Tags:

link:  FOAF Specification - foaf:givenname
access:  public
foafstatus:  testing


Parameters:

string   $given_name   foaf:Agents Given Name

[ Top ]

method setMembershipClass [line 931]

boolean setMembershipClass( mixed &$membership_class)

Set foaf:membershipClass



Tags:

link:  FOAF Specification - foaf:membershipClass
access:  public
foafstatus:  unstable
todo:  Return a PEAR_Error instead of false


Parameters:

mixed   $membership_class   XML String or XML_Tree/XML_Tree_Node object

[ Top ]

method setName [line 133]

void setName( string $name)

Set the foaf:name of the Agent



Tags:

todo:  Allow for the xml:lang to be specified
link:  FOAF Specification - foaf:name
access:  public
foafstatus:  Testing


Parameters:

string   $name   Name for the Agent.

[ Top ]

method setPlan [line 678]

boolean setPlan( string $plan)

set foaf:plan



Tags:

link:  FOAF Specification - foaf:plan
access:  public
foafstatus:  testing
todo:  Return a PEAR_Error instead of false


Parameters:

string   $plan   .plan file contents

[ Top ]

method setSurname [line 638]

boolean setSurname( string $surname)

set foaf:surname



Tags:

link:  FOAF Specification - foaf:surname
access:  public
foafstatus:  testing
todo:  Return a PEAR_Error instead of false


Parameters:

string   $surname   foaf:Agents Surname

[ Top ]

method setTitle [line 233]

void setTitle( string $title)

set foaf:title



Tags:

link:  FOAF Specification - foaf:title
access:  public
foafstatus:  testing


Parameters:

string   $title   foaf:Agents title

[ Top ]

method toXML [line 1033]

string toXML( [boolean $without_rdf = false])

Return the FOAF RDF/XML tree



Tags:

access:  public


Parameters:

boolean   $without_rdf   Return RDF/XML inside <rdf:RDF> root element

[ Top ]

method _getXmlns [line 1081]

string _getXmlns( )

Return XML Namespaces as xml attributes



Tags:

access:  private


[ Top ]

method _setXmlns [line 1097]

void _setXmlns( )

Set default XML Namespaces



Tags:

access:  private


[ Top ]

method __construct [line 72]

void __construct( )

XML_FOAF Constructor



Tags:

access:  private


[ Top ]


Documentation generated on Thu, 15 Jan 2004 19:03:08 +0000 by phpDocumentor 1.2.3