Countable::count

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

Countable::count — Compte le nombre d'éléments d'un objet

Description

public Countable::count(): int

Cette méthode est exécutée lorsque le value pour count() est un objet implémentant Countable.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

Le nombre compté, sous forme int.

Exemples

Exemple #1 Exemple avec Countable::count()

<?php

class Counter implements Countable
{
    private $count = 0;

    public function count(): int
    {
        return ++$this->count;
    }
}

$counter = new Counter;

for ($i = 0; $i < 10; ++$i) {
    echo "J'ai été compté " . count($counter) . " fois\n";
}

?>

Résultat de l'exemple ci-dessus est similaire à :

J'ai été compté 1 fois
J'ai été compté 2 fois
J'ai été compté 3 fois
J'ai été compté 4 fois
J'ai été compté 5 fois
J'ai été compté 6 fois
J'ai été compté 7 fois
J'ai été compté 8 fois
J'ai été compté 9 fois
J'ai été compté 10 fois

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 2 notes

down

SenseException ¶

11 years ago

Even though Countable::count method is called when the object implementing Countable is used in count() function, the second parameter of count, $mode, has no influence to your class method. 

$mode is not passed to  Countable::count:

<?php

class Foo implements Countable
{
    public function count()
    {
        var_dump(func_get_args());
        return 1;
    }
}

count(new Foo(), COUNT_RECURSIVE);

?>

var_dump output:

array(0) {
}

down

moris at moris dot org dot ua ¶

5 days ago

First, the commonly referenced example of Countable is somewhat misleading from an OOP perspective, as it unintentionally violates some key principles. While it demonstrates the concept of Countable, it does so in a way that could cause confusion.

According to the Countable interface:

<?php
/**
 * Count elements of an object
 * @link https://php.net/manual/en/countable.count.php
 * @return int<0,max> The custom count as an integer.
 * <p>
 * The return value is cast to an integer.
 * </p>
 */
#[TentativeType]
public function count(): int;
?>

This means that the `count()` method should not modify the state of an object—it should simply return an integer value, aligning with SOLID principles.  

A proper OOP approach would be:  

<?php
class Counter implements Countable
{
    private $count = 0;

    // Returns the item count of the object
    public function count(): int
    {
        return $this->count;
    }

    public function increment(): void
    {
        $this->count++;
    }
}

$counter = new Counter;

for ($i = 0; $i < 10; ++$i) {
    $counter->increment();
    echo "I have been incremented " . count($counter) . " times\n";
}
?>

Here, count() correctly returns the number of elements, while increment() is responsible for modifying the state of the object.

A separate discussion can be had about whether to use count($object) or $object->count(), but that’s a different topic.

＋add a note