generate arginfo from stub

remicollet commented 2 years ago

add type hinting for parameters and return
fix smbclient_rename parameters name
fix smbclient_chmod, mode is required
fix smbclient_utimes: mtime and atime are optional

Fix also fix #93

This makes mandatory for dev to use PHP 8+ when editing smbclient.stub.php, so arginfo.h files are regenerated

remicollet commented 2 years ago

Arginfo diff for PHP 7

--- old 2022-02-07 15:21:10.388599833 +0100
+++ new 2022-02-07 16:37:24.551045163 +0100
@@ -180,8 +180,8 @@
       - Parameters [4] {
         Parameter #0 [ <required> $oldstate ]
         Parameter #1 [ <required> $oldpath ]
-        Parameter #2 [ <required> $oldstate ]
-        Parameter #3 [ <required> $oldpath ]
+        Parameter #2 [ <required> $newstate ]
+        Parameter #3 [ <required> $newpath ]
       }
     }
     Function [ <internal:smbclient> function smbclient_write ] {
@@ -222,7 +222,7 @@
       - Parameters [3] {
         Parameter #0 [ <required> $state ]
         Parameter #1 [ <required> $path ]
-        Parameter #2 [ <optional> $mode = <default> ]
+        Parameter #2 [ <required> $mode ]
       }
     }
     Function [ <internal:smbclient> function smbclient_utimes ] {
@@ -230,8 +230,8 @@
       - Parameters [4] {
         Parameter #0 [ <required> $state ]
         Parameter #1 [ <required> $path ]
-        Parameter #2 [ <required> $mtime ]
-        Parameter #3 [ <required> $atime ]
+        Parameter #2 [ <optional> $mtime = <default> ]
+        Parameter #3 [ <optional> $atime = <default> ]
       }
     }
     Function [ <internal:smbclient> function smbclient_listxattr ] {

remicollet commented 2 years ago

Arginfo diff for PHP 8

--- old 2022-02-07 15:21:10.388599833 +0100
+++ new 2022-02-07 16:38:14.775864801 +0100
@@ -38,11 +38,13 @@

       - Parameters [0] {
       }
+      - Return [ string ]
     }
     Function [ <internal:smbclient> function smbclient_library_version ] {

       - Parameters [0] {
       }
+      - Return [ string ]
     }
     Function [ <internal:smbclient> function smbclient_state_new ] {

@@ -53,35 +55,38 @@

       - Parameters [4] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <optional> $workgroup = <default> ]
-        Parameter #2 [ <optional> $user = <default> ]
-        Parameter #3 [ <optional> $password = <default> ]
+        Parameter #1 [ <optional> string $workgroup = null ]
+        Parameter #2 [ <optional> string $user = null ]
+        Parameter #3 [ <optional> string $password = null ]
       }
+      - Return [ bool ]
     }
     Function [ <internal:smbclient> function smbclient_state_errno ] {

       - Parameters [1] {
         Parameter #0 [ <required> $state ]
       }
+      - Return [ int ]
     }
     Function [ <internal:smbclient> function smbclient_state_free ] {

       - Parameters [1] {
         Parameter #0 [ <required> $state ]
       }
+      - Return [ bool ]
     }
     Function [ <internal:smbclient> function smbclient_option_get ] {

       - Parameters [2] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <required> $option ]
+        Parameter #1 [ <required> int $option ]
       }
     }
     Function [ <internal:smbclient> function smbclient_option_set ] {

       - Parameters [3] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <required> $option ]
+        Parameter #1 [ <required> int $option ]
         Parameter #2 [ <required> $value ]
       }
     }
@@ -89,15 +94,16 @@

       - Parameters [3] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <optional> $minproto = <default> ]
-        Parameter #2 [ <optional> $maxproto = <default> ]
+        Parameter #1 [ <optional> string $minproto = null ]
+        Parameter #2 [ <optional> string $maxproto = null ]
       }
