PHP Variable Handling is_countable() Function



The PHP Variable Handling is_countable() function is used to determine whether a variable can be tallied. This method works in both PHP 7.3 and PHP 8. It is useful to know if a variable is an array or a countable object. If the variable can be counted, the function returns true. If the variable can't be counted, it returns false.

This function is useful when working with loops and counting things. It prevents errors while trying to count anything that is not countable. Using is_countable() increases code safety and eliminates possible errors.

Syntax

Below is the syntax of the PHP Variable Handling is_countable() function −

bool is_countable ( mixed $value )

Parameters

This function accepts $value parameter which is the variable that you want to check. It can be any type like an array, object, string, number, etc.

Return Value

The is_countable() function returns TRUE if the variable is countable. And it returns FALSE if the variable cannot be counted.

PHP Version

First introduced in core PHP 7.3.0, the is_countable() function continues to function easily in PHP 8.

Example 1

First we will show you the basic example of the PHP Variable Handling is_countable() function to check if an array is countable. As an array is always countable so it will return true.

<?php
   // An array of numbers
   $numbers = [1, 2, 3, 4, 5]; 
   if (is_countable($numbers)) {
      echo "The variable is countable."; 
   } else {
      echo "The variable is not countable.";
   }
?>

Output

Here is the outcome of the following code −

The variable is countable.

Example 2

In the below PHP code we will try to use the is_countable() function and check a string, which is not countable. It will return false.

<?php
   // A string variable
   $text = "Hello, World!"; 
   if (is_countable($text)) {
      echo "The variable is countable.";
   } else {
      echo "The variable is not countable."; 
   }
?> 

Output

This will generate the below output −

The variable is not countable.

Example 3

Now the below code used to check an object which implements countable. So this program creates a class which implements Countable class to make the object countable.

<?php
   class MyCollection implements Countable {
      private $items = [1, 2, 3];

      public function count() {
         return count($this->items);
      }
   }

   $obj = new MyCollection();
   echo is_countable($obj) ? "The object is countable." : "The object is not countable."; 
?> 

Output

This will create the below output −

The object is countable.

Example 4

In the following example, we are using the is_countable() function to check different data types like array, object and integer with the help of a loop.

<?php
   $values = [
   // Countable array
   [1, 2, 3], 
   // Non-countable object
   new stdClass(), 
   // Non-countable integer
   42, 
   ];

   foreach ($values as $value) {
   echo is_countable($value) ? "Countable\n" : "Not Countable\n";
   }
?> 

Output

Following is the output of the above code −

Countable
Not Countable
Not Countable
php_variable_handling_functions.htm
Advertisements