ParameterBagTest.php

1. 8.x drupal/core/vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/Tests/ParameterBagTest.php
2. 8.x drupal/core/vendor/symfony/dependency-injection/Symfony/Component/DependencyInjection/Tests/ParameterBag/ParameterBagTest.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\HttpFoundation\Tests;

use Symfony\Component\HttpFoundation\ParameterBag;
class ParameterBagTest extends \PHPUnit_Framework_TestCase {

  /**
   * @covers Symfony\Component\HttpFoundation\ParameterBag::__construct
   */
  public function testConstructor() {
    $this
      ->testAll();
  }

  /**
   * @covers Symfony\Component\HttpFoundation\ParameterBag::all
   */
  public function testAll() {
    $bag = new ParameterBag(array(
      'foo' => 'bar',
    ));
    $this
      ->assertEquals(array(
      'foo' => 'bar',
    ), $bag
      ->all(), '->all() gets all the input');
  }
  public function testKeys() {
    $bag = new ParameterBag(array(
      'foo' => 'bar',
    ));
    $this
      ->assertEquals(array(
      'foo',
    ), $bag
      ->keys());
  }
  public function testAdd() {
    $bag = new ParameterBag(array(
      'foo' => 'bar',
    ));
    $bag
      ->add(array(
      'bar' => 'bas',
    ));
    $this
      ->assertEquals(array(
      'foo' => 'bar',
      'bar' => 'bas',
    ), $bag
      ->all());
  }
  public function testRemove() {
    $bag = new ParameterBag(array(
      'foo' => 'bar',
    ));
    $bag
      ->add(array(
      'bar' => 'bas',
    ));
    $this
      ->assertEquals(array(
      'foo' => 'bar',
      'bar' => 'bas',
    ), $bag
      ->all());
    $bag
      ->remove('bar');
    $this
      ->assertEquals(array(
      'foo' => 'bar',
    ), $bag
      ->all());
  }

  /**
   * @covers Symfony\Component\HttpFoundation\ParameterBag::replace
   */
  public function testReplace() {
    $bag = new ParameterBag(array(
      'foo' => 'bar',
    ));
    $bag
      ->replace(array(
      'FOO' => 'BAR',
    ));
    $this
      ->assertEquals(array(
      'FOO' => 'BAR',
    ), $bag
      ->all(), '->replace() replaces the input with the argument');
    $this
      ->assertFalse($bag
      ->has('foo'), '->replace() overrides previously set the input');
  }

  /**
   * @covers Symfony\Component\HttpFoundation\ParameterBag::get
   */
  public function testGet() {
    $bag = new ParameterBag(array(
      'foo' => 'bar',
      'null' => null,
    ));
    $this
      ->assertEquals('bar', $bag
      ->get('foo'), '->get() gets the value of a parameter');
    $this
      ->assertEquals('default', $bag
      ->get('unknown', 'default'), '->get() returns second argument as default if a parameter is not defined');
    $this
      ->assertNull($bag
      ->get('null', 'default'), '->get() returns null if null is set');
  }
  public function testGetDoesNotUseDeepByDefault() {
    $bag = new ParameterBag(array(
      'foo' => array(
        'bar' => 'moo',
      ),
    ));
    $this
      ->assertNull($bag
      ->get('foo[bar]'));
  }

  /**
   * @dataProvider getInvalidPaths
   * @expectedException \InvalidArgumentException
   */
  public function testGetDeepWithInvalidPaths($path) {
    $bag = new ParameterBag(array(
      'foo' => array(
        'bar' => 'moo',
      ),
    ));
    $bag
      ->get($path, null, true);
  }
  public function getInvalidPaths() {
    return array(
      array(
        'foo[[',
      ),
      array(
        'foo[d',
      ),
      array(
        'foo[bar]]',
      ),
      array(
        'foo[bar]d',
      ),
    );
  }
  public function testGetDeep() {
    $bag = new ParameterBag(array(
      'foo' => array(
        'bar' => array(
          'moo' => 'boo',
        ),
      ),
    ));
    $this
      ->assertEquals(array(
      'moo' => 'boo',
    ), $bag
      ->get('foo[bar]', null, true));
    $this
      ->assertEquals('boo', $bag
      ->get('foo[bar][moo]', null, true));
    $this
      ->assertEquals('default', $bag
      ->get('foo[bar][foo]', 'default', true));
    $this
      ->assertEquals('default', $bag
      ->get('bar[moo][foo]', 'default', true));
  }

  /**
   * @covers Symfony\Component\HttpFoundation\ParameterBag::set
   */
  public function testSet() {
    $bag = new ParameterBag(array());
    $bag
      ->set('foo', 'bar');
    $this
      ->assertEquals('bar', $bag
      ->get('foo'), '->set() sets the value of parameter');
    $bag
      ->set('foo', 'baz');
    $this
      ->assertEquals('baz', $bag
      ->get('foo'), '->set() overrides previously set parameter');
  }

  /**
   * @covers Symfony\Component\HttpFoundation\ParameterBag::has
   */
  public function testHas() {
    $bag = new ParameterBag(array(
      'foo' => 'bar',
    ));
    $this
      ->assertTrue($bag
      ->has('foo'), '->has() returns true if a parameter is defined');
    $this
      ->assertFalse($bag
      ->has('unknown'), '->has() return false if a parameter is not defined');
  }

