Fonction PHP pour vérifier que deux tableaux sont identiques tout en ignorant les valeurs des clés spécifiées

j'ai besoin d'une fonction PHP qui puisse affirmer que deux tableaux sont les mêmes tout en ignorant les valeurs d'un ensemble spécifié de clés (seulement la valeur, les clés doivent correspondre).

Dans la pratique, les tableaux doivent avoir la même structure, mais certaines valeurs peuvent être ignorés.

Par exemple, en considérant les deux tableaux:

Array
(
    [0] => Array
        (
            [id] => 0
            [title] => Book1 Title
            [creationDate] => 2013-01-13 17:01:07
            [pageCount] => 0
        )
)

Array
(
    [0] => Array
        (
            [id] => 1
            [title] => Book1 Title
            [creationDate] => 2013-01-13 17:01:07
            [pageCount] => 0
        )
)

ils sont le même, si on ignore la valeur de la clé id.

je veux aussi envisager la possibilité de niché les tableaux:

Array
(
    [0] => Array
        (
            [id] => 0
            [title] => Book1 Title
            [creationDate] => 2013-01-13 17:01:07
            [pageCount] => 0
        )

    [1] => Array
        (
            [id] => 0
            [title] => Book2 Title
            [creationDate] => 2013-01-13 18:01:07
            [pageCount] => 0
        )
)

Array
(
    [0] => Array
        (
            [id] => 2
            [title] => Book1 Title
            [creationDate] => 2013-01-13 17:01:07
            [pageCount] => 0
        )

    [1] => Array
        (
            [id] => 3
            [title] => Book2 Title
            [creationDate] => 2013-01-13 18:01:07
            [pageCount] => 0
        )
)

puisque j'en ai besoin pour les tests, j'ai créé la classe suivante qui s'étend PHPUnit_Framework_TestCase et utilise ses affirmer fonctions:

class MyTestCase extends PHPUnit_Framework_TestCase
{
    public static function assertArraysSame($expected, $actual, array $ignoreKeys = array())
    {
        self::doAssertArraysSame($expected, $actual, $ignoreKeys, 1);
    }

    private static function doAssertArraysSame($expected, $actual, array $ignoreKeys = array(), $depth, $maxDepth = 256)
    {
        self::assertNotEquals($depth, $maxDepth);
        $depth++;

        foreach ($expected as $key => $exp) {
            // check they both have this key
            self::assertArrayHasKey($key, $actual);

            // check nested arrays 
            if (is_array($exp))
                self::doAssertArraysSame($exp, $actual[$key], $ignoreKeys, $depth);

            // check they have the same value unless the key is in the to-ignore list
            else if (array_search($key, $ignoreKeys) === false)
                self::assertSame($exp, $actual[$key]);

            // remove the current elements
            unset($expected[$key]);
            unset($actual[$key]);
        }

        // check that the two arrays are both empty now, which means they had the same lenght
        self::assertEmpty($expected);
        self::assertEmpty($actual);
    }
}

doAssertArraysSame parcourt l'un des tableaux et affirme de manière récursive que les deux tableaux ont les mêmes touches. Il vérifie également qu'ils ont les mêmes valeurs, à moins que la clé est dans la liste des clés de l'ignorer.

Pour vous assurer que les deux tableaux ont exactement la même nombre d'éléments, chaque élément est supprimé lors de l'itération et, à la fin de la boucle, la fonction vérifie que les deux tableaux sont vides.

Utilisation:

class MyTest extends MyTestCase
{
    public function test_Books()
    {
        $a1 = array('id' => 1, 'title' => 'the title');
        $a2 = array('id' => 2, 'title' => 'the title');

        self::assertArraysSame($a1, $a2, array('id'));
    }
}

ma question Est la suivante: y a-t-il une façon meilleure ou plus simple d'accomplir cette tâche, peut-être en utilisant certaines fonctions PHP/PHPUnit déjà disponibles?