+      - Return [ bool ]
     }
     Function [ <internal:smbclient> function smbclient_opendir ] {

       - Parameters [2] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <required> $path ]
+        Parameter #1 [ <required> string $path ]
       }
     }
     Function [ <internal:smbclient> function smbclient_readdir ] {
@@ -106,6 +112,7 @@
         Parameter #0 [ <required> $state ]
         Parameter #1 [ <required> $dir ]
       }
+      - Return [ array|false ]
     }
     Function [ <internal:smbclient> function smbclient_closedir ] {

@@ -113,13 +120,15 @@
         Parameter #0 [ <required> $state ]
         Parameter #1 [ <required> $dir ]
       }
+      - Return [ bool ]
     }
     Function [ <internal:smbclient> function smbclient_stat ] {

       - Parameters [2] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <required> $path ]
+        Parameter #1 [ <required> string $path ]
       }
+      - Return [ array|false ]
     }
     Function [ <internal:smbclient> function smbclient_fstat ] {

@@ -127,22 +136,23 @@
         Parameter #0 [ <required> $state ]
         Parameter #1 [ <required> $file ]
       }
+      - Return [ array|false ]
     }
     Function [ <internal:smbclient> function smbclient_open ] {

       - Parameters [4] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <required> $path ]
-        Parameter #2 [ <required> $flags ]
-        Parameter #3 [ <optional> $mode = <default> ]
+        Parameter #1 [ <required> string $path ]
+        Parameter #2 [ <required> string $flags ]
+        Parameter #3 [ <optional> int $mode = 0666 ]
       }
     }
     Function [ <internal:smbclient> function smbclient_creat ] {

       - Parameters [3] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <required> $path ]
-        Parameter #2 [ <optional> $mode = <default> ]
+        Parameter #1 [ <required> string $path ]
+        Parameter #2 [ <optional> int $mode = 0666 ]
       }
     }
     Function [ <internal:smbclient> function smbclient_read ] {
@@ -150,8 +160,9 @@
       - Parameters [3] {
         Parameter #0 [ <required> $state ]
         Parameter #1 [ <required> $file ]
-        Parameter #2 [ <required> $count ]
+        Parameter #2 [ <required> int $count ]
       }
+      - Return [ string|false ]
     }
     Function [ <internal:smbclient> function smbclient_close ] {

@@ -159,120 +170,135 @@
         Parameter #0 [ <required> $state ]
         Parameter #1 [ <required> $file ]
       }
+      - Return [ bool ]
     }
     Function [ <internal:smbclient> function smbclient_mkdir ] {

       - Parameters [3] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <required> $path ]
-        Parameter #2 [ <optional> $mode = <default> ]
+        Parameter #1 [ <required> string $path ]
+        Parameter #2 [ <optional> int $mode = 0666 ]
       }
+      - Return [ bool ]
     }
     Function [ <internal:smbclient> function smbclient_rmdir ] {

       - Parameters [2] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <required> $path ]
+        Parameter #1 [ <required> string $path ]
       }
+      - Return [ bool ]
     }
     Function [ <internal:smbclient> function smbclient_rename ] {

       - Parameters [4] {
         Parameter #0 [ <required> $oldstate ]
-        Parameter #1 [ <required> $oldpath ]
-        Parameter #2 [ <required> $oldstate ]
-        Parameter #3 [ <required> $oldpath ]
+        Parameter #1 [ <required> string $oldpath ]
+        Parameter #2 [ <required> $newstate ]
+        Parameter #3 [ <required> string $newpath ]
       }
+      - Return [ bool ]
     }
     Function [ <internal:smbclient> function smbclient_write ] {

       - Parameters [4] {
         Parameter #0 [ <required> $state ]
         Parameter #1 [ <required> $file ]
-        Parameter #2 [ <required> $buffer ]
-        Parameter #3 [ <optional> $count = <default> ]
+        Parameter #2 [ <required> string $buffer ]
+        Parameter #3 [ <optional> int $count = 0 ]
       }
+      - Return [ int|false ]
     }
     Function [ <internal:smbclient> function smbclient_unlink ] {

       - Parameters [2] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <required> $path ]
