====== AJAXEdit Plugin ======

---- plugin ----
description: Helper-Framework for easy ajax editing for other plugins
author     : lisps, peterfromearth
email      : coder@peterfromearth.de
type       : helper,action
lastupdate : 2021-10-24
compatible : Hogfather
depends    : 
conflicts  : 
similar    : 
tags       : ajax

downloadurl: https://github.com/lisps/ajaxedit/zipball/master
bugtracker : https://github.com/lisps/ajaxedit/issues
sourcerepo : https://github.com/lisps/ajaxedit/
donationurl: 

screenshot_img : 
----
 
===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Examples/Usage =====
:!: **This is only a helper framework** used currently by [[plugin:multiselect]], [[plugin:rowmove]], [[plugin:likeit]] and [[plugin:datepicker]]

==== JavaScript Functions ====
<code javascript>
/**
 * ajaxedit_send is a wrapper for jQuery's post function 
 * it automatically adds the current pageid, lastmod and the security token
 * 
 * @param string   plugin plugin name
 * @param int      idx_tag the id counter
 * @param function fcnSuccess callback function
 * @param hash     data additional data
 */
function ajaxedit_send(plugin,idx_tag,fcnSuccess,data)

/**
 * ajaxedit_parse is a simple function which parses the json response
 * 
 * @param json   data
 * @return mixed false if there is no data/ the response
 */
function ajaxedit_parse(data)

/**
 * ajaxedit_checkResponse checks if the server error flag is set and displays a jQuery Dialog, with the Message
 * 
 * @param  hash    response the parsed @see ajaxedit_parse server response 
 * @return boolean false on error
 */
function ajaxedit_checkResponse(response)
</code>

==== PHP Fuctions ====
<code php>
/**
 * error throw an error and leave
 * @param string $msg 
 * @param integer $type error type 
 * @param boolean $exit leave or not
 **/
function error($msg,$type=self::ERROR_OTHER,$exit = true)

/**
 * getWikiPage returns the raw wiki data
 * @return string
 */
function getWikiPage()

/**
 * success sends the success message
 * automatically sends error,msg,lastmod,index(id counter) 
 *
 * @param array $data additional data
 */
function success($data=array())

/**
 * saveWikiPage saves the wiki page
 * 
 * @param string $data wiki page
 * @param string $summary
 * @param boolean $minor 
 * @param array $param will go to @see success
 * @param boolean $autosubmit if set will call success
 */
function saveWikiPage($data,$summary,$minor = false,$param=array(),$autosubmit=true)
</code>
===== Configuration and Settings =====
no configuration needed, yet.


===== Development =====


=== Change Log ===


[[https://travis-ci.org/lisps/ajaxedit|{{  https://travis-ci.org/lisps/ajaxedit.png?nocache|Build Status}}]]

{{rss>https://github.com/lisps/ajaxedit/commits/master.atom date}}

=== Known Bugs and Issues ===


=== ToDo/Wish List ===
  * More languages
  * ...

===== FAQ =====
This is only a helper/framework plugin

===== Discussion =====