api_nucleus.inc.php File Reference

Go to the source code of this file.

Functions

 f_nucleus_addItem ($m)
 f_nucleus_addDatedItem ($m)
 f_nucleus_editItem ($m)
 f_nucleus_getUsersBlogs ($m)
 f_nucleus_getRecentItems ($m)
 f_nucleus_getItem ($m)
 f_nucleus_deleteItem ($m)
 _getRecentItems ($blogid, $username, $password, $amount)
 _getItem ($itemid, $username, $password)

Variables

 $f_nucleus_addItem_sig
 $f_nucleus_addItem_doc = "Adds a new item to the given blog. Adds it as a draft when publish is false"
 $f_nucleus_addDatedItem_sig
 $f_nucleus_addDatedItem_doc = "Adds a new item to the given blog. Adds it as a draft when publish is false. The timestamp of the item needs to be given as a Unix timestamp"
 $f_nucleus_editItem_sig
 $f_nucleus_editItem_doc = "Edits an item of a blog"
 $f_nucleus_getUsersBlogs_sig
 $f_nucleus_getUsersBlogs_doc = "Returns a list of all the blogs where the given member is on the team"
 $f_nucleus_getRecentItems_sig
 $f_nucleus_getRecentItems_doc = "Returns a maximum of 20 recent items for a given webblog"
 $f_nucleus_getItem_sig
 $f_nucleus_getItem_doc = "Returns an item"
 $f_nucleus_deleteItem_sig
 $f_nucleus_deleteItem_doc = "Deletes an item"
 $functionDefs


Function Documentation

_getItem ( itemid,
username,
password 
)

Returns one item (Nucleus version)

Definition at line 259 of file api_nucleus.inc.php.

References $blogid, $itemid, $manager, _error(), getBlogIDFromItemID(), iso8601_encode(), and removeBreaks().

Referenced by f_nucleus_getItem().

_getRecentItems ( blogid,
username,
password,
amount 
)

Returns a list of recent items (Nucleus Version) ($amount = max 20);

Definition at line 207 of file api_nucleus.inc.php.

References $amount, $blogid, $query, _error(), BLOG::existsID(), iso8601_encode(), mysql_fetch_object(), sql_query(), and sql_table().

Referenced by f_nucleus_getRecentItems().

f_nucleus_addDatedItem ( m  ) 

Definition at line 72 of file api_nucleus.inc.php.

References $blogid, _addDatedItem(), and _getScalar().

f_nucleus_addItem ( m  ) 

Definition at line 41 of file api_nucleus.inc.php.

References $blogid, _addItem(), and _getScalar().

f_nucleus_deleteItem ( m  ) 

Definition at line 194 of file api_nucleus.inc.php.

References $itemid, _deleteItem(), and _getScalar().

f_nucleus_editItem ( m  ) 

Definition at line 103 of file api_nucleus.inc.php.

References $itemid, $manager, _edititem(), _error(), and _getScalar().

f_nucleus_getItem ( m  ) 

Definition at line 175 of file api_nucleus.inc.php.

References _getItem(), and _getScalar().

f_nucleus_getRecentItems ( m  ) 

Definition at line 155 of file api_nucleus.inc.php.

References $amount, $blogid, _getRecentItems(), and _getScalar().

f_nucleus_getUsersBlogs ( m  ) 

Definition at line 136 of file api_nucleus.inc.php.

References _getScalar(), and _getUsersBlogs().


Variable Documentation

$f_nucleus_addDatedItem_doc = "Adds a new item to the given blog. Adds it as a draft when publish is false. The timestamp of the item needs to be given as a Unix timestamp"

Definition at line 71 of file api_nucleus.inc.php.

$f_nucleus_addDatedItem_sig

Initial value:

 array(array(
                        // return type
                        $xmlrpcString,  // itemid of the new item

                        // params:
                        $xmlrpcString,  // blogid
                        $xmlrpcString,  // username
                        $xmlrpcString,  // password
                        $xmlrpcString,  // title
                        $xmlrpcString,  // body
                        $xmlrpcString,  // extended part
                        $xmlrpcBoolean, // publish boolean (set to false to create draft)
                        $xmlrpcBoolean, // closed boolean (set to true to disable comments)
                        $xmlrpcInt      // item time (unix timestamp)

                ))

