Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit0d37a3b

Browse files
committed
Applied comments
1 parent3b3cd6f commit0d37a3b

File tree

2 files changed

+78
-50
lines changed

2 files changed

+78
-50
lines changed

‎components/form/type_guesser.rst

Lines changed: 72 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -11,36 +11,42 @@ type guessers.
1111

1212
..sidebar::Form Type Guessers in the Bridges
1313

14-
Symfony also provides some form type guessers in the bridges. These can be
15-
used if you use that library.
14+
Symfony also provides some form type guessers in the bridges:
1615

1716
*:class:`Symfony\\Bridge\\Propel1\\Form\\PropelTypeGuesser` provided by
1817
the Propel1 bridge;
1918
*:class:`Symfony\\Bridge\\Doctrine\\Form\\DoctrineOrmTypeGuesser`
2019
provided by the Doctrine bridge.
2120

22-
A PHPDoc Type Guesser
23-
---------------------
21+
Create a PHPDoc Type Guesser
22+
----------------------------
2423

25-
In this section, you are going to build aPHPDoc typeguesser. At first, you
26-
need to create a class which extends
27-
:class:`Symfony\\Component\\Form\\FormTypeGuesserInterface`. This interface
28-
requires 4 methods:
24+
In this section, you are going to build a guesser that reads information about
25+
fields from the PHPDoc of the properties. At first, youneed to create a class
26+
which implements:class:`Symfony\\Component\\Form\\FormTypeGuesserInterface`.
27+
This interfacerequires 4 methods:
2928

3029
*:method:`Symfony\\Component\\Form\\FormTypeGuesserInterface::guessType` -
3130
tries to guess the type of a field;
3231
*:method:`Symfony\\Component\\Form\\FormTypeGuesserInterface::guessRequired` -
33-
tries to guess the value of the ``required`` option;
32+
tries to guess the value of the:ref:`required<reference-form-option-required>`
33+
option;
3434
*:method:`Symfony\\Component\\Form\\FormTypeGuesserInterface::guessMaxLength` -
35-
tries to guess the value of the ``max_length`` option;
35+
tries to guess the value of the:ref:`max_length<reference-form-option-max_length>`
36+
option;
3637
*:method:`Symfony\\Component\\Form\\FormTypeGuesserInterface::guessPattern` -
37-
tries to guess the value of the ``pattern`` option.
38+
tries to guess the value of the:ref:`pattern<reference-form-option-pattern>`
39+
option.
3840