EDIT: s'il vous plaît garder à l'esprit que je ne pas nécessairement vouloir une solution pour PHPUnit, s'il y avait une fonction PHP simple qui peut faire cela, je peux l'utiliser dans mes tests.

8
demandé sur Lorenzo Polidori 2013-01-15 13:51:23

2 réponses

Je ne suis pas sûr que ce soit une meilleure solution que ce que vous utilisez déjà, mais j'ai utilisé une classe similaire avant quand j'avais ce besoin exact. Il est capable de vous donner une simple réponse vraie ou fausse et n'est pas couplé à un cadre de test, qui peut ou ne peut pas être une bonne chose pour vous.

class RecursiveArrayCompare
{
    /**
     * @var array
     */
    protected $ignoredKeys;

    /**
     *
     */
    function __construct()
    {
        $this->ignoredKeys = array();
    }

    /**
     * @param array $ignoredKeys
     * @return RecursiveArrayCompare
     */
    public function setIgnoredKeys(array $ignoredKeys)
    {
        $this->ignoredKeys = $ignoredKeys;

        return $this;
    }

    /**
     * @param array $a
     * @param array $b
     * @return bool
     */
    public function compare(array $a, array $b)
    {
        foreach ($a as $key => $value) {
            if (in_array($key, $this->ignoredKeys)) {
                continue;
            }

            if (!array_key_exists($key, $b)) {
                return false;
            }

            if (is_array($value) && !empty($value)) {
                if (!is_array($b[$key])) {
                    return false;
                }

                if (!$this->compare($value, $b[$key])) {
                    return false;
                }
            } else {
                if ($value !== $b[$key]) {
                    return false;
                }
            }

            unset($b[$key]);
        }

        $diff = array_diff(array_keys($b), $this->ignoredKeys);

        return empty($diff);
    }
}

Et quelques exemples basé sur votre condition de tableau:

$arr1 = array(
    'id' => 0,
    'title' => 'Book1 title',
    'creationDate' => '2013-01-13 17:01:07',
    'pageCount' => 0
);

// only difference is value of ignored key
$arr2 = array(
    'id' => 1,
    'title' => 'Book1 title',
    'creationDate' => '2013-01-13 17:01:07',
    'pageCount' => 0
);

// has extra key
$arr3 = array(
    'id' => 1,
    'title' => 'Book1 title',
    'creationDate' => '2013-01-13 17:01:07',
    'pageCount' => 0,
    'extra_key' => 1
);

// has extra key, which is ignored
$arr4 = array(
    'id' => 1,
    'title' => 'Book1 title',
    'creationDate' => '2013-01-13 17:01:07',
    'pageCount' => 0,
    'ignored_key' => 1
);

// has different value
$arr5 = array(
    'id' => 2,
    'title' => 'Book2 title',
    'creationDate' => '2013-01-13 17:01:07',
    'pageCount' => 0
);

$comparer = new RecursiveArrayCompare();
$comparer->setIgnoredKeys(array('id', 'ignored_key'));

var_dump($comparer->compare($arr1, $arr2)); // true
var_dump($comparer->compare($arr1, $arr3)); // false
var_dump($comparer->compare($arr1, $arr4)); // true
var_dump($comparer->compare($arr1, $arr5)); // false

EDIT

L'avantage à l'utilisation d'une catégorie distincte comme cela est qu'il est simple à unité tester cette classe aussi bien pour s'assurer qu'elle se comporte comme prévu. Vous ne voulez pas compter sur des outils pour vos tests si vous ne pouvez pas garantir qu'ils fonctionnent correctement.

5
répondu RobMasters 2013-01-15 11:25:59

Vous pouvez anticiper les éléments du tableau

foreach ($array1 as $index => $subArray)
{
    $this->assertEquals($array1[$index]['title'], $array2[$index]['title');
    $this->assertEquals($array1[$index]['creationDate'], $array2[$index]['creationDate');
    $this->assertEquals($array1[$index]['pageCount'], $array2[$index]['pageCount');
}   
0
répondu Steven Scott 2013-01-15 16:24:36