+        Parameter #1 [ <required> string $path ]
       }
+      - Return [ bool ]
     }
     Function [ <internal:smbclient> function smbclient_lseek ] {

       - Parameters [4] {
         Parameter #0 [ <required> $state ]
         Parameter #1 [ <required> $file ]
-        Parameter #2 [ <required> $offset ]
-        Parameter #3 [ <required> $whence ]
+        Parameter #2 [ <required> int $offset ]
+        Parameter #3 [ <required> int $whence ]
       }
+      - Return [ int|false ]
     }
     Function [ <internal:smbclient> function smbclient_ftruncate ] {

       - Parameters [3] {
         Parameter #0 [ <required> $state ]
         Parameter #1 [ <required> $file ]
-        Parameter #2 [ <required> $offset ]
+        Parameter #2 [ <required> int $offset ]
       }
+      - Return [ bool ]
     }
     Function [ <internal:smbclient> function smbclient_chmod ] {

       - Parameters [3] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <required> $path ]
-        Parameter #2 [ <optional> $mode = <default> ]
+        Parameter #1 [ <required> string $path ]
+        Parameter #2 [ <required> int $mode ]
       }
+      - Return [ bool ]
     }
     Function [ <internal:smbclient> function smbclient_utimes ] {

       - Parameters [4] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <required> $path ]
-        Parameter #2 [ <required> $mtime ]
-        Parameter #3 [ <required> $atime ]
+        Parameter #1 [ <required> string $path ]
+        Parameter #2 [ <optional> int $mtime = -1 ]
+        Parameter #3 [ <optional> int $atime = -1 ]
       }
+      - Return [ bool ]
     }
     Function [ <internal:smbclient> function smbclient_listxattr ] {

       - Parameters [2] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <required> $path ]
+        Parameter #1 [ <required> string $path ]
       }
+      - Return [ array|false ]
     }
     Function [ <internal:smbclient> function smbclient_getxattr ] {

       - Parameters [3] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <required> $path ]
-        Parameter #2 [ <required> $name ]
+        Parameter #1 [ <required> string $path ]
+        Parameter #2 [ <required> string $name ]
       }
+      - Return [ string|false ]
     }
     Function [ <internal:smbclient> function smbclient_setxattr ] {

       - Parameters [5] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <required> $path ]
-        Parameter #2 [ <required> $name ]
-        Parameter #3 [ <required> $value ]
-        Parameter #4 [ <optional> $flags = <default> ]
+        Parameter #1 [ <required> string $path ]
+        Parameter #2 [ <required> string $name ]
+        Parameter #3 [ <required> string $value ]
+        Parameter #4 [ <optional> int $flags = 0 ]
       }
+      - Return [ string|false ]
     }
     Function [ <internal:smbclient> function smbclient_removexattr ] {

       - Parameters [3] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <required> $path ]
-        Parameter #2 [ <required> $name ]
+        Parameter #1 [ <required> string $path ]
+        Parameter #2 [ <required> string $name ]
       }
+      - Return [ bool ]
     }
     Function [ <internal:smbclient> function smbclient_statvfs ] {

       - Parameters [2] {
         Parameter #0 [ <required> $state ]
-        Parameter #1 [ <required> $path ]
+        Parameter #1 [ <required> string $path ]
       }
+      - Return [ array|false ]
     }
     Function [ <internal:smbclient> function smbclient_fstatvfs ] {

@@ -280,6 +306,7 @@
         Parameter #0 [ <required> $state ]
         Parameter #1 [ <required> $file ]
       }
+      - Return [ array|false ]
     }
   }
 }

remicollet commented 2 years ago

Notice: I think the change is quite important (for PHP 8+), so worth version to be bump to 1.1.0

eduardok / libsmbclient-php

generate arginfo from stub #94