Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

atomServer Class Reference

List of all members.

Detailed Description

An data server, atom & xslt powered.

todo (because it's only a version 0.1) :

Author:
Yoan Blanc <greut [at] altern.org>
Version:
0.1 040625

Definition at line 37 of file atomServer.class.php.

Public Member Functions

 atomServer ($data, $urlbase)
 Constructeur du Serveur Atom.

 getUserData ($login='')
 The user's informations.

 getAllUsersData ()
 The users' informations.

 setUserData ($data)
 Update an user.

 addUser ($data)
 Add an user to users' list.

 delUser ($login)
 Remove an user for the list.

 getEntry ($login, $entry_id)
 Return an entry.

 getXhtmlEntry ($login, $entry_id)
 Return an entry.

 getEntryData ($login, $entry_id)
 Return an entry.

 addEntryData ($login, $data)
 Add an entry.

 setEntryData ($login, $entry_id, $data)
 Update an entry.

 setEntry ($login, $entry_id, $xml)
 Update an entry.

 __setEntry ($login, $entry_id, $xml)
 [private method] Update an entry.

 addEntry ($login, $xml)
 Add an entry.

 __addEntry ($login, $entry_id, $xml)
 Write on the disk the new entry.

 __addEntrytoFeed ($login, $entry_id)
 [private method] Add an entry to the user's feed

 delEntry ($login, $entry_id)
 Delete an entry.

 __delEntryToFeed ($login, $entry_id)
 [private method] Remove an entry from the user's feed

 getFeed ($login, $quantity=10)
 Return the user's feed.

 getXhtmlFeed ($login, $quantity=10)
 Return the user's feed.

 getRss091Feed ($login, $quantity=10)
 Return the user's feed.

 getFeedData ($login, $start=0, $quantity=10)
 Return the user's feed.

 getXhtmlArchives ($login, $date)
 Get archives.

 getIntrospection ($login)
 Get instrospection file.

 __getXsltResult ($xml, $xsl, $param=NULL)
 [private method] Return the result of a XSLT transformation

 __XsltTransform ($xml, $xsl, $param=NULL)
 [private method] Apply a transformation


Public Attributes

 $xslt
 tranformations tool

 $data
 path to this class

 $urlbase
 url of the server

 $atomid
 atom:id base

 $xml
 xml files

 $xsl
 xsl files for php, xml, xhtml, rss output

 $init
 initial files for entry and feed


Constructor & Destructor Documentation

atomServer::atomServer data,
urlbase
 

Constructeur du Serveur Atom.

Parameters:
$data relative path to this file
$urlbase url of the website

Definition at line 62 of file atomServer.class.php.

References $data, $urlbase, entry, feed, and user.


Member Function Documentation

atomServer::__addEntry login,
entry_id,
xml
 

Write on the disk the new entry.

Parameters:
$login user's login
$entry_id entry's id
$xml new entry (local atom format)
Returns:
true if ok

Definition at line 437 of file atomServer.class.php.

References __addEntry(), and file_put_contents().

Referenced by __addEntry(), addEntry(), and addEntryData().

atomServer::__addEntrytoFeed login,
entry_id
 

[private method] Add an entry to the user's feed

Parameters:
$login user's login
$entry_id entry's id
Returns:
true if ok

Definition at line 473 of file atomServer.class.php.

References __addEntrytoFeed(), __getXsltResult(), entry, feed, and file_put_contents().

Referenced by __addEntrytoFeed().

atomServer::__delEntryToFeed login,
entry_id
 

[private method] Remove an entry from the user's feed

Parameters:
$login user's login
$entry_id entry's id
Returns:
true if ok

Definition at line 512 of file atomServer.class.php.

References __delEntryToFeed(), __getXsltResult(), entry, feed, and file_put_contents().

Referenced by __delEntryToFeed(), and delEntry().

atomServer::__getXsltResult xml,
xsl,
param = NULL
 

[private method] Return the result of a XSLT transformation

Parameters:
$xml xml file
$xsl stylesheet file
$param transformation parameters
Returns:
result of the transformation

Definition at line 646 of file atomServer.class.php.

References $data, __getXsltResult(), and __XsltTransform().

Referenced by __addEntrytoFeed(), __delEntryToFeed(), __getXsltResult(), addEntry(), addUser(), delUser(), getEntry(), getFeed(), getRss091Feed(), getXhtmlArchives(), getXhtmlEntry(), getXhtmlFeed(), setEntry(), and setUserData().

atomServer::__setEntry login,
entry_id,
xml
 

[private method] Update an entry.

Parameters:
$login user's login
$entry_id entry's id
$xml updated entry (local atom format)
Returns:
true if ok

Definition at line 386 of file atomServer.class.php.

References __setEntry(), and file_put_contents().

Referenced by __setEntry(), setEntry(), and setEntryData().

atomServer::__XsltTransform xml,
xsl,
param = NULL
 

[private method] Apply a transformation

Parameters:
$xml XML file
$xsl stylesheet file
$param transformation parameters

Definition at line 661 of file atomServer.class.php.

References __XsltTransform().

Referenced by __getXsltResult(), and __XsltTransform().

atomServer::addEntry login,
xml
 

Add an entry.

Parameters:
$login user's login
$xml new entry (atom format)
Returns:
true if ok

Definition at line 398 of file atomServer.class.php.

References $atomid, __addEntry(), __getXsltResult(), addEntry(), entry, and file_put_contents().

Referenced by addEntry().

atomServer::addEntryData login,
data
 

Add an entry.

Parameters:
$login user's login
$entry_id entry's id
$data entry data
Returns:
true if ok

Definition at line 291 of file atomServer.class.php.

References $data, $data, __addEntry(), addEntryData(), entry, and user.

Referenced by addEntryData().

atomServer::addUser data  ) 
 

Add an user to users' list.

Parameters:
$data user's information (array)

Definition at line 174 of file atomServer.class.php.

References __getXsltResult(), addUser(), feed, file_put_contents(), and user.

Referenced by addUser().

atomServer::delEntry login,
entry_id
 

Delete an entry.

Parameters:
$login user's login
$entry_id entry's id
Returns:
true if ok

Definition at line 492 of file atomServer.class.php.

References __delEntryToFeed(), and delEntry().

Referenced by delEntry().

atomServer::delUser login  ) 
 

Remove an user for the list.

Parameters:
$login user's login

Definition at line 200 of file atomServer.class.php.

References __getXsltResult(), delUser(), file_put_contents(), and user.

Referenced by delUser().

atomServer::getAllUsersData  ) 
 

The users' informations.

Returns:
users' informations

Definition at line 140 of file atomServer.class.php.

Referenced by getUserData().

atomServer::getEntry login,
entry_id
 

Return an entry.

Parameters:
$login user's login
$entry_id entry's id
Returns:
atom entry

Definition at line 219 of file atomServer.class.php.

References __getXsltResult(), entry, and getEntry().

Referenced by getEntry().

atomServer::getEntryData login,
entry_id
 

Return an entry.

Parameters:
$login user's login
$entry_id entry's id
Returns:
php array entry

Definition at line 262 of file atomServer.class.php.

References getEntryData().

Referenced by getEntryData().

atomServer::getFeed login,
quantity = 10
 

Return the user's feed.

Parameters:
$login user's login
$quantity quantity of entries
Returns:
atom feed

Definition at line 530 of file atomServer.class.php.

References __getXsltResult(), feed, and getFeed().

Referenced by getFeed().

atomServer::getFeedData login,
start = 0,
quantity = 10
 

Return the user's feed.

Parameters:
$login user's login
$start starting entry
$quantity quantity of entries
Returns:
php array feed

