gitlabFork/ISPConfig3.git - Solinfo Gitblit

parent: 2052e167 | patch | commit | ignore whitespace

Implemented: FS#2511 - add examples of database user functions to remote fu...

tbrehm

2012-12-04 b96199531c54ebc8fe78f1b65976c1a5b21ffeb7

Implemented: FS#2511 - add examples of database user functions to remote function library docs

8 files added

3 files modified

	remoting_client/API-docs/navigation.html	4 ●●●●● patch \| view \| raw \| blame \| history
	remoting_client/API-docs/sites_database_add.html	5 ●●●●● patch \| view \| raw \| blame \| history
	remoting_client/API-docs/sites_database_user_add.html	31 ●●●●● patch \| view \| raw \| blame \| history
	remoting_client/API-docs/sites_database_user_delete.html	29 ●●●●● patch \| view \| raw \| blame \| history
	remoting_client/API-docs/sites_database_user_get.html	29 ●●●●● patch \| view \| raw \| blame \| history
	remoting_client/API-docs/sites_database_user_update.html	31 ●●●●● patch \| view \| raw \| blame \| history
	remoting_client/examples/sites_database_add.php	6 ●●●●● patch \| view \| raw \| blame \| history
	remoting_client/examples/sites_database_user_add.php	39 ●●●●● patch \| view \| raw \| blame \| history
	remoting_client/examples/sites_database_user_delete.php	36 ●●●●● patch \| view \| raw \| blame \| history
	remoting_client/examples/sites_database_user_get.php	34 ●●●●● patch \| view \| raw \| blame \| history
	remoting_client/examples/sites_database_user_update.php	42 ●●●●● patch \| view \| raw \| blame \| history

 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>

 remoting_client/API-docs/sites_database_add.html

@@ -22,11 +22,14 @@
<p class="margin"> server_id&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
<p class="margin"> type&nbsp;&nbsp;(<span class="paratype">varchar(16)</span>)</p>
<p class="margin"> database_name&nbsp;&nbsp;(<span class="paratype">varchar(64)</span>)</p>
<p class="margin"> database_user&nbsp;&nbsp;(<span class="paratype">varchar(64)</span>)</p>
<p class="margin"> database_user_id&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
<p class="margin"> database_ro_user_id&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
<p class="margin"> database_password&nbsp;&nbsp;(<span class="paratype">varchar(64)</span>)</p>
<p class="margin"> database_charset&nbsp;&nbsp;(<span class="paratype">varchar(64)</span>)</p>
<p class="margin"> remote_access&nbsp;&nbsp;(<span class="paratype">enum('n','y')</span>)</p>
<p class="margin"> remote_ips&nbsp;&nbsp;(<span class="paratype">text</span>)</p>
<p class="margin"> backup_interval&nbsp;&nbsp;(<span class="paratype">varchar(255)</span>)</p>
<p class="margin"> backup_copies&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
<p class="margin"> active&nbsp;&nbsp;(<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>

 remoting_client/API-docs/sites_database_user_add.html

New file
@@ -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&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
<p class="margin"> database_user&nbsp;&nbsp;(<span class="paratype">varchar(64)</span>)</p>
<p class="margin"> database_password&nbsp;&nbsp;(<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>

 remoting_client/API-docs/sites_database_user_delete.html

New file
@@ -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>

 remoting_client/API-docs/sites_database_user_get.html

New file
@@ -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>

 remoting_client/API-docs/sites_database_user_update.html

New file
@@ -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&nbsp;&nbsp;(<span class="paratype">int(11)</span>)</p>
<p class="margin"> database_name&nbsp;&nbsp;(<span class="paratype">varchar(64)</span>)</p>
<p class="margin"> database_password&nbsp;&nbsp;(<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>

 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'
            );
    

 remoting_client/examples/sites_database_user_add.php

New file
@@ -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());
}

?>

 remoting_client/examples/sites_database_user_delete.php

New file
@@ -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());
}

?>

 remoting_client/examples/sites_database_user_get.php

New file
@@ -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());
}

?>

 remoting_client/examples/sites_database_user_update.php

New file
@@ -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());
}

?>

			@@ -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>

			@@ -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>

New file
			@@ -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>

New file
			@@ -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>

			@@ -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'
			);

New file
			@@ -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());
			}

			?>

New file
			@@ -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());
			}

			?>

New file
			@@ -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());
			}

			?>

New file
			@@ -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());
			}

			?>