From b96199531c54ebc8fe78f1b65976c1a5b21ffeb7 Mon Sep 17 00:00:00 2001
From: tbrehm <t.brehm@ispconfig.org>
Date: Tue, 04 Dec 2012 11:35:57 -0500
Subject: [PATCH] Implemented: FS#2511 - add examples of database user functions to remote function library docs
---
remoting_client/API-docs/sites_database_user_update.html | 31 ++++++
remoting_client/examples/sites_database_add.php | 6
remoting_client/API-docs/sites_database_add.html | 5
remoting_client/API-docs/sites_database_user_delete.html | 29 +++++
remoting_client/API-docs/navigation.html | 4
remoting_client/API-docs/sites_database_user_add.html | 31 ++++++
remoting_client/API-docs/sites_database_user_get.html | 29 +++++
remoting_client/examples/sites_database_user_update.php | 42 ++++++++
remoting_client/examples/sites_database_user_add.php | 39 +++++++
remoting_client/examples/sites_database_user_get.php | 34 ++++++
remoting_client/examples/sites_database_user_delete.php | 36 +++++++
11 files changed, 283 insertions(+), 3 deletions(-)
diff --git a/remoting_client/API-docs/navigation.html b/remoting_client/API-docs/navigation.html
index 0c6254f..27f9f24 100644
--- a/remoting_client/API-docs/navigation.html
+++ b/remoting_client/API-docs/navigation.html
@@ -205,6 +205,10 @@
<p><a href="sites_database_get.html" target="content">sites_database_get</a></p>
<p><a href="sites_database_get_all_by_user.html" target="content">sites_database_get_all_by_user</a></p>
<p><a href="sites_database_update.html" target="content">sites_database_update</a></p>
+<p><a href="sites_database_user_add.html" target="content">sites_database_user_add</a></p>
+<p><a href="sites_database_user_delete.html" target="content">sites_database_user_delete</a></p>
+<p><a href="sites_database_user_get.html" target="content">sites_database_user_get</a></p>
+<p><a href="sites_database_user_update.html" target="content">sites_database_user_update</a></p>
<p><a href="sites_ftp_user_add.html" target="content">sites_ftp_user_add</a></p>
<p><a href="sites_ftp_user_delete.html" target="content">sites_ftp_user_delete</a></p>
<p><a href="sites_ftp_user_get.html" target="content">sites_ftp_user_get</a></p>
diff --git a/remoting_client/API-docs/sites_database_add.html b/remoting_client/API-docs/sites_database_add.html
index eeaf79d..411f75d 100644
--- a/remoting_client/API-docs/sites_database_add.html
+++ b/remoting_client/API-docs/sites_database_add.html
@@ -22,11 +22,14 @@
<p class="margin"> server_id (<span class="paratype">int(11)</span>)</p>
<p class="margin"> type (<span class="paratype">varchar(16)</span>)</p>
<p class="margin"> database_name (<span class="paratype">varchar(64)</span>)</p>
-<p class="margin"> database_user (<span class="paratype">varchar(64)</span>)</p>
+<p class="margin"> database_user_id (<span class="paratype">int(11)</span>)</p>
+<p class="margin"> database_ro_user_id (<span class="paratype">int(11)</span>)</p>
<p class="margin"> database_password (<span class="paratype">varchar(64)</span>)</p>
<p class="margin"> database_charset (<span class="paratype">varchar(64)</span>)</p>
<p class="margin"> remote_access (<span class="paratype">enum('n','y')</span>)</p>
<p class="margin"> remote_ips (<span class="paratype">text</span>)</p>
+<p class="margin"> backup_interval (<span class="paratype">varchar(255)</span>)</p>
+<p class="margin"> backup_copies (<span class="paratype">int(11)</span>)</p>
<p class="margin"> active (<span class="paratype">enum('n','y')</span>)</p>
<p class="headgrp">Output: </p>
<p class="margin"> Returns the ID of the newly added database.</p>
diff --git a/remoting_client/API-docs/sites_database_user_add.html b/remoting_client/API-docs/sites_database_user_add.html
new file mode 100644
index 0000000..86adf8f
--- /dev/null
+++ b/remoting_client/API-docs/sites_database_user_add.html
@@ -0,0 +1,31 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html><head><title>ISPCOnfig 3 remote API documentation</title>
+
+
+
+
+
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" type="text/css" href="definitionen.css">
+ <style type="text/css">
+ </style></head>
+
+<body>
+<div style="padding:40px">
+<h1>sites_database_user_add(<span class="var">$session_id</span>, <span class="var">$client_id</span>, <span class="var">$params</span>);</h1>
+<br>
+<p class="headgrp">Description: </p>
+<p class="margin"> Adds a new database user.</p><br>
+<p class="headgrp">Input Variables: </p>
+<p class="margin"> <span class="var">$session_id</span>, <span class="var">$client_id</span>, <span class="var">$params</span></p>
+<p class="headgrp">Parameters (in <span class="var">$params</span>): </p>
+<p class="margin"> server_id (<span class="paratype">int(11)</span>)</p>
+<p class="margin"> database_user (<span class="paratype">varchar(64)</span>)</p>
+<p class="margin"> database_password (<span class="paratype">varchar(64)</span>)</p>
+<p class="headgrp">Output: </p>
+<p class="margin"> Returns the ID of the newly added database.</p>
+<!--<b>Output:</b>
+<p style="margin-left:100px">Gives a record of </p> -->
+</div>
+
+</body></html>
diff --git a/remoting_client/API-docs/sites_database_user_delete.html b/remoting_client/API-docs/sites_database_user_delete.html
new file mode 100644
index 0000000..1123f32
--- /dev/null
+++ b/remoting_client/API-docs/sites_database_user_delete.html
@@ -0,0 +1,29 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html><head><title>ISPCOnfig 3 remote API documentation</title>
+
+
+
+
+
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" type="text/css" href="definitionen.css">
+ <style type="text/css">
+ </style></head>
+
+<body>
+<div style="padding:40px">
+<h1>sites_database_user_delete(<span class="var">$session_id</span>, <span class="var">$primary_id</span>);</h1>
+<br>
+<p class="headgrp">Description: </p>
+<p class="margin"> Deletes a database user.</p><br>
+<p class="headgrp">Input Variables: </p>
+<p class="margin"> <span class="var">$session_id</span>, <span class="var">$primary_id</span></p>
+<p class="headgrp">Parameters (in <span class="var">$params</span>): </p>
+<p class="margin">None</p>
+<p class="headgrp">Output: </p>
+<p class="margin"> Returns the number of deleted records.</p>
+<!--<b>Output:</b>
+<p style="margin-left:100px">Gives a record of </p> -->
+</div>
+
+</body></html>
diff --git a/remoting_client/API-docs/sites_database_user_get.html b/remoting_client/API-docs/sites_database_user_get.html
new file mode 100644
index 0000000..c93c03b
--- /dev/null
+++ b/remoting_client/API-docs/sites_database_user_get.html
@@ -0,0 +1,29 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html><head><title>ISPCOnfig 3 remote API documentation</title>
+
+
+
+
+
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" type="text/css" href="definitionen.css">
+ <style type="text/css">
+ </style></head>
+
+<body>
+<div style="padding:40px">
+<h1>sites_database_user_get(<span class="var">$session_id</span>, <span class="var">$primary_id</span>);</h1>
+<br>
+<p class="headgrp">Description: </p>
+<p class="margin"> Retrieves information about a database.</p><br>
+<p class="headgrp">Input Variables: </p>
+<p class="margin"> <span class="var">$session_id</span>, <span class="var">$primary_id</span></p>
+<p class="headgrp">Parameters (in <span class="var">$params</span>): </p>
+<p class="margin"> None</p>
+<p class="headgrp">Output: </p>
+<p class="margin"> Returns all fields and values of the chosen database.</p>
+<!--<b>Output:</b>
+<p style="margin-left:100px">Gives a record of </p> -->
+</div>
+
+</body></html>
diff --git a/remoting_client/API-docs/sites_database_user_update.html b/remoting_client/API-docs/sites_database_user_update.html
new file mode 100644
index 0000000..2df9b30
--- /dev/null
+++ b/remoting_client/API-docs/sites_database_user_update.html
@@ -0,0 +1,31 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html><head><title>ISPCOnfig 3 remote API documentation</title>
+
+
+
+
+
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" type="text/css" href="definitionen.css">
+ <style type="text/css">
+ </style></head>
+
+<body>
+<div style="padding:40px">
+<h1>sites_database_user_update(<span class="var">$session_id</span>, <span class="var">$client_id</span>, <span class="var">$primary_id</span>, <span class="var">$params</span>);</h1>
+<br>
+<b>Description: </b>
+<p class="margin"> Updates a database.</p><br>
+<b>Input Variables: </b>
+<p class="margin"> <span class="var">$session_id</span>, <span class="var">$client_id</span>, <span class="var">$primary_id</span>, <span class="var">$params</span></p>
+<b>Parameters (in <span style= "color:#A17FFF">$params</span>): </b>
+<p class="margin"> server_id (<span class="paratype">int(11)</span>)</p>
+<p class="margin"> database_name (<span class="paratype">varchar(64)</span>)</p>
+<p class="margin"> database_password (<span class="paratype">varchar(64)</span>)</p>
+<b>Output: </b>
+<p class="margin"> Returns the number of affected rows.</p>
+<!--<b>Output:</b>
+<p style="margin-left:100px">Gives a record of </p> -->
+</div>
+
+</body></html>
diff --git a/remoting_client/examples/sites_database_add.php b/remoting_client/examples/sites_database_add.php
index 26ed3e6..f3ddc29 100644
--- a/remoting_client/examples/sites_database_add.php
+++ b/remoting_client/examples/sites_database_add.php
@@ -20,11 +20,13 @@
'server_id' => 1,
'type' => 'mysql',
'database_name' => 'db_name2',
- 'database_user' => 'db_name2',
- 'database_password' => 'db_name2',
+ 'database_user_id' => '1',
+ 'database_ro_user_id' => '0',
'database_charset' => 'UTF8',
'remote_access' => 'y',
'remote_ips' => '',
+ 'backup_interval' => 'none',
+ 'backup_copies' => 1,
'active' => 'y'
);
diff --git a/remoting_client/examples/sites_database_user_add.php b/remoting_client/examples/sites_database_user_add.php
new file mode 100644
index 0000000..8dd2e79
--- /dev/null
+++ b/remoting_client/examples/sites_database_user_add.php
@@ -0,0 +1,39 @@
+<?php
+
+require('soap_config.php');
+
+
+$client = new SoapClient(null, array('location' => $soap_location,
+ 'uri' => $soap_uri,
+ 'trace' => 1,
+ 'exceptions' => 1));
+
+
+try {
+ if($session_id = $client->login($username,$password)) {
+ echo 'Logged successfull. Session ID:'.$session_id.'<br />';
+ }
+
+ //* Set the function parameters.
+ $client_id = 1;
+ $params = array(
+ 'server_id' => 1,
+ 'database_user' => 'db_name2',
+ 'database_password' => 'db_name2'
+ );
+
+ $database_id = $client->sites_database_user_add($session_id, $client_id, $params);
+
+ echo "Database ID: ".$database_user_id."<br>";
+
+ if($client->logout($session_id)) {
+ echo 'Logged out.<br />';
+ }
+
+
+} catch (SoapFault $e) {
+ echo $client->__getLastResponse();
+ die('SOAP Error: '.$e->getMessage());
+}
+
+?>
diff --git a/remoting_client/examples/sites_database_user_delete.php b/remoting_client/examples/sites_database_user_delete.php
new file mode 100644
index 0000000..6c82932
--- /dev/null
+++ b/remoting_client/examples/sites_database_user_delete.php
@@ -0,0 +1,36 @@
+<?php
+
+require('soap_config.php');
+
+
+$client = new SoapClient(null, array('location' => $soap_location,
+ 'uri' => $soap_uri,
+ 'trace' => 1,
+ 'exceptions' => 1));
+
+
+try {
+ if($session_id = $client->login($username,$password)) {
+ echo 'Logged successfull. Session ID:'.$session_id.'<br />';
+ }
+
+ //* Parameters
+ $database_user_id = 1;
+
+
+ //* Get the database record
+ $affected_rows = $client->sites_database_user_delete($session_id, $database_user_id);
+
+ echo "Number of records that have been deleted: ".$affected_rows."<br>";
+
+ if($client->logout($session_id)) {
+ echo 'Logged out.<br />';
+ }
+
+
+} catch (SoapFault $e) {
+ echo $client->__getLastResponse();
+ die('SOAP Error: '.$e->getMessage());
+}
+
+?>
diff --git a/remoting_client/examples/sites_database_user_get.php b/remoting_client/examples/sites_database_user_get.php
new file mode 100644
index 0000000..759ed9f
--- /dev/null
+++ b/remoting_client/examples/sites_database_user_get.php
@@ -0,0 +1,34 @@
+<?php
+
+require('soap_config.php');
+
+
+$client = new SoapClient(null, array('location' => $soap_location,
+ 'uri' => $soap_uri,
+ 'trace' => 1,
+ 'exceptions' => 1));
+
+
+try {
+ if($session_id = $client->login($username,$password)) {
+ echo 'Logged successfull. Session ID:'.$session_id.'<br />';
+ }
+
+ //* Set the function parameters.
+ $database_user_id = 1;
+
+ $database_record = $client->sites_database_user_get($session_id, $database_user_id);
+
+ print_r($database_record);
+
+ if($client->logout($session_id)) {
+ echo 'Logged out.<br />';
+ }
+
+
+} catch (SoapFault $e) {
+ echo $client->__getLastResponse();
+ die('SOAP Error: '.$e->getMessage());
+}
+
+?>
diff --git a/remoting_client/examples/sites_database_user_update.php b/remoting_client/examples/sites_database_user_update.php
new file mode 100644
index 0000000..527920d
--- /dev/null
+++ b/remoting_client/examples/sites_database_user_update.php
@@ -0,0 +1,42 @@
+<?php
+
+require('soap_config.php');
+
+
+$client = new SoapClient(null, array('location' => $soap_location,
+ 'uri' => $soap_uri,
+ 'trace' => 1,
+ 'exceptions' => 1));
+
+
+try {
+ if($session_id = $client->login($username,$password)) {
+ echo 'Logged successfull. Session ID:'.$session_id.'<br />';
+ }
+
+ //* Parameters
+ $database_user_id = 1;
+ $client_id = 1;
+
+
+ //* Get the database record
+ $database_user_record = $client->sites_database_user_get($session_id, $database_user_id);
+
+ //* Change password of the database user
+ $database_user_record['database_password'] = 'abcde';
+
+ $affected_rows = $client->sites_database_user_update($session_id, $client_id, $database_user_id, $database_user_record);
+
+ echo "Number of records that have been changed in the database: ".$affected_rows."<br>";
+
+ if($client->logout($session_id)) {
+ echo 'Logged out.<br />';
+ }
+
+
+} catch (SoapFault $e) {
+ echo $client->__getLastResponse();
+ die('SOAP Error: '.$e->getMessage());
+}
+
+?>
--
Gitblit v1.9.1