  /**
   * @covers Symfony\Component\HttpFoundation\ParameterBag::getAlpha
   */
  public function testGetAlpha() {
    $bag = new ParameterBag(array(
      'word' => 'foo_BAR_012',
    ));
    $this
      ->assertEquals('fooBAR', $bag
      ->getAlpha('word'), '->getAlpha() gets only alphabetic characters');
    $this
      ->assertEquals('', $bag
      ->getAlpha('unknown'), '->getAlpha() returns empty string if a parameter is not defined');
  }

  /**
   * @covers Symfony\Component\HttpFoundation\ParameterBag::getAlnum
   */
  public function testGetAlnum() {
    $bag = new ParameterBag(array(
      'word' => 'foo_BAR_012',
    ));
    $this
      ->assertEquals('fooBAR012', $bag
      ->getAlnum('word'), '->getAlnum() gets only alphanumeric characters');
    $this
      ->assertEquals('', $bag
      ->getAlnum('unknown'), '->getAlnum() returns empty string if a parameter is not defined');
  }

  /**
   * @covers Symfony\Component\HttpFoundation\ParameterBag::getDigits
   */
  public function testGetDigits() {
    $bag = new ParameterBag(array(
      'word' => 'foo_BAR_012',
    ));
    $this
      ->assertEquals('012', $bag
      ->getDigits('word'), '->getDigits() gets only digits as string');
    $this
      ->assertEquals('', $bag
      ->getDigits('unknown'), '->getDigits() returns empty string if a parameter is not defined');
  }

  /**
   * @covers Symfony\Component\HttpFoundation\ParameterBag::getInt
   */
  public function testGetInt() {
    $bag = new ParameterBag(array(
      'digits' => '0123',
    ));
    $this
      ->assertEquals(123, $bag
      ->getInt('digits'), '->getInt() gets a value of parameter as integer');
    $this
      ->assertEquals(0, $bag
      ->getInt('unknown'), '->getInt() returns zero if a parameter is not defined');
  }

  /**
   * @covers Symfony\Component\HttpFoundation\ParameterBag::filter
   */
  public function testFilter() {
    $bag = new ParameterBag(array(
      'digits' => '0123ab',
      'email' => 'example@example.com',
      'url' => 'http://example.com/foo',
      'dec' => '256',
      'hex' => '0x100',
      'array' => array(
        'bang',
      ),
    ));
    $this
      ->assertEmpty($bag
      ->filter('nokey'), '->filter() should return empty by default if no key is found');
    $this
      ->assertEquals('0123', $bag
      ->filter('digits', '', false, FILTER_SANITIZE_NUMBER_INT), '->filter() gets a value of parameter as integer filtering out invalid characters');
    $this
      ->assertEquals('example@example.com', $bag
      ->filter('email', '', false, FILTER_VALIDATE_EMAIL), '->filter() gets a value of parameter as email');
    $this
      ->assertEquals('http://example.com/foo', $bag
      ->filter('url', '', false, FILTER_VALIDATE_URL, array(
      'flags' => FILTER_FLAG_PATH_REQUIRED,
    )), '->filter() gets a value of parameter as url with a path');

    // This test is repeated for code-coverage
    $this
      ->assertEquals('http://example.com/foo', $bag
      ->filter('url', '', false, FILTER_VALIDATE_URL, FILTER_FLAG_PATH_REQUIRED), '->filter() gets a value of parameter as url with a path');
    $this
      ->assertFalse($bag
      ->filter('dec', '', false, FILTER_VALIDATE_INT, array(
      'flags' => FILTER_FLAG_ALLOW_HEX,
      'options' => array(
        'min_range' => 1,
        'max_range' => 0xff,
      ),
    )), '->filter() gets a value of parameter as integer between boundaries');
    $this
      ->assertFalse($bag
      ->filter('hex', '', false, FILTER_VALIDATE_INT, array(
      'flags' => FILTER_FLAG_ALLOW_HEX,
      'options' => array(
        'min_range' => 1,
        'max_range' => 0xff,
      ),
    )), '->filter() gets a value of parameter as integer between boundaries');
    $this
      ->assertEquals(array(
      'bang',
    ), $bag
      ->filter('array', '', false), '->filter() gets a value of parameter as an array');
  }

  /**
   * @covers Symfony\Component\HttpFoundation\ParameterBag::getIterator
   */
  public function testGetIterator() {
    $parameters = array(
      'foo' => 'bar',
      'hello' => 'world',
    );
    $bag = new ParameterBag($parameters);
    $i = 0;
    foreach ($bag as $key => $val) {
      $i++;
      $this
        ->assertEquals($parameters[$key], $val);
    }
    $this
      ->assertEquals(count($parameters), $i);
  }

  /**
   * @covers Symfony\Component\HttpFoundation\ParameterBag::count
   */
  public function testCount() {
    $parameters = array(
      'foo' => 'bar',
      'hello' => 'world',
    );
    $bag = new ParameterBag($parameters);
    $this
      ->assertEquals(count($parameters), count($bag));
  }

}