ini_restore - PHP code example

The php Function Ini_Restore

The php function ini_restore restores a configuration option variable to its original value. This happens automatically when a script completes execution for configuration options set using ini_set() during that script.

In PHP, a validator can be attached to the ini_restore function. This validator is notified of the new INI setting value, and must validate it (for example, to ensure that the long-valued option actually is a positive integer). If successful, the value is added to the existing global INI setting. Otherwise, a FAILURE is returned.

For this to work, the INI_DEFAULT value is set to a constant that you provide, and then the engine reads the value from a zend_ini_entry_def that you register with the engine. This means that the INI_DEFAULT value can't change during a request, and when the request ends, the engine restores the original setting to its default value.

This feature is very helpful for preventing attacks that target the INI file, since attackers are more likely to focus on trying to hijack ini_restore than they are to try to use ini_set or ini_get to alter INI settings in malicious ways. In addition, registering the INI_DEFAULT in this manner helps narrow down a search of tens-of-thousands of PHP files to a relatively small set of potential candidates for attack. This is a significant advantage over other methods of INI security.

ini_restore example

->method('getTotalMigrationCount')
            ->willReturn(5);

        $this->migrationCollection->expects(static::once())
            ->method('getExecutableDestructiveMigrations')
            ->willReturn(['migration']);

        \ini_set('max_execution_time', '10');

        $result = $this->databaseMigrator->migrate(0, $this->connection);

        \ini_restore('max_execution_time');

        static::assertSame([
            'offset' => 1,
            'total' => 10,
            'isFinished' => false,
        ], $result);
    }

    public function testUnfinishedMigration(): void
    {
        $this->setupAdapter->expects(static::never())

// Clear entitymanager to prevent weird 'model shop not persisted' errors.         Shopware()->Models()->clear();
    }

    /** * Performs operation returned by getSetUpOperation(). */
    protected function tearDown(): void
    {
        set_time_limit(0);
        ini_restore('memory_limit');
    }

    /** * Allows to set a Shopware config * * @param bool|float|int|string|null $value */
    protected function setConfig(string $name, $value): void
    {
        Shopware()->Container()->get('config_writer')->save($name, $value);
        Shopware()->Container()->get(Zend_Cache_Core::class)->clean();

    /** * @dataProvider configProvider */
    public function testGet(string $key, string|false $configValue, string $expectedValue): void
    {
        \ini_set($key, (string) $configValue);

        $reader = new IniConfigReader();
        static::assertSame($expectedValue, $reader->get($key));

        \ini_restore($key);
    }

    public static function configProvider(): \Generator
    {
        yield 'max_execution_time' => [
            'max_execution_time',
            '30',
            '30',
        ];

        yield 'memory_limit' => [