Definition at line 591 of file atomServer.class.php.

References getFeedData().

Referenced by getFeedData().

atomServer::getIntrospection login  ) 
 

Get instrospection file.

Parameters:
$login user's login
Returns:
introspection file

Definition at line 633 of file atomServer.class.php.

References getIntrospection().

Referenced by getIntrospection().

atomServer::getRss091Feed login,
quantity = 10
 

Return the user's feed.

Parameters:
$login user's login
$quantity quantity of entries
Returns:
rss 0.91 feed

Definition at line 572 of file atomServer.class.php.

References __getXsltResult(), feed, and getRss091Feed().

Referenced by getRss091Feed().

atomServer::getUserData login = ''  ) 
 

The user's informations.

If $login is empty you've got all the users

Parameters:
$login user's login
Returns:
user's information

Definition at line 114 of file atomServer.class.php.

References getAllUsersData(), and getUserData().

Referenced by getUserData().

atomServer::getXhtmlArchives login,
date
 

Get archives.

Parameters:
$login user's login
$date date of archives ({YYYY}, {YYYY/MM} or {YYYY/MM/DD})
Returns:
xhtml archives

Definition at line 614 of file atomServer.class.php.

References __getXsltResult(), and getXhtmlArchives().

Referenced by getXhtmlArchives().

atomServer::getXhtmlEntry login,
entry_id
 

Return an entry.

Parameters:
$login user's login
$entry_id entry's id
Returns:
xhtml entry

Definition at line 238 of file atomServer.class.php.

References __getXsltResult(), entry, feed, and getXhtmlEntry().

Referenced by getXhtmlEntry().

atomServer::getXhtmlFeed login,
quantity = 10
 

Return the user's feed.

Parameters:
$login user's login
$quantity quantity of entries
Returns:
xhtml feed

Definition at line 548 of file atomServer.class.php.

References __getXsltResult(), feed, and getXhtmlFeed().

Referenced by getXhtmlFeed().

atomServer::setEntry login,
entry_id,
xml
 

Update an entry.

Parameters:
$login user's login
$entry_id entry's id
$xml updated entry (atom format)
Returns:
true if ok

Definition at line 349 of file atomServer.class.php.

References $atomid, $info, __getXsltResult(), __setEntry(), entry, file_put_contents(), and setEntry().

Referenced by setEntry().

atomServer::setEntryData login,
entry_id,
data
 

Update an entry.

Parameters:
$login user's login
$entry_id entry's id
$data entry's data
Returns:
true if ok

Definition at line 323 of file atomServer.class.php.

References $data, __setEntry(), and setEntryData().

Referenced by setEntryData().

atomServer::setUserData data  ) 
 

Update an user.

Parameters:
$data user's information (array)

Definition at line 158 of file atomServer.class.php.

References __getXsltResult(), file_put_contents(), setUserData(), and user.

Referenced by setUserData().


Member Data Documentation

atomServer::$atomid
 

atom:id base

Definition at line 46 of file atomServer.class.php.

Referenced by addEntry(), and setEntry().

atomServer::$data
 

path to this class

Definition at line 42 of file atomServer.class.php.

Referenced by __getXsltResult(), addEntryData(), atomServer(), and setEntryData().

atomServer::$init
 

initial files for entry and feed

Definition at line 54 of file atomServer.class.php.

atomServer::$urlbase
 

url of the server

Definition at line 44 of file atomServer.class.php.

Referenced by atomServer().

atomServer::$xml
 

xml files

Definition at line 49 of file atomServer.class.php.

atomServer::$xsl
 

xsl files for php, xml, xhtml, rss output

Definition at line 51 of file atomServer.class.php.

atomServer::$xslt
 

tranformations tool

Definition at line 40 of file atomServer.class.php.


The documentation for this class was generated from the following file:
Generated on Fri Jun 25 00:00:23 2004 for a(tom)Blog by doxygen 1.3.7