AbstractRecordConstraint.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Tests\Functional\Framework\Constraint\RequestSection;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Core\Tests\Functional\Framework\Frontend\ResponseSection;

abstract class AbstractRecordConstraint extends \PHPUnit_Framework_Constraint
{
    protected $sectionFailures = [];

    protected $table;

    protected $field;

    protected $strict = false;

    protected $values;

    public function setTable($table)
    {
        $this->table = $table;
        return $this;
    }

    public function setField($field)
    {
        $this->field = $field;
        return $this;
    }

    public function setValues()
    {
        $values = func_get_args();
        $this->values = $values;
        return $this;
    }

    public function setStrict($strict)
    {
        $this->strict = (bool)$strict;
        return $this;
    }

    protected function matches($other)
    {
        if (is_array($other)) {
            $success = null;
            foreach ($other as $item) {
                $currentSuccess = $this->matchesSection($item);
                $success = ($success === null ? $currentSuccess : $success || $currentSuccess);
            }
            return !empty($success);
        } else {
            return $this->matchesSection($other);
        }
    }

    abstract protected function matchesSection(ResponseSection $responseSection);

    protected function getNonMatchingValues(array $records)
    {
        $values = $this->values;

        foreach ($records as $recordIdentifier => $recordData) {
            if (strpos($recordIdentifier, $this->table . ':') !== 0) {
                continue;
            }

            if (($foundValueIndex = array_search($recordData[$this->field], $values)) !== false) {
                unset($values[$foundValueIndex]);
            }
        }

        return $values;
    }

    protected function getRemainingRecords(array $records)
    {
        $values = $this->values;

        foreach ($records as $recordIdentifier => $recordData) {
            if (strpos($recordIdentifier, $this->table . ':') !== 0) {
                unset($records[$recordIdentifier]);
                continue;
            }

            if (($foundValueIndex = array_search($recordData[$this->field], $values)) !== false) {
                unset($values[$foundValueIndex]);
                unset($records[$recordIdentifier]);
            }
        }

        return $records;
    }

    protected function failureDescription($other)
    {
        return $this->toString();
    }

    protected function additionalFailureDescription($other)
    {
        $failureDescription = '';
        foreach ($this->sectionFailures as $sectionIdentifier => $sectionFailure) {
            $failureDescription .= '* Section "' . $sectionIdentifier . '": ' . $sectionFailure . LF;
        }
        return $failureDescription;
    }
}