svn: /phpdoc/ja/trunk/reference/yaf/yaf_request_abstract/ setactionname.xml setcontrollername.xml setmodulename.xml

[email protected] (Yoshinari Takaoka)
Newsgroups php.doc.ja
Message-ID <[email protected]> 
mumumu                                   Wed, 22 Apr 2020 19:24:45 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=349691

Log:
Added intro for new parameters of Yaf_Request::Set(Module/Controller/Action)Name

Changed paths:
    U   phpdoc/ja/trunk/reference/yaf/yaf_request_abstract/setactionname.xml
    U   phpdoc/ja/trunk/reference/yaf/yaf_request_abstract/setcontrollername.xml
    U   phpdoc/ja/trunk/reference/yaf/yaf_request_abstract/setmodulename.xml

Modified: phpdoc/ja/trunk/reference/yaf/yaf_request_abstract/setactionname.xml
===================================================================
--- phpdoc/ja/trunk/reference/yaf/yaf_request_abstract/setactionname.xml	2020-04-22 15:52:31 UTC (rev 349690)
+++ phpdoc/ja/trunk/reference/yaf/yaf_request_abstract/setactionname.xml	2020-04-22 19:24:45 UTC (rev 349691)
@@ -1,11 +1,12 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 317663 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 349681 Maintainer: takagi Status: ready -->
+<!-- Credits: mumumu -->

 <refentry xml:id="yaf-request-abstract.setactionname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Request_Abstract::setActionName</refname>
-  <refpurpose>The setActionName purpose</refpurpose>
+  <refpurpose>アクション名を設定する</refpurpose>
  </refnamediv>

  <refsect1 role="description">
@@ -13,13 +14,13 @@
   <methodsynopsis>
    <modifier>public</modifier> <type>void</type><methodname>Yaf_Request_Abstract::setActionName</methodname>
    <methodparam><type>string</type><parameter>action</parameter></methodparam>
+   <methodparam choice="opt"><type>bool</type><parameter>format_name</parameter><initializer>true</initializer></methodparam>
   </methodsynopsis>
   <para>
-
+   アクション名をリクエストに設定します。
+   このメソッドは通常、ルーティング結果のコントローラー名を設定するカスタムルータで使います。
   </para>

-  &warn.undocumented.func;
-
  </refsect1>

  <refsect1 role="parameters">
@@ -29,10 +30,21 @@
     <term><parameter>action</parameter></term>
     <listitem>
      <para>
-
+      アクション名を表す&string;。
+      "index" や "foo_Bar" のように、小文字で表記すべきです。
      </para>
     </listitem>
    </varlistentry>
+   <varlistentry>
+    <term><parameter>format_name</parameter></term>
+    <listitem>
+     <para>
+      Yaf 3.2.0 で追加されました。
+      デフォルトでは、Yaf は名前を小文字に変換しますが、
+      このパラメータを &false; に設定すると、指定された値そのままをリクエストに使います。
+     </para>
+    </listitem>
+   </varlistentry>
   </variablelist>
  </refsect1>


Modified: phpdoc/ja/trunk/reference/yaf/yaf_request_abstract/setcontrollername.xml
===================================================================
--- phpdoc/ja/trunk/reference/yaf/yaf_request_abstract/setcontrollername.xml	2020-04-22 15:52:31 UTC (rev 349690)
+++ phpdoc/ja/trunk/reference/yaf/yaf_request_abstract/setcontrollername.xml	2020-04-22 19:24:45 UTC (rev 349691)
@@ -1,11 +1,12 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 317663 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 349681 Maintainer: takagi Status: ready -->
+<!-- Credits: mumumu -->

 <refentry xml:id="yaf-request-abstract.setcontrollername" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Request_Abstract::setControllerName</refname>
-  <refpurpose>The setControllerName purpose</refpurpose>
+  <refpurpose>コントローラー名を設定する</refpurpose>
  </refnamediv>

  <refsect1 role="description">
@@ -13,13 +14,13 @@
   <methodsynopsis>
    <modifier>public</modifier> <type>void</type><methodname>Yaf_Request_Abstract::setControllerName</methodname>
    <methodparam><type>string</type><parameter>controller</parameter></methodparam>
+   <methodparam choice="opt"><type>bool</type><parameter>format_name</parameter><initializer>true</initializer></methodparam>
   </methodsynopsis>
   <para>
-
+    コントローラー名をリクエストに設定します。
+    このメソッドは通常、ルーティング結果のコントローラー名を設定するカスタムルータで使います。
   </para>

-  &warn.undocumented.func;
-
  </refsect1>

  <refsect1 role="parameters">
@@ -29,10 +30,21 @@
     <term><parameter>controller</parameter></term>
     <listitem>
      <para>
-
+      コントローラー名を表す &string;。
+      "Index" や "Foo_Bar" のように、キャメルケースで表記すべきです。
      </para>
     </listitem>
    </varlistentry>
+   <varlistentry>
+    <term><parameter>format_name</parameter></term>
+    <listitem>
+     <para>
+      Yaf 3.2.0 で追加されました。
+      デフォルトでは、Yaf は名前をキャメルケースでフォーマットしますが、
+      このパラメータを &false; に設定すると、指定された値そのままをリクエストに使います。
+     </para>
+    </listitem>
+   </varlistentry>
   </variablelist>
  </refsect1>


Modified: phpdoc/ja/trunk/reference/yaf/yaf_request_abstract/setmodulename.xml
===================================================================
--- phpdoc/ja/trunk/reference/yaf/yaf_request_abstract/setmodulename.xml	2020-04-22 15:52:31 UTC (rev 349690)
+++ phpdoc/ja/trunk/reference/yaf/yaf_request_abstract/setmodulename.xml	2020-04-22 19:24:45 UTC (rev 349691)
@@ -1,11 +1,12 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 317663 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 349681 Maintainer: takagi Status: ready -->
+<!-- Credits: mumumu -->

 <refentry xml:id="yaf-request-abstract.setmodulename" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Request_Abstract::setModuleName</refname>
-  <refpurpose>The setModuleName purpose</refpurpose>
+  <refpurpose>モジュール名を設定する</refpurpose>
  </refnamediv>

  <refsect1 role="description">
@@ -13,13 +14,13 @@
   <methodsynopsis>
    <modifier>public</modifier> <type>void</type><methodname>Yaf_Request_Abstract::setModuleName</methodname>
    <methodparam><type>string</type><parameter>module</parameter></methodparam>
+   <methodparam choice="opt"><type>bool</type><parameter>format_name</parameter><initializer>true</initializer></methodparam>
   </methodsynopsis>
   <para>
-
+   リクエストするモジュール名を設定します。
+   このメソッドは通常、ルーティング結果のモジュール名を設定するカスタムルータで使います。
   </para>

-  &warn.undocumented.func;
-
  </refsect1>

  <refsect1 role="parameters">
@@ -29,10 +30,21 @@
     <term><parameter>module</parameter></term>
     <listitem>
      <para>
-
+      モジュール名を表す&string;。
+      "Index" や "Foo_Bar" のように、キャメルケースで表記すべきです。
      </para>
     </listitem>
    </varlistentry>
+   <varlistentry>
+    <term><parameter>format_name</parameter></term>
+    <listitem>
+     <para>
+      Yaf 3.2.0 で追加されました。
+      デフォルトでは、Yaf は名前をキャメルケースでフォーマットしますが、
+      このパラメータを &false; に設定すると、指定された値そのままをリクエストに使います。
+     </para>
+    </listitem>
+   </varlistentry>
   </variablelist>
  </refsect1>
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.