9.5/_object_access_test_8php_source.html

<?php

namespace ‪TYPO3\CMS\Extbase\Tests\Unit\Reflection;


/*

 * 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\Extbase\Persistence\ObjectStorage;

use ‪TYPO3\CMS\Extbase\Reflection\Exception\PropertyNotAccessibleException;

use ‪TYPO3\CMS\Extbase\Reflection\ObjectAccess;

use ‪TYPO3\CMS\Extbase\Tests\Unit\Reflection\Fixture\DummyClassWithGettersAndSetters;

use TYPO3\TestingFramework\Core\Unit\UnitTestCase;


class ‪ObjectAccessTest extends UnitTestCase

{

    protected ‪$dummyObject;


    protected function ‪setUp()

    {

        $this->dummyObject = new ‪DummyClassWithGettersAndSetters();

        $this->dummyObject->setProperty('string1');

        $this->dummyObject->setAnotherProperty(42);

        $this->dummyObject->shouldNotBePickedUp = true;

    }


    public function ‪getPropertyReturnsExpectedValueForGetterProperty()

    {

        $property = ‪ObjectAccess::getProperty($this->dummyObject, 'property');

        $this->assertEquals($property, 'string1');

    }


    public function ‪getPropertyReturnsExpectedValueForPublicProperty()

    {

        $property = ‪ObjectAccess::getProperty($this->dummyObject, 'publicProperty2');

        $this->assertEquals($property, 42, 'A property of a given object was not returned correctly.');

    }


    public function ‪getPropertyReturnsExpectedValueForUnexposedPropertyIfForceDirectAccessIsTrue()

    {

        $property = ‪ObjectAccess::getProperty($this->dummyObject, 'unexposedProperty', true);

        $this->assertEquals($property, 'unexposed', 'A property of a given object was not returned correctly.');

    }


    public function ‪getPropertyReturnsExpectedValueForUnknownPropertyIfForceDirectAccessIsTrue()

    {

        $this->dummyObject->unknownProperty = 'unknown';

        $property = ‪ObjectAccess::getProperty($this->dummyObject, 'unknownProperty', true);

        $this->assertEquals($property, 'unknown', 'A property of a given object was not returned correctly.');

    }


    public function ‪getPropertyThrowsPropertyNotAccessibleExceptionForNotExistingPropertyIfForceDirectAccessIsTrue()

    {

        $this->expectException(PropertyNotAccessibleException::class);

        $this->expectExceptionCode(1302855001);

        ‪ObjectAccess::getProperty($this->dummyObject, 'notExistingProperty', true);

    }


    public function ‪getPropertyThrowsExceptionIfPropertyDoesNotExist()

    {

        $this->expectException(PropertyNotAccessibleException::class);

        $this->expectExceptionCode(1476109666);

        ‪ObjectAccess::getProperty($this->dummyObject, 'notExistingProperty');

    }


    public function ‪getPropertyReturnsNullIfArrayKeyDoesNotExist()

    {

        $result = ‪ObjectAccess::getProperty([], 'notExistingProperty');

        $this->assertNull($result);

    }


    public function ‪getPropertyTriesToCallABooleanGetterMethodIfItExists()

    {

        $property = ‪ObjectAccess::getProperty($this->dummyObject, 'booleanProperty');

        $this->assertTrue($property);

    }


    public function ‪getPropertyThrowsExceptionIfThePropertyNameIsNotAString()

    {

        $this->expectException(\InvalidArgumentException::class);

        $this->expectExceptionCode(1231178303);

        ‪ObjectAccess::getProperty($this->dummyObject, new \ArrayObject());

    }


    public function ‪setPropertyThrowsExceptionIfThePropertyNameIsNotAString()

    {

        $this->expectException(\InvalidArgumentException::class);

        $this->expectExceptionCode(1231178878);

        ‪ObjectAccess::setProperty($this->dummyObject, new \ArrayObject(), 42);

    }


    public function ‪setPropertyReturnsFalseIfPropertyIsNotAccessible()

    {

        $this->assertFalse(‪ObjectAccess::setProperty($this->dummyObject, 'protectedProperty', 42));

    }


    public function ‪setPropertySetsValueIfPropertyIsNotAccessibleWhenForceDirectAccessIsTrue()

    {

        $this->assertTrue(‪ObjectAccess::setProperty($this->dummyObject, 'unexposedProperty', 'was set anyway', true));

        $this->assertAttributeEquals('was set anyway', 'unexposedProperty', $this->dummyObject);

    }


    public function ‪setPropertySetsValueIfPropertyDoesNotExistWhenForceDirectAccessIsTrue()

    {

        $this->assertTrue(‪ObjectAccess::setProperty($this->dummyObject, 'unknownProperty', 'was set anyway', true));

        $this->assertAttributeEquals('was set anyway', 'unknownProperty', $this->dummyObject);

    }


    public function ‪setPropertyCallsASetterMethodToSetThePropertyValueIfOneIsAvailable()

    {

        ‪ObjectAccess::setProperty($this->dummyObject, 'property', 4242);

        $this->assertEquals($this->dummyObject->getProperty(), 4242, 'setProperty does not work with setter.');

    }


    public function ‪setPropertyWorksWithPublicProperty()

    {

        ‪ObjectAccess::setProperty($this->dummyObject, 'publicProperty', 4242);

        $this->assertEquals($this->dummyObject->publicProperty, 4242, 'setProperty does not work with public property.');

    }


    public function ‪setPropertyCanDirectlySetValuesInAnArrayObjectOrArray()

    {

        $arrayObject = new \ArrayObject();

        $array = [];

        ‪ObjectAccess::setProperty($arrayObject, 'publicProperty', 4242);

        ‪ObjectAccess::setProperty($array, 'key', 'value');

        $this->assertEquals(4242, $arrayObject['publicProperty']);

        $this->assertEquals('value', $array['key']);

    }


    public function ‪getPropertyCanAccessPropertiesOfAnArrayObject()

    {

        $arrayObject = new \ArrayObject(['key' => 'value']);

        $actual = ‪ObjectAccess::getProperty($arrayObject, 'key');

        $this->assertEquals('value', $actual, 'getProperty does not work with ArrayObject property.');

    }


    public function ‪getPropertyCanAccessPropertiesOfAnObjectStorageObject()

    {

        $objectStorage = new \TYPO3\CMS\Extbase\Persistence\ObjectStorage();

        $object = new \stdClass();

        $objectStorage->attach($object);

        $actual = ‪ObjectAccess::getProperty($objectStorage, 0);

        $this->assertSame($object, $actual, 'getProperty does not work with ObjectStorage property.');

    }


    public function ‪getPropertyCanAccessPropertiesOfAnObjectImplementingArrayAccess()

    {

        $arrayAccessInstance = new \TYPO3\CMS\Extbase\Tests\Unit\Reflection\Fixture\ArrayAccessClass(['key' => 'value']);

        $actual = ‪ObjectAccess::getProperty($arrayAccessInstance, 'key');

        $this->assertEquals('value', $actual, 'getProperty does not work with Array Access property.');

    }


    public function ‪getPropertyCanAccessPropertiesOfArrayAccessWithGetterMethodWhenOffsetNotExists()

    {

        $arrayAccessInstance = new \TYPO3\CMS\Extbase\Tests\Unit\Reflection\Fixture\ArrayAccessClass([]);

        $actual = ‪ObjectAccess::getProperty($arrayAccessInstance, 'virtual');

        $this->assertEquals('default-value', $actual, 'getProperty does not work with Array Access property.');

    }


    public function ‪getPropertyCanAccessPropertiesOfArrayAccessWithPriorityForOffsetIfOffsetExists()

    {

        $arrayAccessInstance = new \TYPO3\CMS\Extbase\Tests\Unit\Reflection\Fixture\ArrayAccessClass(['virtual' => 'overridden-value']);

        $actual = ‪ObjectAccess::getProperty($arrayAccessInstance, 'virtual');

        $this->assertEquals('overridden-value', $actual, 'getProperty does not work with Array Access property.');

    }


    public function ‪getPropertyCanAccessPropertiesOfAnArray()

    {

        $array = ['key' => 'value'];

        $expected = ‪ObjectAccess::getProperty($array, 'key');

        $this->assertEquals($expected, 'value', 'getProperty does not work with Array property.');

    }


    public function ‪getPropertyPathCanAccessPropertiesOfAnArray()

    {

        $array = ['parent' => ['key' => 'value']];

        $actual = ‪ObjectAccess::getPropertyPath($array, 'parent.key');

        $this->assertEquals('value', $actual, 'getPropertyPath does not work with Array property.');

    }


    public function ‪getPropertyPathCanAccessPropertiesOfAnObjectImplementingArrayAccess()

    {

        $array = ['parent' => new \ArrayObject(['key' => 'value'])];

        $actual = ‪ObjectAccess::getPropertyPath($array, 'parent.key');

        $this->assertEquals('value', $actual, 'getPropertyPath does not work with Array Access property.');

    }


    public function ‪getPropertyPathCanAccessPropertiesOfAnExtbaseObjectStorageObject()

    {

        $objectStorage = $this->‪setUpObjectStorageWithTwoItems();

        $array = [

            'parent' => $objectStorage,

        ];

        $this->assertSame('value', ‪ObjectAccess::getPropertyPath($array, 'parent.0.key'));

        $this->assertSame('value2', ‪ObjectAccess::getPropertyPath($array, 'parent.1.key'));

    }


    public function ‪getPropertyPathOnObjectStorageDoesNotAffectOngoingLoop()

    {

        $objectStorage = $this->‪setUpObjectStorageWithTwoItems();

        $i = 0;

        foreach ($objectStorage as $object) {

            ‪ObjectAccess::getPropertyPath($objectStorage, '0.key');

            $i++;

        }

        $this->assertSame(2, $i);

    }


    protected function ‪setUpObjectStorageWithTwoItems()

    {

        $objectStorage = new ‪ObjectStorage();

        $exampleObject = new \stdClass();

        $exampleObject->key = 'value';

        $exampleObject2 = new \stdClass();

        $exampleObject2->key = 'value2';

        $objectStorage->attach($exampleObject);

        $objectStorage->attach($exampleObject2);

        return $objectStorage;

    }


    public function ‪getPropertyPathCanAccessPropertiesOfAnSplObjectStorageObject()

    {

        $objectStorage = $this->‪setUpSplObjectStorageWithTwoItems();

        $array = [

            'parent' => $objectStorage,

        ];

        $this->assertSame('value', ‪ObjectAccess::getPropertyPath($array, 'parent.0.key'));

        $this->assertSame('value2', ‪ObjectAccess::getPropertyPath($array, 'parent.1.key'));

    }


    public function ‪getPropertyPathOnSplObjectStorageDoesNotAffectOngoingLoop()

    {

        $objectStorage = $this->‪setUpSplObjectStorageWithTwoItems();

        $i = 0;

        foreach ($objectStorage as $object) {

            ‪ObjectAccess::getPropertyPath($objectStorage, '0.key');

            $i++;

        }

        $this->assertSame(2, $i);

    }


    protected function ‪setUpSplObjectStorageWithTwoItems()

    {

        $objectStorage = new \SplObjectStorage();

        $exampleObject = new \stdClass();

        $exampleObject->key = 'value';

        $exampleObject2 = new \stdClass();

        $exampleObject2->key = 'value2';

        $objectStorage->attach($exampleObject);

        $objectStorage->attach($exampleObject2);

        return $objectStorage;

    }


    public function ‪getGettablePropertyNamesReturnsAllPropertiesWhichAreAvailable()

    {

        $gettablePropertyNames = ‪ObjectAccess::getGettablePropertyNames($this->dummyObject);

        $expectedPropertyNames = ['anotherBooleanProperty', 'anotherProperty', 'booleanProperty', 'property', 'property2', 'publicProperty', 'publicProperty2', 'someValue'];

        $this->assertEquals($gettablePropertyNames, $expectedPropertyNames, 'getGettablePropertyNames returns not all gettable properties.');

    }


    public function ‪getGettablePropertyNamesRespectsMethodArguments()

    {

        $dateTimeZone = new \DateTimeZone('+2');

        $gettablePropertyNames = ‪ObjectAccess::getGettablePropertyNames($dateTimeZone);

        $expectedPropertyNames = ['location', 'name'];

        $this->assertArraySubset($expectedPropertyNames, $gettablePropertyNames);

    }


    public function ‪getSettablePropertyNamesReturnsAllPropertiesWhichAreAvailable()

    {

        $settablePropertyNames = ‪ObjectAccess::getSettablePropertyNames($this->dummyObject);

        $expectedPropertyNames = ['anotherBooleanProperty', 'anotherProperty', 'property', 'property2', 'publicProperty', 'publicProperty2', 'writeOnlyMagicProperty'];

        $this->assertEquals($settablePropertyNames, $expectedPropertyNames, 'getSettablePropertyNames returns not all settable properties.');

    }


    public function ‪getSettablePropertyNamesReturnsPropertyNamesOfStdClass()

    {

        $stdClassObject = new \stdClass();

        $stdClassObject->property = 'string1';

        $stdClassObject->property2 = null;

        $settablePropertyNames = ‪ObjectAccess::getSettablePropertyNames($stdClassObject);

        $expectedPropertyNames = ['property', 'property2'];

        $this->assertEquals($expectedPropertyNames, $settablePropertyNames, 'getSettablePropertyNames returns not all settable properties.');

    }


    public function ‪getGettablePropertiesReturnsTheCorrectValuesForAllProperties()

    {

        $allProperties = ‪ObjectAccess::getGettableProperties($this->dummyObject);

        $expectedProperties = [

            'anotherBooleanProperty' => true,

            'anotherProperty' => 42,

            'booleanProperty' => true,

            'property' => 'string1',

            'property2' => null,

            'publicProperty' => null,

            'publicProperty2' => 42,

            'someValue' => true,

        ];

        $this->assertEquals($allProperties, $expectedProperties, 'expectedProperties did not return the right values for the properties.');

    }


    public function ‪getGettablePropertiesReturnsPropertiesOfStdClass()

    {

        $stdClassObject = new \stdClass();

        $stdClassObject->property = 'string1';

        $stdClassObject->property2 = null;

        $stdClassObject->publicProperty2 = 42;

        $allProperties = ‪ObjectAccess::getGettableProperties($stdClassObject);

        $expectedProperties = [

            'property' => 'string1',

            'property2' => null,

            'publicProperty2' => 42

        ];

        $this->assertEquals($expectedProperties, $allProperties, 'expectedProperties did not return the right values for the properties.');

    }


    public function ‪isPropertySettableTellsIfAPropertyCanBeSet()

    {

        $this->assertTrue(‪ObjectAccess::isPropertySettable($this->dummyObject, 'writeOnlyMagicProperty'));

        $this->assertTrue(‪ObjectAccess::isPropertySettable($this->dummyObject, 'publicProperty'));

        $this->assertTrue(‪ObjectAccess::isPropertySettable($this->dummyObject, 'property'));

        $this->assertFalse(‪ObjectAccess::isPropertySettable($this->dummyObject, 'privateProperty'));

        $this->assertFalse(‪ObjectAccess::isPropertySettable($this->dummyObject, 'shouldNotBePickedUp'));

    }


    public function ‪isPropertySettableWorksOnStdClass()

    {

        $stdClassObject = new \stdClass();

        $stdClassObject->property = 'foo';

        $this->assertTrue(‪ObjectAccess::isPropertySettable($stdClassObject, 'property'));

        $this->assertFalse(‪ObjectAccess::isPropertySettable($stdClassObject, 'undefinedProperty'));

    }


    public function ‪isPropertyGettableTellsIfAPropertyCanBeRetrieved($property, $expected)

    {

        $this->assertEquals($expected, ‪ObjectAccess::isPropertyGettable($this->dummyObject, $property));

    }


    public function ‪propertyGettableTestValues()

    {

        return [

            ['publicProperty', true],

            ['property', true],

            ['booleanProperty', true],

            ['anotherBooleanProperty', true],

            ['privateProperty', false],

            ['writeOnlyMagicProperty', false]

        ];

    }


    public function ‪isPropertyGettableWorksOnArrayAccessObjects()

    {

        $arrayObject = new \ArrayObject();

        $arrayObject['key'] = 'v';

        $this->assertTrue(‪ObjectAccess::isPropertyGettable($arrayObject, 'key'));

        $this->assertFalse(‪ObjectAccess::isPropertyGettable($arrayObject, 'undefinedKey'));

    }


    public function ‪isPropertyGettableWorksOnStdClass()

    {

        $stdClassObject = new \stdClass();

        $stdClassObject->property = 'foo';

        $this->assertTrue(‪ObjectAccess::isPropertyGettable($stdClassObject, 'property'));

        $this->assertFalse(‪ObjectAccess::isPropertyGettable($stdClassObject, 'undefinedProperty'));

    }


    public function ‪getPropertyPathCanRecursivelyGetPropertiesOfAnObject()

    {

        $alternativeObject = new ‪DummyClassWithGettersAndSetters();

        $alternativeObject->setProperty('test');

        $this->dummyObject->setProperty2($alternativeObject);

        $expected = 'test';

        $actual = ‪ObjectAccess::getPropertyPath($this->dummyObject, 'property2.property');

        $this->assertEquals($expected, $actual);

    }


    public function ‪getPropertyPathReturnsNullForNonExistingPropertyPath()

    {

        $alternativeObject = new ‪DummyClassWithGettersAndSetters();

        $alternativeObject->setProperty(new \stdClass());

        $this->dummyObject->setProperty2($alternativeObject);

        $this->assertNull(‪ObjectAccess::getPropertyPath($this->dummyObject, 'property2.property.not.existing'));

    }


    public function ‪getPropertyPathReturnsNullIfSubjectIsNoObject()

    {

        $string = 'Hello world';

        $this->assertNull(‪ObjectAccess::getPropertyPath($string, 'property2'));

    }


    public function ‪getPropertyPathReturnsNullIfSubjectOnPathIsNoObject()

    {

        $object = new \stdClass();

        $object->foo = 'Hello World';

        $this->assertNull(‪ObjectAccess::getPropertyPath($object, 'foo.bar'));

    }

}