b2evolution

Multilingual multiuser multiblog engine

b2evolution Technical Documentation (CVS HEAD) [ class tree: evocore ] [ index: evocore ] [ all elements ]

Procedural File: _xmlrpcs.funcs.php

Source Location: /blogs/inc/xmlrpc/model/_xmlrpcs.funcs.php

Page Details
Copyright:  Edd Dumbill <edd@usefulinc.com> (C) 1999-2002
See:  http://xmlrpc.usefulinc.com/doc/
See:  http://phpxmlrpc.sourceforge.net/
Filesource:  Source Code for this file
Functions
logIO  [line 31]

boolean logIO( $msg, [ $newline = false]  )

Used for logging, only if $debug_xmlrpc_logging is true

Parameters:
   $msg: 
   $newline: 

API Tags:
Return:  Have we logged?


[ Top ]
starify  [line 59]

string starify( string $string  )

Returns a string replaced by stars, for passwords.

Parameters:
string   $string:  the source string

API Tags:
Return:  same length, but only stars


[ Top ]
xmlrpcs_can_view_item  [line 824]

boolean xmlrpcs_can_view_item( object The &$Item, object The &$current_User  )

Check that an User can view a specific Item.

Parameters:
object The   &$Item:  Item (by reference).
object The   &$current_User:  User (by reference).

API Tags:
Return:  True if permission granted, false otherwise.


[ Top ]
xmlrpcs_check_cats  [line 861]

boolean xmlrpcs_check_cats( integer &$maincat, object The &$Blog, array &$extracats  )

Check whether the main category and the extra categories are valid in a Blog's context and try to fix errors.

Parameters:
integer   &$maincat:  The main category to check (by reference).
object The   &$Blog:  Blog to which the category is supposed to belong to (by reference).
array   &$extracats:  Extra categories for the post (by reference).

API Tags:
Return:  False on error (use xmlrpcs_resperror() to return it), true on success.

Information Tags:
Author:  Tilman BLUMENBACH / Tblue

[ Top ]
xmlrpcs_edit_item  [line 762]

xmlrpcmsg xmlrpcs_edit_item( Item &$edited_Item, string $post_title, string $content, string $post_date, integer $main_cat, array $cat_IDs, string $status, [NULL|string $tags = NULL]  )

Edit an Item and return an XML-RPC response

Parameters:
Item   &$edited_Item: 
string   $post_title:  HTML
string   $content:  HTML
string   $post_date:  date
integer   $main_cat:  main category
array   $cat_IDs:  of integers : extra categories
string   $status:  status
NULL|string   $tags:  Tags (NULL to leave tags unchanged)


[ Top ]
xmlrpcs_get_Blog  [line 546]

Blog &xmlrpcs_get_Blog( xmlrpcmsg $m, integer $blog_param  )

Get current Blog for an XML-RPC request.

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
integer   $blog_param:  idx of blog param

API Tags:
Return:  or NULL


[ Top ]
xmlrpcs_get_Item  [line 584]

Blog &xmlrpcs_get_Item( xmlrpcmsg $m, integer $postid_param  )

Get current Item for an XML-RPC request.

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
integer   $postid_param:  idx of postid param

API Tags:
Return:  or NULL


[ Top ]
xmlrpcs_login  [line 495]

User &xmlrpcs_login( xmlrpcmsg $m, integer $login_param, integer $pass_param  )

Get current_User for an XML-RPC request - Includes login (password) check.

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
integer   $login_param:  idx of login param in XML-RPC Message
integer   $pass_param:  idx of pass param in XML-RPC Message

API Tags:
Return:  or NULL


[ Top ]
xmlrpcs_new_item  [line 687]

xmlrpcmsg xmlrpcs_new_item( string $post_title, string $content, string $post_date, integer $main_cat, array $cat_IDs, string $status, [string $tags = ''], [string $allow_comments = 'open'], [string $excerpt = '']  )

Create a new Item and return an XML-RPC response

Parameters:
string   $post_title:  HTML
string   $content:  HTML
string   $post_date:  date
integer   $main_cat:  main category
array   $cat_IDs:  of integers : extra categories
string   $status:  status
string   $tags:  Tags
string   $allow_comments:  Comment status. See Item::$comment_status.
string   $excerpt:  Excerpt


[ Top ]
xmlrpcs_resperror  [line 621]

xmlrpcresp xmlrpcs_resperror( [integer $errcode = NULL], [string $errmsg = NULL]  )

If no errcode or errmsg given, will use the last one that has been set previously.

Parameters:
integer   $errcode: 
string   $errmsg: 


[ Top ]
_b2_or_mt_get_categories  [line 422]

xmlrpcresp _b2_or_mt_get_categories( string $type, xmlrpcmsg $m  )

Helper for b2_getcategories() and mt_getPostCategories(), because they differ only in the "categoryId" case ("categoryId" (b2) vs "categoryID" (MT))

Parameters:
string   $type:  Type, either "b2" or "mt"
xmlrpcmsg   $m:  XML-RPC Message
  1. blogid (string): Unique identifier of the blog to query
  2. username (string): Login for a Blogger user who is member of the blog.
  3. password (string): Password for said username.

API Tags:
Return:  XML-RPC Response


[ Top ]
_mw_blogger_deletepost  [line 80]

xmlrpcresp _mw_blogger_deletepost( xmlrpcmsg $m  )

blogger.deletePost deletes a given post.

This API call is not documented on http://www.blogger.com/developers/api/1_docs/

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
  1. appkey (string): Unique identifier/passcode of the application sending the post. (See access info http://www.blogger.com/developers/api/1_docs/#access .)
  2. postid (string): Unique identifier of the post to be deleted.
  3. username (string): Login for a Blogger user who has permission to edit the given post (either the user who originally created it or an admin of the blog).
  4. password (string): Password for said username.

API Tags:
Return:  XML-RPC Response
See:  http://www.sixapart.com/developers/xmlrpc/blogger_api/bloggerdeletepost.html


[ Top ]
_wp_mw_getcategories  [line 129]

void _wp_mw_getcategories( xmlrpcmsg $m  )

metaWeblog.getCategories

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
  1. blogid (string): Unique identifier of the blog the post will be added to. Currently ignored in b2evo, in favor of the category.
  2. username (string): Login for a Blogger user who has permission to edit the given post (either the user who originally created it or an admin of the blog).
  3. password (string): Password for said username.

API Tags:
See:  metawebloggetcategories


[ Top ]
_wp_mw_newmediaobject  [line 218]

xmlrpcresp _wp_mw_newmediaobject( xmlrpcmsg $m  )

metaWeblog.newMediaObject image upload wp.uploadFile

image is supplied coded in the info struct as bits

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
  1. blogid (string): Unique identifier of the blog the post will be added to. Currently ignored in b2evo, in favor of the category.
  2. username (string): Login for a Blogger user who has permission to edit the given post (either the user who originally created it or an admin of the blog).
  3. password (string): Password for said username.
  4. struct (struct) - name : filename - type : mimetype - bits : base64 encoded file

API Tags:
Return:  XML-RPC Response
See:  metaweblognewmediaobject
See:  wp.uploadFile

Information Tags:
Todo:  do not overwrite existing pics with same name
Todo:  extensive permissions

[ Top ]
_wp_or_blogger_getusersblogs  [line 359]

void _wp_or_blogger_getusersblogs( $type, $m  )
Parameters:
   $type: 
   $m: 


[ Top ]


Documentation generated on Sat, 06 Mar 2010 04:28:56 +0100 by phpDocumentor 1.4.2. This site is hosted and maintained by Daniel HAHLER (Contact).