feat(error): deprecate E_USER_ERROR in PHP 8.4

Refs: #476

Author: Xenira

src/embed/mod.rs

@@ -10,14 +10,14 @@ mod sapi;
 
 use crate::boxed::ZBox;
 use crate::ffi::{
-    _zend_file_handle__bindgen_ty_1, php_execute_script, zend_eval_string, zend_file_handle,
-    zend_stream_init_filename, ZEND_RESULT_CODE_SUCCESS,
+    _zend_file_handle__bindgen_ty_1, ZEND_RESULT_CODE_SUCCESS, php_execute_script,
+    zend_eval_string, zend_file_handle, zend_stream_init_filename,
 };
 use crate::types::{ZendObject, Zval};
-use crate::zend::{panic_wrapper, try_catch, ExecutorGlobals};
-use parking_lot::{const_rwlock, RwLock};
-use std::ffi::{c_char, c_void, CString, NulError};
-use std::panic::{resume_unwind, RefUnwindSafe};
+use crate::zend::{ExecutorGlobals, panic_wrapper, try_catch};
+use parking_lot::{RwLock, const_rwlock};
+use std::ffi::{CString, NulError, c_char, c_void};
+use std::panic::{RefUnwindSafe, resume_unwind};
 use std::path::Path;
 use std::ptr::null_mut;
 
@@ -287,6 +287,8 @@ mod tests {
     #[test]
     fn test_eval_bailout() {
         Embed::run(|| {
+            // TODO: For PHP 8.5, this needs to be replaced, as `E_USER_ERROR` is deprecated
+            //       Currently, this seems to still be the best way to trigger a bailout
             let result = Embed::eval("trigger_error(\"Fatal error\", E_USER_ERROR);");
 
             assert!(result.is_err());

src/flags.rs

@@ -308,6 +308,7 @@ bitflags! {
         /// Compile warning
         const CompileWarning = E_COMPILE_WARNING;
         /// User error
+        #[cfg_attr(php84, deprecated = "`E_USER_ERROR` is deprecated since PHP 8.4. Throw an exception instead.")]
         const UserError = E_USER_ERROR;
         /// User warning
         const UserWarning = E_USER_WARNING;