phpipam / phpipam

functions/classes/class.User.php

Doc Comments +21 added lines, -21 removed lines

@@ -295,7 +295,7 @@ 
      * Checks if user is authenticated - session is set
      *
      * @access public
-     * @return void
+     * @return boolean
      */
     public function is_authenticated () {
         # if checked for subpages first check if $user is array
@@ -332,7 +332,7 @@ 
      *
      * @access public
      * @param bool $die (default: true)
-     * @return void
+     * @return boolean|null
      */
     public function is_admin ($die = true) {
         if($this->isadmin)      { return true; }
@@ -347,7 +347,7 @@ 
      *
      * @access public
      * @param bool $redirect (default: true)
-     * @return void
+     * @return null|boolean
      */
     public function check_user_session ($redirect = true) {
         # not authenticated
@@ -456,7 +456,7 @@ 
      * @param string $action (default: "create")
      * @param mixed $index (default: null)
      * @param mixed $value (default: null)
-     * @return void
+     * @return string|boolean
      */
     public function csrf_cookie ($action = "create", $index = null, $value = null) {
         // validate action
@@ -470,8 +470,8 @@ 
      * Validates csrf cookie action..
      *
      * @access private
-     * @param mixed $action
-     * @return void
+     * @param string $action
+     * @return boolean|null
      */
     private function csrf_validate_action ($action) {
         if ($action=="create" || $action=="validate") { return true; }
@@ -483,7 +483,7 @@ 
      *
      * @access private
      * @param mixed $index
-     * @return void
+     * @return string
      */
     private function csrf_cookie_create ($index) {
         // set cookie suffix
@@ -499,7 +499,7 @@ 
      *
      * @access private
      * @param mixed $index
-     * @return void
+     * @return boolean
      */
     private function csrf_cookie_validate ($index, $value) {
         // set cookie suffix
@@ -656,7 +656,7 @@ 
      *    Can be extended by reading set properties from set field options
      *
      * @access public
-     * @return void
+     * @return string[]
      */
     public function fetch_available_auth_method_types () {
         return array("AD", "LDAP", "NetIQ", "Radius");
@@ -723,7 +723,7 @@ 
      * @access public
      * @param mixed $action
      * @param mixed $subnetId
-     * @return void
+     * @return boolean
      */
     public function edit_favourite($action, $subnetId) {
         # execute
@@ -737,7 +737,7 @@ 
      *
      * @access private
      * @param mixed $subnetId
-     * @return void
+     * @return boolean
      */
     private function remove_favourite ($subnetId) {
         # set old favourite subnets
@@ -757,7 +757,7 @@ 
      *
      * @access private
      * @param int $subnetId
-     * @return boolena
+     * @return boolean
      */
     private function add_favourite ($subnetId) {
         # set old favourite subnets
@@ -794,7 +794,7 @@ 
      *
      * @access public
      * @param mixed $subnetId
-     * @return void
+     * @return boolean
      */
     public function is_folder_favourite ($subnetId) {
         return $this->is_subnet_favourite ($subnetId);
@@ -1110,7 +1110,7 @@ 
      *
      *
      * @access private
-     * @param mixed $username
+     * @param string $username
      * @param mixed $password
      * @return void
      */
@@ -1238,7 +1238,7 @@ 
      *
      * @access public
      * @param mixed $input
-     * @return void
+     * @return string
      */
     public function crypt_user_pass ($input) {
         # initialize salt
@@ -1257,7 +1257,7 @@ 
      *    this function will detect highest crypt type to use for system
      *
      * @access public
-     * @return void
+     * @return string|null
      */
     private function detect_crypt_type () {
         if(CRYPT_SHA512 == 1)        { return '$6$rounds=3000$'; }
@@ -1271,7 +1271,7 @@ 
      * Returns crypt type used to encrypt password
      *
      * @access public
-     * @return void
+     * @return string
      */
     public function return_crypt_type () {
         if(CRYPT_SHA512 == 1)        { return 'CRYPT_SHA512'; }
@@ -1314,7 +1314,7 @@ 
      *
      * @access public
      * @param mixed $post //posted user details
-     * @return void
+     * @return boolean
      */
     public function self_update($post) {
         # set items to update
@@ -1356,7 +1356,7 @@ 
      *
      * @access public
      * @param mixed $widgets
-     * @return void
+     * @return boolean
      */
     public function self_update_widgets ($widgets) {
         # update
@@ -1373,7 +1373,7 @@ 
      * Updates last users login time
      *
      * @access public
-     * @return void
+     * @return null|false
      */
     public function update_login_time () {
         # fix for older versions
@@ -1449,7 +1449,7 @@ 
      * adds new IP to block or updates count if already present
      *
      * @access private
-     * @return void
+     * @return false|null
      */
     private function block_ip () {
         # validate IP

functions/classes/class.PDO.php

Doc Comments +9 added lines, -9 removed lines

@@ -88,7 +88,7 @@ 
 	 * @access public
 	 * @param mixed $username (default: null)
 	 * @param mixed $password (default: null)
-	 * @param mixed $charset (default: null)
+	 * @param string $charset (default: null)
 	 * @param mixed $ssl (default: null)
 	 * @return void
 	 */
@@ -108,7 +108,7 @@ 
 	 * @access public
 	 * @static
 	 * @param mixed $date (default: null)
-	 * @return void
+	 * @return string
 	 */
 	public static function toDate($date = null) {
 		if (is_int($date)) {
@@ -152,7 +152,7 @@ 
 	 * makeDsn function.
 	 *
 	 * @access protected
-	 * @return void
+	 * @return string
 	 */
 	protected function makeDsn() {
 		return ':charset=' . $this->charset;
@@ -218,7 +218,7 @@ 
 	 * Are we currently connected to the database
 	 *
 	 * @access public
-	 * @return void
+	 * @return boolean
 	 */
 	public function isConnected() {
 		return ($this->pdo !== null);
@@ -239,7 +239,7 @@ 
 	 * Note: no objects are fetched
 	 *
 	 * @access public
-	 * @param mixed $query
+	 * @param string $query
 	 * @param array $values (default: array())
 	 * @return void
 	 */
@@ -463,7 +463,7 @@ 
 	 * @param string $query (default: null)
 	 * @param array $values (default: array())
 	 * @param mixed $id (default: null)
-	 * @return void
+	 * @return boolean
 	 */
 	public function objectExists($tableName, $query = null, $values = array(), $id = null) {
 		return is_object($this->getObject($tableName, $id));
@@ -520,7 +520,7 @@ 
 	 * @param mixed $query (default: null)
 	 * @param array $values (default: array())
 	 * @param mixed $callback (default: null)
-	 * @return void
+	 * @return boolean
 	 */
 	public function getObjectsQueryIncremental($query = null, $values = array(), $callback = null) {
 		if (!$this->isConnected()) $this->connect();
@@ -578,7 +578,7 @@ 
 	 * Get a single object from the database
 	 *
 	 * @access public
-	 * @param mixed $tableName
+	 * @param string $tableName
 	 * @param mixed $id (default: null)
 	 * @param string $class (default: 'stdClass')
 	 * @return void
@@ -906,7 +906,7 @@ 
 	 * makeDsn function
 	 *
 	 * @access protected
-	 * @return void
+	 * @return string
 	 */
 	protected function makeDsn() {
 		# for installation

functions/classes/class.Subnets.php

Doc Comments +45 added lines, -44 removed lines

@@ -151,7 +151,7 @@ 
 	 * Modify subnet details main method
 	 *
 	 * @access public
-	 * @param mixed $action
+	 * @param string $action
 	 * @param mixed $values
 	 * @return void
 	 */
@@ -173,7 +173,7 @@ 
 	 *
 	 * @access private
 	 * @param mixed $values
-	 * @return void
+	 * @return boolean
 	 */
 	private function subnet_add ($values) {
 		# null empty values
@@ -201,7 +201,7 @@ 
 	 *
 	 * @access private
 	 * @param mixed $values
-	 * @return void
+	 * @return boolean
 	 */
 	private function subnet_edit ($values) {
 		# save old values
@@ -230,7 +230,7 @@ 
 	 *
 	 * @access private
 	 * @param mixed $id
-	 * @return void
+	 * @return boolean
 	 */
 	private function subnet_delete ($id) {
 		# save old values
@@ -258,7 +258,7 @@ 
 	 *
 	 * @access public
 	 * @param int $subnetId
-	 * @return void
+	 * @return boolean
 	 */
 	public function subnet_truncate ($subnetId) {
 		# save old values
@@ -280,7 +280,7 @@ 
 	 * @param mixed $subnetId
 	 * @param int $subnet
 	 * @param int $mask
-	 * @return void
+	 * @return boolean
 	 */
 	private function subnet_resize ($subnetId, $subnet, $mask) {
 		# save old values
@@ -306,7 +306,7 @@ 
 	 * @param mixed $prefix
 	 * @param string $group (default: "yes")
 	 * @param string $strict (default: "yes")
-	 * @return void
+	 * @return boolean
 	 */
 	public function subnet_split ($subnet_old, $number, $prefix, $group="yes", $strict="yes") {
 
@@ -543,7 +543,7 @@ 
 	 * @access private
 	 * @param mixed $subnetId
 	 * @param mixed $vlanId
-	 * @return void
+	 * @return boolean
 	 */
 	private function is_subnet_in_vlan ($subnetId, $vlanId) {
 		# fetch subnet details
@@ -606,7 +606,7 @@ 
 	 * @access private
 	 * @param mixed $subnetId
 	 * @param mixed $vrfId
-	 * @return void
+	 * @return boolean
 	 */
 	private function is_subnet_in_vrf ($subnetId, $vrfId) {
 		# fetch subnet details
@@ -724,7 +724,7 @@ 
 	 *
 	 * @access public
 	 * @param mixed $subnetId
-	 * @return void
+	 * @return boolean
 	 */
 	public function has_slaves ($subnetId) {
     	// NULL subnetId cannot have slaves
@@ -741,7 +741,7 @@ 
 	 *
 	 * @access public
 	 * @param mixed $subnetId
-	 * @return void
+	 * @return null|false
 	 */
 	public function fetch_subnet_slaves ($subnetId) {
     	// fetch
@@ -919,7 +919,7 @@ 
 	 * @param mixed $used_hosts (int)
 	 * @param mixed $netmask (int)
 	 * @param mixed $subnet	(int)
-	 * @param bin $isFull	(default: 0)
+	 * @param integer $isFull	(default: 0)
 	 * @return void
 	 */
 	public function calculate_subnet_usage ($used_hosts, $netmask, $subnet, $isFull=0) {
@@ -952,7 +952,7 @@ 
 	 * @param mixed $subnet		//subnet in decimal format
 	 * @param mixed $bitmask	//netmask in decimal format
 	 * @param mixed $addresses	//all addresses to be calculated, either all slave or per subnet
-	 * @param bin $isFull       //if subnet is marked as full
+	 * @param integer $isFull       //if subnet is marked as full
 	 * @return void
 	 */
 	public function calculate_subnet_usage_detailed ($subnet, $bitmask, $addresses, $isFull=0) {
@@ -1109,7 +1109,7 @@ 
 	 *
 	 * @access public
 	 * @param mixed $netmask
-	 * @param mixed $ipversion
+	 * @param string $ipversion
 	 * @param bool $strict (default: true)
 	 * @return void
 	 */
@@ -1123,7 +1123,8 @@ 
 	 *
 	 * @access public
 	 * @param mixed $netmask
-	 * @return void
+	 * @param boolean $strict
+	 * @return integer
 	 */
 	public function get_max_IPv4_hosts ($netmask, $strict) {
 		if($netmask==31)			{ return 2; }
@@ -1137,7 +1138,7 @@ 
 	 *
 	 * @access public
 	 * @param mixed $netmask
-	 * @return void
+	 * @return string
 	 */
 	public function get_max_IPv6_hosts ($netmask) {
 		return gmp_strval(gmp_pow(2, 128 - $netmask));
@@ -1148,7 +1149,7 @@ 
 	 *
 	 * @access public
 	 * @param mixed $address
-	 * @return void
+	 * @return integer
 	 */
 	private function get_max_netmask ($address) {
 		return $this->identify_address($address)=="IPv6" ? 128 : 32;
@@ -1275,7 +1276,7 @@ 
 	 * Verifies CIDR address
 	 *
 	 * @access public
-	 * @param mixed $cidr
+	 * @param boolean|string $cidr
 	 * @param bool $issubnet (default: true)
 	 * @return void
 	 */
@@ -1357,7 +1358,7 @@ 
 	 * @param int $sectionId
 	 * @param mixed $new_subnet (cidr)
 	 * @param int $vrfId (default: 0)
-	 * @return void
+	 * @return string|false
 	 */
 	public function verify_subnet_overlapping ($sectionId, $new_subnet, $vrfId = 0) {
 	    # fetch section subnets
@@ -1389,10 +1390,10 @@ 
 	 *
 	 * @access public
 	 * @param int $sectionId
-	 * @param mixed $new_subnet
+	 * @param string $new_subnet
 	 * @param int $old_subnet_id
 	 * @param int $vrfId (default: 0)
-	 * @return void
+	 * @return string|false
 	 */
 	public function verify_subnet_resize_overlapping ($sectionId, $new_subnet, $old_subnet_id, $vrfId = 0) {
 	    # fetch section subnets
@@ -1435,7 +1436,7 @@ 
 	 * @param CIDR $new_subnet
 	 * @param int $vrfId (default: 0)
 	 * @param int $masterSubnetId (default: 0)
-	 * @return void
+	 * @return string|false
 	 */
 	public function verify_nested_subnet_overlapping ($sectionId, $new_subnet, $vrfId = 0, $masterSubnetId = 0) {
     	# fetch all slave subnets
@@ -1467,7 +1468,7 @@ 
 	 * @access public
 	 * @param CIDR $subnet1
 	 * @param CIDR $subnet2
-	 * @return void
+	 * @return boolean
 	 */
 	public function verify_overlapping ($subnet1, $subnet2) {
 		return $this->identify_address ($subnet1)=="IPv4" ? $this->verify_IPv4_subnet_overlapping ($subnet1, $subnet2) : $this->verify_IPv6_subnet_overlapping ($subnet1, $subnet2);
@@ -1538,8 +1539,8 @@ 
 	 *
 	 * @access public
 	 * @param mixed $masterSubnetId
-	 * @param mixed $cidr
-	 * @return void
+	 * @param string $cidr
+	 * @return boolean
 	 */
 	public function verify_subnet_nesting ($masterSubnetId, $cidr) {
 		//first get details for root subnet
@@ -1572,7 +1573,7 @@ 
 	 * @param mixed $vrfId		//vrfId
 	 * @param mixed $masterSubnetId	//master Subnet Id
 	 * @param mixed $mask_old	//old mask
-	 * @param mixed $sectionId	//section ID
+	 * @param integer $sectionId	//section ID
 	 * @return void
 	 */
 	public function verify_subnet_resize ($subnet, $mask, $subnetId, $vrfId, $masterSubnetId, $mask_old, $sectionId=0) {
@@ -1804,8 +1805,8 @@ 
 	 *
 	 * @access public
 	 * @param mixed $cidr1
-	 * @param mixed $cidr2
-	 * @return void
+	 * @param string $cidr2
+	 * @return boolean
 	 */
 	public function is_subnet_inside_subnet ($cidr1, $cidr2) {
 		$type = $this->identify_address ($cidr1);
@@ -1819,7 +1820,7 @@ 
 	 * @access private
 	 * @param mixed $cidr1
 	 * @param mixed $cidr2
-	 * @return void
+	 * @return boolean
 	 */
 	private function is_IPv4_subnet_inside_subnet ($cidr1, $cidr2) {
 		# Initialize PEAR NET object
@@ -1839,7 +1840,7 @@ 
 	 * @access private
 	 * @param mixed $cidr1
 	 * @param mixed $cidr2
-	 * @return void
+	 * @return boolean
 	 */
 	private function is_IPv6_subnet_inside_subnet ($cidr1, $cidr2) {
     	//mask 2 must be bigger than mask 1
@@ -1935,7 +1936,7 @@ 
 	 * Finds inactive hosts
 	 *
 	 * @access public
-	 * @param mixed $timelimit
+	 * @param integer $timelimit
 	 * @param int $limit (default: 100)
 	 * @return void
 	 */
@@ -2034,7 +2035,7 @@ 
 	 *
 	 * @access public
 	 * @param mixed $address
-	 * @return void
+	 * @return boolean
 	 */
 	public function is_multicast ($address) {
     	# IPv4
@@ -2063,7 +2064,7 @@ 
 	 *
 	 * @access public
 	 * @param mixed $address
-	 * @return void
+	 * @return false|string
 	 */
 	public function create_multicast_mac ($address) {
     	// first verify that it is multicast
@@ -2104,12 +2105,12 @@ 
      *      - vlan    : within l2 domain
      *
      * @access private
-     * @param mixed $mac
+     * @param string $mac
 	 * @param mixed $sectionId
 	 * @param mixed $vlanId
      * @param string $unique_required (default: "vlan")
      * @param int $address_id (dafault: 0)
-     * @return void
+     * @return boolean
      */
     private function multicast_address_exists ($mac, $sectionId, $vlanId, $unique_required = "vlan", $address_id = 0) {
         // if vlan fetch l2 domainid
@@ -2164,7 +2165,7 @@ 
 	 * @param mixed $vlanId
 	 * @param mixed $unique_required
 	 * @param int $address_id (defaut: 0)
-	 * @return true if ok, else error text to be displayed
+	 * @return boolean|string if ok, else error text to be displayed
 	 */
 	public function validate_multicast_mac ($mac, $sectionId, $vlanId, $unique_required="vlan", $address_id = 0) {
     	// first put it to common format (1)
@@ -2323,7 +2324,7 @@ 
 	 * @param mixed $user
 	 * @param mixed $section_subnets	//array of all subnets in section
 	 * @param int $rootId (default: 0)
-	 * @return void
+	 * @return string
 	 */
 	public function print_subnets_menu( $user, $section_subnets, $rootId = 0 ) {
 		# open / close via cookie
@@ -2485,7 +2486,7 @@ 
 	 * @param mixed $vlans
 	 * @param mixed $section_subnets
 	 * @param mixed $sectionId
-	 * @return void
+	 * @return string
 	 */
 	public function print_vlan_menu( $user, $vlans, $section_subnets, $sectionId ) {
 		# initialize html array
@@ -2583,7 +2584,7 @@ 
 	 * @param mixed $vrfs
 	 * @param mixed $section_subnets
 	 * @param mixed $sectionId
-	 * @return void
+	 * @return string
 	 */
 	public function print_vrf_menu( $user, $vrfs, $section_subnets, $sectionId ) {
 	 	# initialize html array
@@ -2675,7 +2676,7 @@ 
 	 * @param array $user
 	 * @param array $subnets
 	 * @param array $custom_fields
-	 * @return none - print
+	 * @return false|null - print
 	 */
 	public function print_subnets_tools( $user, $subnets, $custom_fields ) {
 
@@ -2934,7 +2935,7 @@ 
 	 *
 	 * @access public
 	 * @param mixed $sectionId
-	 * @param string $current_master (default: "0")
+	 * @param integer $current_master (default: "0")
 	 * @param boolean $isFolder (default: false)
 	 * @return void
 	 */
@@ -3120,7 +3121,7 @@ 
 	 * @access public
 	 * @param mixed $sectionId
 	 * @param mixed $subnetMasterId
-	 * @return void
+	 * @return string
 	 */
 	public function subnet_dropdown_print_available($sectionId, $subnetMasterId ) {
 
@@ -3218,8 +3219,8 @@ 
 	 * Take in decimal from IPv6 address and add one to it
 	 *
 	 * @access public
-	 * @param mixed $decimalIpv6
-	 * @return void
+	 * @param string|false $decimalIpv6
+	 * @return string
 	 */
 	public  function subnet_dropdown_ipv6_decimal_add_one ($decimalIpv6) {
 		# Take digit, make array of earch number and reverse it