detain / cisco_parser

class.cisco.php

Doc Comments +5 added lines, -5 removed lines

@@ -91,7 +91,7 @@ 
 	}
 
 	/**
-	 * @param     $string
+	 * @param     string $string
 	 * @param int $index
 	 * @return string
 	 */
@@ -142,7 +142,7 @@ 
 	}
 
 	/**
-	 * @param $cmd
+	 * @param string $cmd
 	 */
 	public function write($cmd) {
 		fwrite($this->_stream, $cmd);
@@ -211,7 +211,7 @@ 
 	}
 
 	/**
-	 * @param $cmd
+	 * @param string $cmd
 	 * @return string
 	 */
 	public function exec($cmd) {
@@ -236,7 +236,7 @@ 
 	}
 
 	/**
-	 * @return mixed
+	 * @return string
 	 */
 	public function get_response() {
 		return $this->_response;
@@ -735,7 +735,7 @@ 
 
 	/**
 	 * @param $config
-	 * @return bool
+	 * @return null|boolean
 	 */
 	public function configure($config) {
 		// USE AT OWN RISK: This function will apply configuration statements to a device.

Spacing +4 added lines, -4 removed lines

@@ -386,7 +386,7 @@ 
 				if (mb_strpos($entry[1], 'Auto') !== FALSE) {
 					$result['speed'] = 'auto';
 				} else {
-					$result['speed'] = (int)$entry[1];
+					$result['speed'] = (int) $entry[1];
 				} // if .. else
 				$entry[2] = rtrim($entry[2]);
 				$result['type'] = mb_substr($entry[2], mb_strrpos($entry[2], ' ') + 1);
@@ -563,7 +563,7 @@ 
 			foreach ($this->_data as $vlan) {
 				$vlan = explode(' ', $vlan);
 				$vlan = mb_substr($vlan[0], 4);
-				$result[] = (int)$vlan;
+				$result[] = (int) $vlan;
 			} // foreach
 		} // if
 		$this->_data = $result;
@@ -748,14 +748,14 @@ 
 		$config_prompt = str_replace("\r\n", '', trim($config_prompt));
 		if (mb_strpos($config_prompt, 'config)#') !== FALSE) {
 			foreach ($this->_data as $c)
-				$this->_ssh->write($c . "\n");
+				$this->_ssh->write($c."\n");
 			$this->_ssh->write("end\n");
 		}
 		$result = $this->_ssh->read($this->_prompt);
 		$result = explode("\r\n", $result);
 		if (count($this->_data) == (count($result) - 2))
 			return true; else
-			die('Error: Switch rejected configuration: '.PHP_EOL . $config . "\n");
+			die('Error: Switch rejected configuration: '.PHP_EOL.$config."\n");
 	}
 
 	/**

Upper-Lower-Casing +11 added lines, -11 removed lines

@@ -25,7 +25,7 @@ 
 	/**
 	 * @var bool
 	 */
-	public $autoconnect = true; // Sets whether or not exec() will automatically connect() if needed
+	public $autoconnect = TRUE; // Sets whether or not exec() will automatically connect() if needed
 	/**
 	 * @var int
 	 */
@@ -122,7 +122,7 @@ 
 				//echo 'M:'.print_r($matches, TRUE).'<br>';
 				$match = isset($matches[0]) ? $matches[0] : [];
 			}
-			$pos = !empty($match) ? mb_strpos($this->_response, $match) : false;
+			$pos = !empty($match) ? mb_strpos($this->_response, $match) : FALSE;
 			//echo ++$i . "POS:".var_export($pos, TRUE).'<br>';
 			if ($pos !== FALSE) {
 				//echo "$match Matching $pattern @ $pos <br>";
@@ -155,13 +155,13 @@ 
 		//echo "Connecting to " . $this->_hostname . "<br>";
 		$this->_ssh = ssh2_connect($this->_hostname, $this->_port);
 		if ($this->_ssh === FALSE) {
-			return false;
+			return FALSE;
 		}
 		ssh2_auth_password($this->_ssh, $this->_username, $this->_password);
 		$this->_stream = ssh2_shell($this->_ssh);
-		$this->connected = true;
+		$this->connected = TRUE;
 		$this->parse_motd_and_prompt();
-		return true;
+		return TRUE;
 	}
 
 	/**
@@ -176,7 +176,7 @@ 
 			$this->_motd = mb_substr($this->_motd, 0, -$length);
 		//echo "MOTD:".$this->_motd."<br>";
 		//echo "Prompt:".$this->_prompt.'<br>';
-		return true;
+		return TRUE;
 		sleep(1);
 		$this->_motd = '';
 		while ($this->_response = fgets($this->_stream)) {
@@ -215,7 +215,7 @@ 
 	 * @return string
 	 */
 	public function exec($cmd) {
-		if ($this->autoconnect === true && $this->connected === FALSE)
+		if ($this->autoconnect === TRUE && $this->connected === FALSE)
 			$this->connect();
 		if (mb_substr($cmd, -1) != "\n") {
 			//error_log("Adding NEWLINE Character To SSH2 Command $cmd", __LINE__, __FILE__);
@@ -254,7 +254,7 @@ 
 	 *
 	 */
 	public function __destruct() {
-		if ($this->connected === true)
+		if ($this->connected === TRUE)
 			$this->disconnect();
 	}
 
@@ -754,7 +754,7 @@ 
 		$result = $this->_ssh->read($this->_prompt);
 		$result = explode("\r\n", $result);
 		if (count($this->_data) == (count($result) - 2))
-			return true; else
+			return TRUE; else
 			die('Error: Switch rejected configuration: '.PHP_EOL . $config . "\n");
 	}
 
@@ -764,8 +764,8 @@ 
 	public function write_config() {
 		$this->exec('write');
 		if (mb_strpos($this->_data, '[OK]') !== FALSE)
-			return true; else
-			return false;
+			return TRUE; else
+			return FALSE;
 	}
 }