detain / cpanel-licensing

src/Cpanel.php

Indentation +87 added lines, -87 removed lines

@@ -13,11 +13,11 @@ 
 	public $opts;
 
 	/**
-	* Cpanel constructor.
-	*
-	* @param $user
-	* @param $pass
-	*/
+	 * Cpanel constructor.
+	 *
+	 * @param $user
+	 * @param $pass
+	 */
 	public function __construct($user, $pass) {
 		$this->opts = [];
 		$this->format = 'simplexml';
@@ -27,27 +27,27 @@ 
 	}
 
 	/**
-	* @param $option
-	* @param $value
-	*/
+	 * @param $option
+	 * @param $value
+	 */
 	public function setopt($option, $value) {
 		$this->opts[$option] = $value;
 	}
 
 	/**
-	* sets the login credentials
-	* @param string $user the username
-	* @param string $pass the password
-	*/
+	 * sets the login credentials
+	 * @param string $user the username
+	 * @param string $pass the password
+	 */
 	public function setCredentials($user, $pass) {
 		$this->setopt(CURLOPT_USERPWD, $user.':'.$pass);
 	}
 
 	/**
-	* sets the output format
-	* 
-	* @param string $format can be any of xml,json,yaml,simplexml 
-	*/
+	 * sets the output format
+	 * 
+	 * @param string $format can be any of xml,json,yaml,simplexml 
+	 */
 	public function setFormat($format) {
 		if ($format != 'xml' && $format != 'json' && $format != 'yaml' && $format != 'simplexml') {
 			error_log('setFormat requires that the format is xml, json, yaml or simplexml');
@@ -58,10 +58,10 @@ 
 	}
 
 	/**
-	* @param string $function
-	* @param array $args
-	* @return array|mixed|void
-	*/
+	 * @param string $function
+	 * @param array $args
+	 * @return array|mixed|void
+	 */
 	private function get($function, $args = []) {
 		if (!$function) {
 			error_log('cPanelLicensing::get requires that a function is defined');
@@ -94,10 +94,10 @@ 
 	}
 
 	/**
-	* formats the response
-	* @param array $result the result array to format
-	* @return array the rormatted arrray
-	*/
+	 * formats the response
+	 * @param array $result the result array to format
+	 * @return array the rormatted arrray
+	 */
 	private function formatResult($result) {
 		if (is_array($result)) {
 			foreach ($result as $key => $value) {
@@ -114,9 +114,9 @@ 
 	}
 
 	/**
-	* @param $id
-	* @return int
-	*/
+	 * @param $id
+	 * @return int
+	 */
 	private function validateID($id) {
 		if (preg_match("/^(L|P|G)?\d*$/", $id)) {
 			return 1;
@@ -126,17 +126,17 @@ 
 	}
 
 	/**
-	* @param $ipAddress
-	* @return int
-	*/
+	 * @param $ipAddress
+	 * @return int
+	 */
 	private function validateIP($ipAddress) {
 		return preg_match("/^\d*\.\d*\.\d*\.\d*$/", $ipAddress);
 	}
 
 	/**
-	* @param $args
-	* @return array|mixed|void
-	*/
+	 * @param $args
+	 * @return array|mixed|void
+	 */
 	public function reactivateLicense($args) {
 		if (!array_key_exists('liscid', $args)) {
 			error_log('cpanelLicensing::reactivateLicense requires that the argument array contains element liscid');
@@ -150,9 +150,9 @@ 
 	}
 
 	/**
-	* @param $args
-	* @return array|mixed|void
-	*/
+	 * @param $args
+	 * @return array|mixed|void
+	 */
 	public function expireLicense($args) {
 		if (!array_key_exists('liscid', $args)) {
 			error_log('cPanelLicensing::expireLicense requires that liscid elements exists in the array passed to it');
@@ -166,9 +166,9 @@ 
 	}
 
 	/**
-	* @param $args
-	* @return array|mixed|void
-	*/
+	 * @param $args
+	 * @return array|mixed|void
+	 */
 	public function extendOnetimeUpdates($args) {
 		if (!array_key_exists('ip', $args)) {
 			error_log('cpanelLicensing::extendOnetimeUpdates requires that the element ip exists in the array is passed to it');
@@ -182,9 +182,9 @@ 
 	}
 
 	/**
-	* @param $args
-	* @return array|mixed|void
-	*/
+	 * @param $args
+	 * @return array|mixed|void
+	 */
 	public function changeip($args) {
 		if (!array_key_exists('oldip', $args) || !array_key_exists('newip', $args)) {
 			error_log('cpanelLicensing::changeip requires that oldip and newip elements exist in the array passed to it');
@@ -198,9 +198,9 @@ 
 	}
 
 	/**
-	* @param $args
-	* @return array|mixed|void
-	*/
+	 * @param $args
+	 * @return array|mixed|void
+	 */
 	public function requestTransfer($args) {
 		if (!array_key_exists('ip', $args) || !array_key_exists('groupid', $args) || !array_key_exists('packagegroup', $args)) {
 			error_log('cpanelLicensing::requestTransfer requires that ip, groupid and packageid elements exist in the array passed to it');
@@ -222,9 +222,9 @@ 
 	}
 
 	/**
-	* @param $args
-	* @return array|mixed|void
-	*/
+	 * @param $args
+	 * @return array|mixed|void
+	 */
 	public function activateLicense($args) {
 		if (!array_key_exists('ip', $args) || !array_key_exists('groupid', $args) || !array_key_exists('packageid', $args)) {
 			error_log('cpanelLicensing::activateLicense requires that ip, groupid and packageid elements exist in the array passed to it');
@@ -247,9 +247,9 @@ 
 	}
 
 	/**
-	* @param $args
-	* @return array|mixed|void
-	*/
+	 * @param $args
+	 * @return array|mixed|void
+	 */
 	public function addPickupPass($args) {
 		if (!array_key_exists('pickup', $args)) {
 			error_log('cPanelLicensing::addPickupPass requires a pickup param');
@@ -259,9 +259,9 @@ 
 	}
 
 	/**
-	* @param $args
-	* @return array|mixed|void
-	*/
+	 * @param $args
+	 * @return array|mixed|void
+	 */
 	public function registerAuth($args) {
 		if (!array_key_exists('user', $args)) {
 			error_log('cPanelLicensing::registerAuth requires a user param');
@@ -282,20 +282,20 @@ 
 	}
 
 	/**
-	* return s a list of groups
-	* 
-	* @return array|mixed|void
-	*/
+	 * return s a list of groups
+	 * 
+	 * @return array|mixed|void
+	 */
 	public function fetchGroups() {
 		return $this->get('XMLgroupInfo.cgi');
 	}
 
 	/**
-	* fetches license risk data
-	* 
-	* @param array $args
-	* @return array|mixed|void
-	*/
+	 * fetches license risk data
+	 * 
+	 * @param array $args
+	 * @return array|mixed|void
+	 */
 	public function fetchLicenseRiskData($args = []) {
 		if (!array_key_exists('ip', $args)) {
 			error_log('cpanelLicensing::fetchLicenseRiskData requires that ip exists as an element in the array is passed to it');
@@ -309,11 +309,11 @@ 
 	}
 
 	/**
-	* gets raw license information
-	* 
-	* @param array $args optional array of arguments
-	* @return array|mixed|void
-	*/
+	 * gets raw license information
+	 * 
+	 * @param array $args optional array of arguments
+	 * @return array|mixed|void
+	 */
 	public function fetchLicenseRaw($args = []) {
 		$args = array_merge(['all' => 1], $args);
 		if (!array_key_exists('ip', $args)) {
@@ -328,11 +328,11 @@ 
 	}
 
 	/**
-	* gets license information
-	* 
-	* @param array $args optional array of arguments
-	* @return array|mixed|void
-	*/
+	 * gets license information
+	 * 
+	 * @param array $args optional array of arguments
+	 * @return array|mixed|void
+	 */
 	public function fetchLicenseId($args = []) {
 		$args = array_merge(['all' => 1], $args);
 		if (!array_key_exists('ip', $args)) {
@@ -347,35 +347,35 @@ 
 	}
 
 	/**
-	* @return array|mixed|void
-	*/
+	 * @return array|mixed|void
+	 */
 	public function fetchPackages() {
 		return $this->get('XMLpackageInfo.cgi');
 	}
 
 	/**
-	* gets a list of licenses
-	* 
-	* @param array $args optional arguments
-	* @return array|mixed|void
-	*/
+	 * gets a list of licenses
+	 * 
+	 * @param array $args optional arguments
+	 * @return array|mixed|void
+	 */
 	public function fetchLicenses($args = []) {
 		return $this->get('XMLlicenseInfo.cgi');
 	}
 
 	/**
-	* return sa list of expired licenses
-	* @return array|mixed|void
-	*/
+	 * return sa list of expired licenses
+	 * @return array|mixed|void
+	 */
 	public function fetchExpiredLicenses() {
 		return $this->fetchLicenses(['expired' => '1']);
 	}
 
 	/**
-	* @param $search
-	* @param $xmlObj
-	* @return string|void
-	*/
+	 * @param $search
+	 * @param $xmlObj
+	 * @return string|void
+	 */
 	public function findKey($search, $xmlObj) {
 		$xmlObj = (array) $xmlObj;
 		if (array_key_exists('packages', $xmlObj)) {