...

...

@@ -4,7 +4,7 @@

4

4

<refentry xml:id="yaf-request-abstract.setmodulename" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

5

5

<refnamediv>

6

6

<refname>Yaf_Request_Abstract::setModuleName</refname>

7

-

<refpurpose>The setModuleName purpose</refpurpose>

7

+

<refpurpose>Set module name</refpurpose>

8

8

</refnamediv>

9

9

10

10

<refsect1 role="description">

...

...

@@ -12,13 +12,12 @@

12

12

<methodsynopsis>

13

13

<modifier>public</modifier> <type>void</type><methodname>Yaf_Request_Abstract::setModuleName</methodname>

14

14

<methodparam><type>string</type><parameter>module</parameter></methodparam>

15

+

<methodparam choice="opt"><type>bool</type><parameter>format_name</parameter><initializer>true</initializer></methodparam>

15

16

</methodsynopsis>

16

17

<para>

17

-

18

+

set module name to request, this is usually used by custom router to set route result module name.

18

19

</para>

19

20

20

-

&warn.undocumented.func;

21

-

22

21

</refsect1>

23

22

24

23

<refsect1 role="parameters">

...

...

@@ -28,7 +27,16 @@

28

27

<term><parameter>module</parameter></term>

29

28

<listitem>

30

29

<para>

31

-

30

+

&string; module name, it should be in camel style, like "Index" or "Foo_Bar"

31

+

</para>

32

+

</listitem>

33

+

</varlistentry>

34

+

<varlistentry>

35

+

<term><parameter>format_name</parameter></term>

36

+

<listitem>

37

+

<para>

38

+

this is introduced in Yaf 3.2.0, by default Yaf will format the name into camel mode,

39

+

if this is set to &false; , Yaf will set the original name to request.

32

40

</para>

33

41

</listitem>

34

42

</varlistentry>

35

43