Definition at line 55 of file api_nucleus.inc.php.

$f_nucleus_addItem_doc = "Adds a new item to the given blog. Adds it as a draft when publish is false"

Definition at line 40 of file api_nucleus.inc.php.

$f_nucleus_addItem_sig

Initial value:

 array(array(
                        // return type
                        $xmlrpcString,  // itemid of the new item

                        // params:
                        $xmlrpcString,  // blogid
                        $xmlrpcString,  // username
                        $xmlrpcString,  // password
                        $xmlrpcString,  // title
                        $xmlrpcString,  // body
                        $xmlrpcString,  // extended part
                        $xmlrpcBoolean, // publish boolean (set to false to create draft)
                        $xmlrpcBoolean, // closed boolean (set to true to disable comments)

                ))
This file contains definitions for the functions in the Nucleus API

NOTE: These functions are deprecated and will most likely be removed!

http://nucleuscms.org/license.txt GNU General Public License Copyright (C) 2002-2007 The Nucleus Group

Version:
Id
api_nucleus.inc.php 1116 2007-02-03 08:24:29Z kimitake
NucleusJP
api_nucleus.inc.php,v 1.6 2007/02/04 06:28:46 kimitake Exp

Definition at line 25 of file api_nucleus.inc.php.

$f_nucleus_deleteItem_doc = "Deletes an item"

Definition at line 193 of file api_nucleus.inc.php.

$f_nucleus_deleteItem_sig

Initial value:

 array(array(
                        // return type
                        $xmlrpcBoolean, // boolean (ok or not ok)

                        // params
                        $xmlrpcString,  // itemid
                        $xmlrpcString,  // username
                        $xmlrpcString,  // password
                ))

Definition at line 184 of file api_nucleus.inc.php.

$f_nucleus_editItem_doc = "Edits an item of a blog"

Definition at line 102 of file api_nucleus.inc.php.

$f_nucleus_editItem_sig

Initial value:

 array(array(
                        // return type
                        $xmlrpcBoolean, // true or false

                        // params:
                        $xmlrpcString,  // itemid
                        $xmlrpcString,  // username
                        $xmlrpcString,  // password
                        $xmlrpcString,  // title
                        $xmlrpcString,  // body
                        $xmlrpcString,  // extended part
                        $xmlrpcBoolean, // publish boolean (set to false if you want a draft to stay draft)
                        $xmlrpcBoolean, // closed boolean (set to true to disable comments)
                ))

Definition at line 88 of file api_nucleus.inc.php.

$f_nucleus_getItem_doc = "Returns an item"

Definition at line 174 of file api_nucleus.inc.php.

$f_nucleus_getItem_sig

Initial value:

 array(array(
                        // return type
                        $xmlrpcStruct,  // A struct representing the item

                        // params
                        $xmlrpcString,  // itemid
                        $xmlrpcString,  // username
                        $xmlrpcString,  // password
                ))

Definition at line 165 of file api_nucleus.inc.php.

$f_nucleus_getRecentItems_doc = "Returns a maximum of 20 recent items for a given webblog"

Definition at line 154 of file api_nucleus.inc.php.

$f_nucleus_getRecentItems_sig

Initial value:

 array(array(
                        // return type
                        $xmlrpcArray,   // array of strucs (representing items)

                        // params
                        $xmlrpcString,  // blogid
                        $xmlrpcString,  // username
                        $xmlrpcString,  // password
                        $xmlrpcInt,     // amount of items to return (max = 20)
                ))

Definition at line 144 of file api_nucleus.inc.php.

$f_nucleus_getUsersBlogs_doc = "Returns a list of all the blogs where the given member is on the team"

Definition at line 135 of file api_nucleus.inc.php.

$f_nucleus_getUsersBlogs_sig

Initial value:

 array(array(
                        // return type
                        $xmlrpcArray,   // array containing structs containing blog info

                        // params:
                        $xmlrpcString,  // username
                        $xmlrpcString,  // password
                ))

Definition at line 127 of file api_nucleus.inc.php.

$functionDefs

Definition at line 301 of file api_nucleus.inc.php.



Generated on Wed Jun 25 17:25:59 2008 by  doxygen 1.5.5