39-
The most basic class looks like::
41+
Start by creating the class and these methods. Next, you'll learn how to fill each on.
42+
43+
..code-block::php
44+
45+
namespace Acme\Form;
4046
4147
use Symfony\Component\Form\FormTypeGuesserInterface;
4248
43-
classPHPDocTypeGuesser implements FormTypeGuesserInterface
49+
classPhpdocTypeGuesser implements FormTypeGuesserInterface
4450
{
4551
public function guessType($class, $property)
4652
{
@@ -69,54 +75,70 @@ that the type guesser cannot guess the type.
6975
The ``TypeGuess`` constructor requires 3 options:
7076

7177
* The type name (one of the:doc:`form types </reference/forms/types`);
72-
*Additionally options (for instance, when the type is ``entity``, you also
78+
*Additional options (for instance, when the type is ``entity``, you also
7379
want to set the ``class`` option). If no types are guessed, this should be
7480
set to an empty array;
7581
* The confidence that the guessed type is correct. This can be one of the
7682
constants of the:class:`Symfony\\Component\\Form\\Guess\Guess` class:
7783
``LOW_CONFIDENCE``, ``MEDIUM_CONFIDENCE``, ``HIGH_CONFIDENCE``,
78-
``VERY_HIGH_CONFIDENCE``. After all type guessersareexecuted, the type
79-
with the highest confidence is used.
84+
``VERY_HIGH_CONFIDENCE``. After all type guessershave beenexecuted, the
85+
typewith the highest confidence is used.
8086

8187
With this knowledge, you can easily implement the ``guessType`` method of the
8288
``PHPDocTypeGuesser``::
8389

90+
namespace Acme\Form;
91+
8492
use Symfony\Component\Form\Guess\Guess;
8593
use Symfony\Component\Form\Guess\TypeGuess;
8694

87-
// ...
88-
public function guessType($class, $property)
95+
class PhpdocTypeGuesser implements FormTypeGuesserInterface
8996
{
90-
$annotations = $this->readPhpDocAnnotations($class, $property);
91-
92-
if (!isset($annotations['var'])) {
93-
return; // guess nothing if the @var annotation is not available
97+
public function guessType($class, $property)
98+
{
99+
$annotations = $this->readPhpDocAnnotations($class, $property);
100+
101+
if (!isset($annotations['var'])) {
102+
return; // guess nothing if the @var annotation is not available
103+
}
104+
105+
// otherwise, base the type on the @var annotation
106+
switch ($annotations['var']) {
107+
case 'string':
108+
// there is a high confidence that the type is a string when
109+
// @var string is used
110+
return new TypeGuess('text', array(), Guess::HIGH_CONFIDENCE);
111+
112+
case 'int':
113+
case 'integer':
114+
// integers can also be the id of an entity or a checkbox (0 or 1)
115+
return new TypeGuess('integer', array(), Guess::MEDIUM_CONFIDENCE);
116+
117+
case 'float':
118+
case 'double':
119+
case 'real':
120+
return new TypeGuess('number', array(), Guess::MEDIUM_CONFIDENCE);
121+
122+
case 'boolean':
123+
case 'bool':
124+
return new TypeGuess('checkbox', array(), Guess::HIGH_CONFIDENCE);
125+
126+
default:
127+
// there is a very low confidence that this one is correct
128+
return new TypeGuess('text', array(), Guess::LOW_CONFIDENCE);
129+
}
94130
}
95131

96-
// otherwise, base the type on the @var annotation
97-
switch ($annotations['var']) {
98-
case 'string':
99-
// there is a high confidence that the type is a string when
100-
// @var string is used
101-
return new TypeGuess('text', array(), Guess::HIGH_CONFIDENCE);
102-
103-
case 'int':
104-
case 'integer':
105-
// integers can also be the id of an entity or a checkbox (0 or 1)
106-
return new TypeGuess('integer', array(), Guess::MEDIUM_CONFIDENCE);
107-
108-
case 'float':
109-
case 'double':
110-
case 'real':
111-
return new TypeGuess('number', array(), Guess::MEDIUM_CONFIDENCE);
112-
113-
case 'boolean':
114-
case 'bool':
115-
return new TypeGuess('checkbox', array(), Guess::HIGH_CONFIDENCE);
116-
117-
default:
118-
// there is a very low confidence that this one is correct
119-
return new TypeGuess('text', array(), Guess::LOW_CONFIDENCE);
132+
protected function readPhpDocAnnotations($class, $property)
133+
{
134+
$reflectionProperty = new \ReflectionProperty($class, $property);
135+
$phpdoc = $reflectionProperty->getDocComment();
136+
137+
// parse the $phpdoc into an array like:
138+
// array('type' => 'string', 'since' => '1.0')
139+
$phpdocTags = ...;
140+
141+
return $phpdocTags;
120142
}
121143
}
122144

@@ -139,10 +161,10 @@ set.
139161

140162
..caution::
141163

142-
You should be very carefulwith the ``guessPattern`` method. When the
164+
You should be very carefulusing the ``guessPattern`` method. When the
143165
type is a float, you cannot use it to determine a min or max value of the
144166
float (e.g. you want a float to be greater than ``5``, ``4.512313`` is not valid
145-
but ``length(4.512314) > length(5)`` is, so the pattern willsuccess). In
167+
but ``length(4.512314) > length(5)`` is, so the pattern willsucceed). In
146168
this case, the value should be set to ``null`` with a ``MEDIUM_CONFIDENCE``.
147169

148170
Registering a Type Guesser
@@ -164,6 +186,6 @@ The last thing you need to do is registering your custom type guesser by using
164186

165187
..note::
166188

167-
When you use thefull stackframework, you need to register your type
168-
guesserand tag it with ``form.type_guesser``. For more information see
189+
When you use theSymfonyframework, you need to register your type guesser
190+
and tag it with ``form.type_guesser``. For more information see
169191
:ref:`the tag reference<reference-dic-type_guesser>`.

‎reference/forms/types/form.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ on all fields.
1717

1818
..include::/reference/forms/types/options/empty_data.rst.inc
1919

20+
.. _reference-form-option-required:
21+
2022
..include::/reference/forms/types/options/required.rst.inc
2123

2224
..include::/reference/forms/types/options/label.rst.inc
@@ -43,6 +45,8 @@ on all fields.
4345

4446
..include::/reference/forms/types/options/block_name.rst.inc
4547

48+
.. _reference-form-option-max_length:
49+
4650
..include::/reference/forms/types/options/max_length.rst.inc
4751

4852
..include::/reference/forms/types/options/by_reference.rst.inc
@@ -61,4 +65,6 @@ on all fields.
6165

6266
..include::/reference/forms/types/options/post_max_size_message.rst.inc
6367

68+
.. _reference-form-option-pattern:
69+
6470
..include::/reference/forms/types/options/pattern.rst.inc

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp