Removing functions that have been removed from PHP before 7.1

Removing functions that have been removed BEFORE PHP 7.1.
Closes #60

Author: moufmouf

generated/functionsList.php

@@ -296,10 +296,6 @@
     'imageopenpolygon',
     'imagepng',
     'imagepolygon',
-    'imagepsencodefont',
-    'imagepsextendfont',
-    'imagepsfreefont',
-    'imagepsslantfont',
     'imagerectangle',
     'imageresolution',
     'imagerotate',
@@ -366,7 +362,6 @@
     'phpinfo',
     'putenv',
     'set_include_path',
-    'set_magic_quotes_runtime',
     'set_time_limit',
     'ingres_autocommit',
     'ingres_close',
@@ -491,7 +486,6 @@
     'mssql_data_seek',
     'mssql_field_length',
     'mssql_field_name',
-    'mssql_field_seek',
     'mssql_field_type',
     'mssql_free_result',
     'mssql_free_statement',
@@ -874,9 +868,7 @@
     'session_decode',
     'session_destroy',
     'session_regenerate_id',
-    'session_register',
     'session_reset',
-    'session_unregister',
     'session_unset',
     'session_write_close',
     'shmop_delete',
@@ -1009,7 +1001,6 @@
     'uopz_implement',
     'base64_decode',
     'get_headers',
-    'import_request_variables',
     'settype',
     'xdiff_file_bdiff',
     'xdiff_file_bpatch',

generated/image.php

@@ -1519,92 +1519,6 @@ function imagepolygon($image, array $points, int $num_points, int $color): void
 }
 
 
