[doc-en] master: Update Swoole\Table method (#4703)

From: Date: Sun, 25 May 2025 11:57:46 +0000
Subject: [doc-en] master: Update Swoole\Table method (#4703)
Groups: php.doc.cvs 
Request: Send a blank email to [email protected] to get a copy of this message
Author: Luffy (sy-records)
Committer: GitHub (web-flow)
Pusher: sy-records
Date: 2025-05-25T19:46:22+08:00

Commit: https://github.com/php/doc-en/commit/7dd504405e7eca18d548f253f5ec096510a0c7f4
Raw diff: https://github.com/php/doc-en/commit/7dd504405e7eca18d548f253f5ec096510a0c7f4.diff

Update Swoole\Table method (#4703)

Changed paths:
  M  reference/imagick/imagick/profileimage.xml
  M  reference/swoole/swoole/table/column.xml
  M  reference/swoole/swoole/table/create.xml
  M  reference/swoole/swoole/table/decr.xml
  M  reference/swoole/swoole/table/del.xml
  M  reference/swoole/swoole/table/destroy.xml
  M  reference/swoole/swoole/table/get.xml
  M  reference/swoole/swoole/table/incr.xml
  M  reference/swoole/swoole/table/key.xml
  M  reference/swoole/swoole/table/next.xml
  M  reference/swoole/swoole/table/set.xml


Diff:

diff --git a/reference/imagick/imagick/profileimage.xml b/reference/imagick/imagick/profileimage.xml
index 89b7fee5df78..98a6c6d611af 100644
--- a/reference/imagick/imagick/profileimage.xml
+++ b/reference/imagick/imagick/profileimage.xml
@@ -11,7 +11,7 @@
   <methodsynopsis>
    <modifier>public</modifier>
<type>bool</type><methodname>Imagick::profileImage</methodname>
   
<methodparam><type>string</type><parameter>name</parameter></methodparam>
-  
<methodparam><type>?string</type><parameter>profile</parameter></methodparam>
+   <methodparam
choice="opt"><type>string</type><parameter>profile</parameter></methodparam>
   </methodsynopsis>
   <para>
    Adds or removes a ICC, IPTC, or generic profile from an image.
diff --git a/reference/swoole/swoole/table/column.xml b/reference/swoole/swoole/table/column.xml
index e8552d00d5a3..ab138d57c087 100644
--- a/reference/swoole/swoole/table/column.xml
+++ b/reference/swoole/swoole/table/column.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
<type>ReturnType</type><methodname>Swoole\Table::column</methodname>
+   <modifier>public</modifier>
<type>bool</type><methodname>Swoole\Table::column</methodname>
   
<methodparam><type>string</type><parameter>name</parameter></methodparam>
   
<methodparam><type>string</type><parameter>type</parameter></methodparam>
    <methodparam
choice="opt"><type>int</type><parameter>size</parameter></methodparam>
@@ -28,7 +28,7 @@
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
-      
+      Specify the name of the field.
      </para>
     </listitem>
    </varlistentry>
@@ -36,7 +36,7 @@
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
-      
+      Specify the field type.
      </para>
     </listitem>
    </varlistentry>
@@ -44,7 +44,7 @@
     <term><parameter>size</parameter></term>
     <listitem>
      <para>
-      
+      Specify the maximum length of the string field.
      </para>
     </listitem>
    </varlistentry>
diff --git a/reference/swoole/swoole/table/create.xml b/reference/swoole/swoole/table/create.xml
index a355fd23c0d2..ceed5590167a 100644
--- a/reference/swoole/swoole/table/create.xml
+++ b/reference/swoole/swoole/table/create.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
<type>void</type><methodname>Swoole\Table::create</methodname>
+   <modifier>public</modifier>
<type>bool</type><methodname>Swoole\Table::create</methodname>
    <void />
   </methodsynopsis>
   <para>
diff --git a/reference/swoole/swoole/table/decr.xml b/reference/swoole/swoole/table/decr.xml
index 16b5eee1ec55..84923f3d6b5c 100644
--- a/reference/swoole/swoole/table/decr.xml
+++ b/reference/swoole/swoole/table/decr.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
<type>ReturnType</type><methodname>Swoole\Table::decr</methodname>
+   <modifier>public</modifier>
<type>int</type><methodname>Swoole\Table::decr</methodname>
   
<methodparam><type>string</type><parameter>key</parameter></methodparam>
   
<methodparam><type>string</type><parameter>column</parameter></methodparam>
    <methodparam
choice="opt"><type>int</type><parameter>decrby</parameter></methodparam>
@@ -28,7 +28,7 @@
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
-      
+      Key of the data.
      </para>
     </listitem>
    </varlistentry>
@@ -36,7 +36,7 @@
     <term><parameter>column</parameter></term>
     <listitem>
      <para>
-      
+      Specify the column name.
      </para>
     </listitem>
    </varlistentry>
@@ -44,7 +44,7 @@
     <term><parameter>decrby</parameter></term>
     <listitem>
      <para>
-      
+      Increment value.
      </para>
     </listitem>
    </varlistentry>
diff --git a/reference/swoole/swoole/table/del.xml b/reference/swoole/swoole/table/del.xml
index cfae839ef4c5..de9fec78d69e 100644
--- a/reference/swoole/swoole/table/del.xml
+++ b/reference/swoole/swoole/table/del.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
<type>void</type><methodname>Swoole\Table::del</methodname>
+   <modifier>public</modifier>
<type>bool</type><methodname>Swoole\Table::del</methodname>
   
<methodparam><type>string</type><parameter>key</parameter></methodparam>
   </methodsynopsis>
   <para>
diff --git a/reference/swoole/swoole/table/destroy.xml b/reference/swoole/swoole/table/destroy.xml
index 75fd85f3dbfc..305919efe850 100644
--- a/reference/swoole/swoole/table/destroy.xml
+++ b/reference/swoole/swoole/table/destroy.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
<type>void</type><methodname>Swoole\Table::destroy</methodname>
+   <modifier>public</modifier>
<type>bool</type><methodname>Swoole\Table::destroy</methodname>
    <void />
   </methodsynopsis>
   <para>
diff --git a/reference/swoole/swoole/table/get.xml b/reference/swoole/swoole/table/get.xml
index 6d2a33cf663c..6fc25128a22d 100644
--- a/reference/swoole/swoole/table/get.xml
+++ b/reference/swoole/swoole/table/get.xml
@@ -4,15 +4,15 @@
 <refentry xml:id="swoole-table.get" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Swoole\Table::get</refname>
-  <refpurpose>Get the value in the Swoole table by $row_key and
$column_key.</refpurpose>
+  <refpurpose>Get the value in the Swoole table by $key and $field.</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
<type>int</type><methodname>Swoole\Table::get</methodname>
-  
<methodparam><type>string</type><parameter>row_key</parameter></methodparam>
-  
<methodparam><type>string</type><parameter>column_key</parameter></methodparam>
+   <modifier>public</modifier>
<type>mixed</type><methodname>Swoole\Table::get</methodname>
+  
<methodparam><type>string</type><parameter>key</parameter></methodparam>
+   <methodparam
choice="opt"><type>string</type><parameter>field</parameter></methodparam>
   </methodsynopsis>
   <para>
 
@@ -24,7 +24,7 @@
   &reftitle.parameters;
   <variablelist>
    <varlistentry>
-    <term><parameter>row_key</parameter></term>
+    <term><parameter>key</parameter></term>
     <listitem>
      <para>
       
@@ -32,7 +32,7 @@
     </listitem>
    </varlistentry>
    <varlistentry>
-    <term><parameter>column_key</parameter></term>
+    <term><parameter>field</parameter></term>
     <listitem>
      <para>
       
diff --git a/reference/swoole/swoole/table/incr.xml b/reference/swoole/swoole/table/incr.xml
index 4bd01bbaf9d0..a6aba9c2986e 100644
--- a/reference/swoole/swoole/table/incr.xml
+++ b/reference/swoole/swoole/table/incr.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
<type>void</type><methodname>Swoole\Table::incr</methodname>
+   <modifier>public</modifier>
<type>int</type><methodname>Swoole\Table::incr</methodname>
   
<methodparam><type>string</type><parameter>key</parameter></methodparam>
   
<methodparam><type>string</type><parameter>column</parameter></methodparam>
    <methodparam
choice="opt"><type>int</type><parameter>incrby</parameter></methodparam>
@@ -28,7 +28,7 @@
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
-      
+      Key for the data.
      </para>
     </listitem>
    </varlistentry>
@@ -36,7 +36,7 @@
     <term><parameter>column</parameter></term>
     <listitem>
      <para>
-      
+      Specify the column name.
      </para>
     </listitem>
    </varlistentry>
@@ -44,7 +44,7 @@
     <term><parameter>incrby</parameter></term>
     <listitem>
      <para>
-      
+      Increment value.
      </para>
     </listitem>
    </varlistentry>
diff --git a/reference/swoole/swoole/table/key.xml b/reference/swoole/swoole/table/key.xml
index c8231924fb5b..73548faec0c0 100644
--- a/reference/swoole/swoole/table/key.xml
+++ b/reference/swoole/swoole/table/key.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
<type>string</type><methodname>Swoole\Table::key</methodname>
+   <modifier>public</modifier>
<type>mixed</type><methodname>Swoole\Table::key</methodname>
    <void />
   </methodsynopsis>
   <para>
diff --git a/reference/swoole/swoole/table/next.xml b/reference/swoole/swoole/table/next.xml
index 84cd9256b89e..15d40500f1d6 100644
--- a/reference/swoole/swoole/table/next.xml
+++ b/reference/swoole/swoole/table/next.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
<type>ReturnType</type><methodname>Swoole\Table::next</methodname>
+   <modifier>public</modifier>
<type>void</type><methodname>Swoole\Table::next</methodname>
    <void />
   </methodsynopsis>
   <para>
diff --git a/reference/swoole/swoole/table/set.xml b/reference/swoole/swoole/table/set.xml
index cd8780c9947e..6c4c2656c572 100644
--- a/reference/swoole/swoole/table/set.xml
+++ b/reference/swoole/swoole/table/set.xml
@@ -4,13 +4,13 @@
 <refentry xml:id="swoole-table.set" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Swoole\Table::set</refname>
-  <refpurpose>Update a row of the table by $row_key.</refpurpose>
+  <refpurpose>Update a row of the table by $key.</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier>
<type>VOID</type><methodname>Swoole\Table::set</methodname>
+   <modifier>public</modifier>
<type>bool</type><methodname>Swoole\Table::set</methodname>
   
<methodparam><type>string</type><parameter>key</parameter></methodparam>
   
<methodparam><type>array</type><parameter>value</parameter></methodparam>
   </methodsynopsis>
@@ -27,7 +27,7 @@
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
-      
+      Key of the data.
      </para>
     </listitem>
    </varlistentry>
@@ -35,7 +35,7 @@
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
-      
+      Value of the data.
      </para>
     </listitem>
    </varlistentry>


Thread (1 message)

  • Luffy via GitHub
« previous php.doc.cvs (#22677) next »