Adjustments

added extra comments, renamed class file and added new example file for
the Mysql module.

Author: N1ghteyes

README.md

@@ -8,7 +8,7 @@ See the example files, but typical useage takes the form of:
 
 ```
 //load class
-$cpuapi = new cpaneluapi('user', 'password', 'cpanel.example.com');
+$cpuapi = new cpanelUAPI('user', 'password', 'cpanel.example.com');
 
 //Set the scope to the module we want to use. in this case, Mysql
 $cpuapi->scope = 'Mysql';

cpaneluapi.class renamed to cpaneluapi.class.php

@@ -1,5 +1,17 @@
 <?php
 
+/**
+ * PHP class to handle connections with cPanel's UAPI as seamlessly and simply as possible.
+ *
+ * For documentation on cPanel's UAPI:
+ * @see https://documentation.cpanel.net/display/SDK/UAPI+Functions
+ *
+ * @author N1ghteyes - www.source-control.co.uk
+ * @copyright 2014 N1ghteyes
+ * @license license.txt The MIT License (MIT)
+ * @link https://github.com/N1ghteyes/cpanel-UAPI-php-class
+ */
+
 /**
  * Class cpanelUAPI
  */
@@ -82,7 +94,7 @@ protected function curl_request($url)
     curl_setopt($ch, CURLOPT_URL, $url);
     curl_setopt($ch, CURLOPT_HTTPHEADER, array("Authorization: Basic " . $this->auth));
     curl_setopt($ch, CURLOPT_TIMEOUT, 100020);
-    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+    curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
 
     $content = $this->curl_exec_follow($ch);
     $err = curl_errno($ch);
@@ -118,22 +130,22 @@ protected function curl_exec_follow($ch, &$maxredirect = null)
 
       curl_setopt($ch, CURLOPT_FOLLOWLOCATION, $mr > 0);
       curl_setopt($ch, CURLOPT_MAXREDIRS, $mr);
-      curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-      curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
+      curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
+      curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
 
     } else {
 
-      curl_setopt($ch, CURLOPT_FOLLOWLOCATION, false);
+      curl_setopt($ch, CURLOPT_FOLLOWLOCATION, FALSE);
 
       if ($mr > 0) {
         $original_url = curl_getinfo($ch, CURLINFO_EFFECTIVE_URL);
         $newurl = $original_url;
 
         $rch = curl_copy_handle($ch);
 
-        curl_setopt($rch, CURLOPT_HEADER, true);
-        curl_setopt($rch, CURLOPT_NOBODY, true);
-        curl_setopt($rch, CURLOPT_FORBID_REUSE, false);
+        curl_setopt($rch, CURLOPT_HEADER, TRUE);
+        curl_setopt($rch, CURLOPT_NOBODY, TRUE);
+        curl_setopt($rch, CURLOPT_FORBID_REUSE, FALSE);
         do {
           curl_setopt($rch, CURLOPT_URL, $newurl);
           $header = curl_exec($rch);
@@ -164,7 +176,7 @@ protected function curl_exec_follow($ch, &$maxredirect = null)
           else
             $maxredirect = 0;
 
-          return false;
+          return FALSE;
         }
         curl_setopt($ch, CURLOPT_URL, $newurl);
       }

examples/mysql.php

@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * For documentation on cPanel's UAPI:
+ * @see https://documentation.cpanel.net/display/SDK/UAPI+Functions
+ *
+ * @author N1ghteyes - www.source-control.co.uk
+ * @copyright 2014 N1ghteyes
+ * @license license.txt The MIT License (MIT)
+ * @link https://github.com/N1ghteyes/cpanel-UAPI-php-class
+ */
+
+include "../cpaneluapi.class.php"; //include the class file
+$uapi = new cpanelUAPI('cPuser', 'cPpass', 'cPanel.example.com'); //instantiate the object
+
+$database = 'database';
+$databaseuser = 'databaseuser';
+$databasepass = 'databasepass';
+
+/**
+ * Mysql - Create a database and user, then assign the user to that database.
+ * For a full list of functions available for the Mysql module, see: https://documentation.cpanel.net/display/SDK/Mysql
+ * Mysql requires cPanel 11.44 +
+ */
+
+$uapi->scope = 'Mysql'; // set the scope to the module we want to use. NOTE: this IS case sensitive.
+
+//If database prefixing is enabled, this parameter must include the database prefix for the account.
+//This is normally the account username, followed by an underscore. e.g. cPuser_database.
+// ----
+//Arguments are passed by an array, where a url parameter of ?name=database is needed, it is passed with
+//the array key as the parameter e.g. array('name' => 'database').
+
+$uapi->create_database(array('name' => $database)); //Create the database
+$uapi->create_user(array('name' => $databaseuser, 'password' => $databasepass)); //create a user for the new database
+
+
+//After you create the user, you must use the set_privileges_on_database function call to grant access to the
+//user for a database.
+//add the user, set all privileges - add specific privileges by comma separation. e.g. 'DELETE,UPDATE,CREATE,ALTER'
+$uapi->set_privileges_on_database(array('user' => $databaseuser, 'database' => $database, 'privileges' => 'ALL'));