-/**
- * Loads a character encoding vector from a file and changes the fonts
- * encoding vector to it. As a PostScript fonts default vector lacks most of
- * the character positions above 127, you'll definitely want to change this
- * if you use a language other than English.
- *
- * If you find yourself using this function all the time, a much
- * better way to define the encoding is to set ps.default_encoding in
- * the configuration file
- * to point to the right encoding file and all fonts you load will
- * automatically have the right encoding.
- *
- * @param resource $font_index A font resource, returned by imagepsloadfont.
- * @param string $encodingfile The exact format of this file is described in T1libs documentation.
- * T1lib comes with two ready-to-use files,
- * IsoLatin1.enc and
- * IsoLatin2.enc.
- * @throws ImageException
- *
- */
-function imagepsencodefont($font_index, string $encodingfile): void
-{
-    error_clear_last();
-    $result = \imagepsencodefont($font_index, $encodingfile);
-    if ($result === false) {
-        throw ImageException::createFromPhpError();
-    }
-}
-
-
-/**
- * Extend or condense a font (font_index), if
- * the value of the extend parameter is less
- * than one you will be condensing the font.
- *
- * @param resource $font_index A font resource, returned by imagepsloadfont.
- * @param float $extend Extension value, must be greater than 0.
- * @throws ImageException
- *
- */
-function imagepsextendfont($font_index, float $extend): void
-{
-    error_clear_last();
-    $result = \imagepsextendfont($font_index, $extend);
-    if ($result === false) {
-        throw ImageException::createFromPhpError();
-    }
-}
-
-
-/**
- * imagepsfreefont frees memory used by a PostScript
- * Type 1 font.
- *
- * @param resource $font_index A font resource, returned by imagepsloadfont.
- * @throws ImageException
- *
- */
-function imagepsfreefont($font_index): void
-{
-    error_clear_last();
-    $result = \imagepsfreefont($font_index);
-    if ($result === false) {
-        throw ImageException::createFromPhpError();
-    }
-}
-
-
-/**
- * Slant a given font.
- *
- * @param resource $font_index A font resource, returned by imagepsloadfont.
- * @param float $slant Slant level.
- * @throws ImageException
- *
- */
-function imagepsslantfont($font_index, float $slant): void
-{
-    error_clear_last();
-    $result = \imagepsslantfont($font_index, $slant);
-    if ($result === false) {
-        throw ImageException::createFromPhpError();
-    }
-}
-
-
 /**
  * imagerectangle creates a rectangle starting at
  * the specified coordinates.

generated/info.php

@@ -557,23 +557,6 @@ function set_include_path(string $new_include_path): string
 }
 
 
-/**
- * Set the current active configuration setting of magic_quotes_runtime.
- *
- * @param bool $new_setting FALSE for off, TRUE for on.
- * @throws InfoException
- *
- */
-function set_magic_quotes_runtime(bool $new_setting): void
-{
-    error_clear_last();
-    $result = \set_magic_quotes_runtime($new_setting);
-    if ($result === false) {
-        throw InfoException::createFromPhpError();
-    }
-}
-
-
 /**
  * Set the number of seconds a script is allowed to run. If this is reached,
  * the script returns a fatal error. The default limit is 30 seconds or, if

generated/mssql.php

@@ -184,27 +184,6 @@ function mssql_field_name($result, int $offset = -1): string
 }
 
 
-/**
- * Seeks to the specified field offset.  If the next call to
- * mssql_fetch_field won't include a field
- * offset, this field would be returned.
- *
- * @param resource $result The result resource that is being evaluated. This result comes from a
- * call to mssql_query.
- * @param int $field_offset The field offset, starts at 0.
- * @throws MssqlException
- *
- */
-function mssql_field_seek($result, int $field_offset): void
-{
-    error_clear_last();
-    $result = \mssql_field_seek($result, $field_offset);
-    if ($result === false) {
-        throw MssqlException::createFromPhpError();
-    }
-}
-
-
 /**
  * Returns the type of field no. offset in
  * result.

generated/session.php

@@ -94,47 +94,6 @@ function session_regenerate_id(bool $delete_old_session = false): void
 }
 
 
-/**
- * session_register accepts a variable number of
- * arguments, any of which can be either a string holding the name of a
- * variable or an array consisting of variable names or other arrays. For
- * each name, session_register registers the global
- * variable with that name in the current session.
- *
- * You can also create a session variable by simply setting the
- * appropriate member of the $_SESSION array.
- *
- *
- *
- * ]]>
- *
- *
- *
- * If session_start was not called before this function
- * is called, an implicit call to session_start with no
- * parameters will be made.  $_SESSION does not mimic
- * this behavior and requires session_start before use.
- *
- * @param mixed $name A string holding the name of a variable or an array consisting of
- * variable names or other arrays.
- * @param mixed $params
- * @throws SessionException
- *
- */
-function session_register($name, ...$params): void
-{
-    error_clear_last();
-    if ($params !== []) {
-        $result = \session_register($name, ...$params);
-    } else {
-        $result = \session_register($name);
-    }
-    if ($result === false) {
-        throw SessionException::createFromPhpError();
-    }
-}
-
-
 /**
  * session_reset reinitializes a session with
  * original values stored in session storage. This function requires an active session and
@@ -153,24 +112,6 @@ function session_reset(): void
 }
 
 
-/**
- * session_unregister unregisters the global variable
- * named name from the current session.
- *
- * @param string $name The variable name.
- * @throws SessionException
- *
- */
-function session_unregister(string $name): void
-{
-    error_clear_last();
-    $result = \session_unregister($name);
-    if ($result === false) {
-        throw SessionException::createFromPhpError();
-    }
-}
-
-
 /**
  * The session_unset function frees all session variables
  * currently registered.

generated/var.php

@@ -4,52 +4,6 @@
 
 use Safe\Exceptions\VarException;
 
-/**
- * Imports GET/POST/Cookie variables into the global scope. It is useful if
- * you disabled register_globals,
- * but would like to see some variables in the global scope.
- *
- * If you're interested in importing other variables into the global scope,
- * such as $_SERVER, consider using extract.
- *
- * @param string $types Using the types parameter, you can specify
- * which request variables to import. You can use 'G', 'P' and 'C'
- * characters respectively for GET, POST and Cookie. These characters are
- * not case sensitive, so you can also use any combination of 'g', 'p'
- * and 'c'. POST includes the POST uploaded file information.
- *
- * Note that the order of the letters matters, as when using
- * "GP", the
- * POST variables will overwrite GET variables with the same name. Any
- * other letters than GPC are discarded.
- * @param string $prefix Variable name prefix, prepended before all variable's name imported
- * into the global scope. So if you have a GET value named
- * "userid", and provide a prefix
- * "pref_", then you'll get a global variable named
- * $pref_userid.
- *
- * Although the prefix parameter is optional, you
- * will get an E_NOTICE level
- * error if you specify no prefix, or specify an empty string as a
- * prefix. This is a possible security hazard. Notice level errors are
- * not displayed using the default error reporting level.
- * @throws VarException
- *
- */
-function import_request_variables(string $types, string $prefix = null): void
-{
-    error_clear_last();
-    if ($prefix !== null) {
-        $result = \import_request_variables($types, $prefix);
-    } else {
-        $result = \import_request_variables($types);
-    }
-    if ($result === false) {
-        throw VarException::createFromPhpError();
-    }
-}
-
-
 /**
  * Set the type of variable var to
  * type.

generator/src/DocPage.php

@@ -2,6 +2,8 @@
 
 namespace Safe;
 
+use function explode;
+
 class DocPage
 {
     /*
@@ -27,6 +29,23 @@ public function detectFalsyFunction(): bool
     {
         $file = file_get_contents($this->path);
 
+        if (preg_match('/&warn\.deprecated\.function-(\d+-\d+-\d+)\.removed-(\d+-\d+-\d+)/', $file, $matches)) {
+            $removedVersion = $matches[2];
+            [$major, $minor, $fix] = explode('-', $removedVersion);
+            if ($major < 7 || ($major == 7 && $minor == 0)) {
+                // Ignore function if it was removed before PHP 7.1
+                return false;
+            }
+        }
+        if (preg_match('/&warn\.removed\.function-(\d+-\d+-\d+)/', $file, $matches)) {
+            $removedVersion = $matches[2];
+            [$major, $minor, $fix] = explode('-', $removedVersion);
+            if ($major < 7 || ($major == 7 && $minor == 0)) {
+                // Ignore function if it was removed before PHP 7.1
+                return false;
+            }
+        }
+
         if (preg_match('/&false;\s+on\s+error/m', $file)) {
             return true;
         }

generator/tests/DocPageTest.php

@@ -12,11 +12,15 @@ public function testDetectFalsyFunction() {
         $getCwd = new DocPage(__DIR__ . '/../doc/doc-en/en/reference/dir/functions/getcwd.xml');
         $setTime = new DocPage(__DIR__ . '/../doc/doc-en/en/reference/datetime/datetime/settime.xml');
         $filesize = new DocPage(__DIR__ . '/../doc/doc-en/en/reference/filesystem/functions/filesize.xml');
+        $sessionRegister = new DocPage(__DIR__ . '/../doc/doc-en/en/reference/session/functions/session-register.xml');
+        $mcryptDecrypt = new DocPage(__DIR__ . '/../doc/doc-en/en/reference/mcrypt/functions/mcrypt-decrypt.xml');
 
         $this->assertTrue($pregMatch->detectFalsyFunction());
         $this->assertFalse($implode->detectFalsyFunction());
         $this->assertTrue($getCwd->detectFalsyFunction());
         $this->assertTrue($setTime->detectFalsyFunction());
         $this->assertTrue($filesize->detectFalsyFunction());
+        $this->assertFalse($sessionRegister->detectFalsyFunction());
+        $this->assertTrue($mcryptDecrypt->detectFalsyFunction());
     }
 }