8000 [PropertyAccess] Remove trailing periods from doc blocks · symfony/symfony@bdb8473 · GitHub
[go: up one dir, main page]
Skip to content

Commit bdb8473

Browse files
jmikolajmikola
committed
[PropertyAccess] Remove trailing periods from doc blocks
Periods were left in place for entries with multiple sentences/statements.
1 parent 2d4c1d8 commit bdb8473

File tree

6 files changed

+66
-66
lines changed

6 files changed

+66
-66
lines changed

‎src/Symfony/Component/PropertyAccess/PropertyAccess.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ final class PropertyAccess
2121
/**
2222
* Creates a property accessor with the default configuration.
2323
*
24-
* @return PropertyAccessor The new property accessor.
24+
* @return PropertyAccessor The new property accessor
2525
*/
2626
public static function getPropertyAccessor()
2727
{

‎src/Symfony/Component/PropertyAccess/PropertyAccessor.php

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@ public function setValue(&$objectOrArray, $propertyPath, $value)
9696
/**
9797
* Reads the path from an object up to a given path index.
9898
*
99-
* @param object|array $objectOrArray The object or array to read from.
100-
* @param PropertyPathInterface $propertyPath The property path to read.
101-
* @param integer $lastIndex The integer up to which should be read.
99+
* @param object|array $objectOrArray The object or array to read from
100+
* @param PropertyPathInterface $propertyPath The property path to read
101+
* @param integer $lastIndex The index up to which should be read
102102
*
103103
* @return array The values read in the path.
104104
*
@@ -139,12 +139,12 @@ private function &readPropertiesUntil(&$objectOrArray, PropertyPathInterface $pr
139139
/**
140140
* Reads a key from an array-like structure.
141141
*
142-
* @param \ArrayAccess|array $array The array or \ArrayAccess object to read from.
143-
* @param string|integer $index The key to read.
142+
* @param \ArrayAccess|array $array The array or \ArrayAccess object to read from
143+
* @param string|integer $index The key to read
144144
*
145145
* @return mixed The value of the key
146146
*
147-
* @throws NoSuchPropertyException If the array does not implement \ArrayAccess or it is not an array.
147+
* @throws NoSuchPropertyException If the array does not implement \ArrayAccess or it is not an array
148148
*/
149149
private function &readIndex(&$array, $index)
150150
{
@@ -180,9 +180,9 @@ private function &readIndex(&$array, $index)
180180
*
181181
* @return mixed The value of the read property
182182
*
183-
* @throws NoSuchPropertyException If the property does not exist.
183+
* @throws NoSuchPropertyException If the property does not exist
184184
* @throws PropertyAccessDeniedException If the property cannot be accessed due to
185-
* access restrictions (private or protected).
185+
* access restrictions (private or protected)
186186
*/
187187
private function &readProperty(&$object, $property)
188188
{
@@ -250,11 +250,11 @@ private function &readProperty(&$object, $property)
250250
/**
251251
* Sets the value of the property at the given index in the path
252252
*
253-
* @param \ArrayAccess|array $array An array or \ArrayAccess object to write to.
254-
* @param string|integer $index The index to write at.
255-
* @param mixed $value The value to write.
253+
* @param \ArrayAccess|array $array An array or \ArrayAccess object to write to
254+
* @param string|integer $index The index to write at
255+
* @param mixed $value The value to write
256256
*
257-
* @throws NoSuchPropertyException If the array does not implement \ArrayAccess or it is not an array.
257+
* @throws NoSuchPropertyException If the array does not implement \ArrayAccess or it is not an array
258258
*/
259259
private function writeIndex(&$array, $index, $value)
260260
{
@@ -268,14 +268,14 @@ private function writeIndex(&$array, $index, $value)
268268
/**
269269
* Sets the value of the property at the given index in the path
270270
*
271-
* @param object|array $object The object or array to write to.
272-
* @param string $property The property to write.
273-
* @param string|null $singular The singular form of the property name or null.
274-
* @param mixed $value The value to write.
271+
* @param object|array $object The object or array to write to
272+
* @param string $property The property to write
273+
* @param string|null $singular The singular form of the property name or null
274+
* @param mixed $value The value to write
275275
*
276-
* @throws NoSuchPropertyException If the property does not exist.
276+
* @throws NoSuchPropertyException If the property does not exist
277277
* @throws PropertyAccessDeniedException If the property cannot be accessed due to
278-
* access restrictions (private or protected).
278+
* access restrictions (private or protected)
279279
*/
280280
private function writeProperty(&$object, $property, $singular, $value)
281281
{
@@ -368,9 +368,9 @@ private function writeProperty(&$object, $property, $singular, $value)
368368
/**
369369
* Camelizes a given string.
370370
*
371-
* @param string $string Some string.
371+
* @param string $string Some string
372372
*
373-
* @return string The camelized version of the string.
373+
* @return string The camelized version of the string
374374
*/
375375
private function camelize($string)
376376
{
@@ -381,11 +381,11 @@ private function camelize($string)
381381
* Searches for add and remove methods.
382382
*
383383
* @param \ReflectionClass $reflClass The reflection class for the given object
384-
* @param array $singulars The singular form of the property name or null.
384+
* @param array $singulars The singular form of the property name or null
385385
*
386-
* @return array|null An array containing the adder and remover when found, null otherwise.
386+
* @return array|null An array containing the adder and remover when found, null otherwise
387387
*
388-
* @throws NoSuchPropertyException If the property does not exist.
388+
* @throws NoSuchPropertyException If the property does not exist
389389
*/
390390
private function findAdderAndRemover(\ReflectionClass $reflClass, array $singulars)
391391
{
@@ -416,12 +416,12 @@ private function findAdderAndRemover(\ReflectionClass $reflClass, array $singula
416416
/**
417417
* Returns whether a method is public and has a specific number of required parameters.
418418
*
419-
* @param \ReflectionClass $class The class of the method.
420-
* @param string $methodName The method name.
421-
* @param integer $parameters The number of parameters.
419+
* @param \ReflectionClass $class The class of the method
420+
* @param string $methodName The method name
421+
* @param integer $parameters The number of parameters
422422
*
423423
* @return Boolean Whether the method is public and has $parameters
424-
* required parameters.
424+
* required parameters
425425
*/
426426
private function isAccessible(\ReflectionClass $class, $methodName, $parameters)
427427
{

‎src/Symfony/Component/PropertyAccess/PropertyAccessorInterface.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,15 @@ interface PropertyAccessorInterface
3939
*
4040
* If neither is found, an exception is thrown.
4141
*
42-
* @param object|array $objectOrArray The object or array to modify.
43-
* @param string|PropertyPathInterface $propertyPath The property path to modify.
44-
* @param mixed $value The value to set at the end of the property path.
42+
* @param object|array $objectOrArray The object or array to modify
43+
* @param string|PropertyPathInterface $propertyPath The property path to modify
44+
* @param mixed $value The value to set at the end of the property path
4545
*
46-
* @throws Exception\NoSuchPropertyException If a property does not exist.
46+
* @throws Exception\NoSuchPropertyException If a property does not exist
4747
* @throws Exception\PropertyAccessDeniedException If a property cannot be accessed due to
48-
* access restrictions (private or protected).
48+
* access restrictions (private or protected)
4949
* @throws Exception\UnexpectedTypeException If a value within the path is neither object
50-
* nor array.
50+
* nor array
5151
*/
5252
public function setValue(&$objectOrArray, $propertyPath, $value);
5353

@@ -72,8 +72,8 @@ public function setValue(&$objectOrArray, $propertyPath, $value);
7272
*
7373
* If none of them are found, an exception is thrown.
7474
*
75-
* @param object|array $objectOrArray The object or array to traverse.
76-
* @param string|PropertyPathInterface $propertyPath The property path to read.
75+
* @param object|array $objectOrArray The object or array to traverse
76+
* @param string|PropertyPathInterface $propertyPath The property path to read
7777
*
7878
* @return mixed The value at the end of the property path
7979
*

‎src/Symfony/Component/PropertyAccess/PropertyPath.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,10 @@ class PropertyPath implements \IteratorAggregate, PropertyPathInterface
6262
/**
6363
* Constructs a property path from a string.
6464
*
65-
* @param PropertyPath|string $propertyPath The property path as string or instance.
65+
* @param PropertyPath|string $propertyPath The property path as string or instance
6666
*
67-
* @throws UnexpectedTypeException If the given path is not a string.
68-
* @throws InvalidPropertyPathException If the syntax of the property path is not valid.
67+
* @throws UnexpectedTypeException If the given path is not a string
68+
* @throws InvalidPropertyPathException If the syntax of the property path is not valid
6969
*/
7070
public function __construct($propertyPath)
7171
{

‎src/Symfony/Component/PropertyAccess/PropertyPathBuilder.php

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ public function __construct(PropertyPathInterface $path = null)
4444
/**
4545
* Appends a (sub-) path to the current path.
4646
*
47-
* @param PropertyPathInterface $path The path to append.
47+
* @param PropertyPathInterface $path The path to append
4848
* @param integer $offset The offset where the appended piece
49-
* starts in $path.
49+
* starts in $path
5050
* @param integer $length The length of the appended piece.
5151
* If 0, the full path is appended.
5252
*/
@@ -67,7 +67,7 @@ public function append(PropertyPathInterface $path, $offset = 0, $length = 0)
6767
/**
6868
* Appends an index element to the current path.
6969
*
70-
* @param string $name The name of the appended index.
70+
* @param string $name The name of the appended index
7171
*/
7272
public function appendIndex($name)
7373
{
@@ -78,7 +78,7 @@ public function appendIndex($name)
7878
/**
7979
* Appends a property element to the current path.
8080
*
81-
* @param string $name The name of the appended property.
81+
* @param string $name The name of the appended property
8282
*/
8383
public function appendProperty($name)
8484
{
@@ -89,8 +89,8 @@ public function appendProperty($name)
8989
/**
9090
* Removes elements from the current path.
9191
*
92-
* @param integer $offset The offset at which to remove.
93-
* @param integer $length The length of the removed piece.
92+
* @param integer $offset The offset at which to remove
93+
* @param integer $length The length of the removed piece
9494
*
9595
* @throws OutOfBoundsException if offset is invalid
9696
*/
@@ -106,15 +106,15 @@ public function remove($offset, $length = 1)
106106
/**
107107
* Replaces a sub-path by a different (sub-) path.
108108
*
109-
* @param integer $offset The offset at which to replace.
110-
* @param integer $length The length of the piece to replace.
111-
* @param PropertyPathInterface $path The path to insert.
109+
* @param integer $offset The offset at which to replace
110+
* @param integer $length The length of the piece to replace
111+
* @param PropertyPathInterface $path The path to insert
112112
* @param integer $pathOffset The offset where the inserted piece
113-
* starts in $path.
113+
* starts in $path
114114
* @param integer $pathLength The length of the inserted piece.
115115
* If 0, the full path is inserted.
116116
*
117-
* @throws OutOfBoundsException If the offset is invalid.
117+
* @throws OutOfBoundsException If the offset is invalid
118118
*/
119119
public function replace($offset, $length, PropertyPathInterface $path, $pathOffset = 0, $pathLength = 0)
120120
{
@@ -137,10 +137,10 @@ public function replace($offset, $length, PropertyPathInterface $path, $pathOffs
137137
/**
138138
* Replaces a property element by an index element.
139139
*
140-
* @param integer $offset The offset at which to replace.
140+
* @param integer $offset The offset at which to replace
141141
* @param string $name The new name of the element. Optional.
142142
*
143-
* @throws OutOfBoundsException If the offset is invalid.
143+
* @throws OutOfBoundsException If the offset is invalid
144144
*/
145145
public function replaceByIndex($offset, $name = null)
146146
{
@@ -158,10 +158,10 @@ public function replaceByIndex($offset, $name = null)
158158
/**
159159
* Replaces an index element by a property element.
160160
*
161-
* @param integer $offset The offset at which to replace.
161+
* @param integer $offset The offset at which to replace
162162
* @param string $name The new name of the element. Optional.
163163
*
164-
* @throws OutOfBoundsException If the offset is invalid.
164+
* @throws OutOfBoundsException If the offset is invalid
165165
*/
166166
public function replaceByProperty($offset, $name = null)
167167
{
@@ -179,7 +179,7 @@ public function replaceByProperty($offset, $name = null)
179179
/**
180180
* Returns the length of the current path.
181181
*
182-
* @return integer The path length.
182+
* @return integer The path length
183183
*/
184184
public function getLength()
185185
{
@@ -189,7 +189,7 @@ public function getLength()
189189
/**
190190
* Returns the current property path.
191191
*
192-
* @return PropertyPathInterface The constructed property path.
192+
* @return PropertyPathInterface The constructed property path
193193
*/
194194
public function getPropertyPath()
195195
{
@@ -201,7 +201,7 @@ public function getPropertyPath()
201201
/**
202202
* Returns the current property path as string.
203203
*
204-
* @return string The property path as string.
204+
* @return string The property path as string
205205
*/
206206
public function __toString()
207207
{
@@ -225,9 +225,9 @@ public function __toString()
225225
* removed at $offset and another chunk of length $insertionLength
226226
* can be inserted.
227227
*
228-
* @param integer $offset The offset where the removed chunk starts.
229-
* @param integer $cutLength The length of the removed chunk.
230-
* @param integer $insertionLength The length of the inserted chunk.
228+
* @param integer $offset The offset where the removed chunk starts
229+
* @param integer $cutLength The length of the removed chunk
230+
* @param integer $insertionLength The length of the inserted chunk
231231
*/
232232
private function resize($offset, $cutLength, $insertionLength)
233233
{

‎src/Symfony/Component/PropertyAccess/PropertyPathInterface.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ interface PropertyPathInterface extends \Traversable
2121
/**
2222
* Returns the string representation of the property path
2323
*
24-
* @return string The path as string.
24+
* @return string The path as string
2525
*/
2626
public function __toString();
2727

2828
/**
2929
* Returns the length of the property path, i.e. the number of elements.
3030
*
31-
* @return integer The path length.
31+
* @return integer The path length
3232
*/
3333
public function getLength();
3434

@@ -40,7 +40,7 @@ public function getLength();
4040
*
4141
* If this property path only contains one item, null is returned.
4242
*
43-
* @return PropertyPath The parent path or null.
43+
* @return PropertyPath The parent path or null
4444
*/
4545
public function getParent();
4646

@@ -58,7 +58,7 @@ public function getElements();
5858
*
5959
* @return string A property or index name
6060
*
61-
* @throws Exception\OutOfBoundsException If the offset is invalid.
61+
* @throws Exception\OutOfBoundsException If the offset is invalid
6262
*/
6363
public function getElement($index);
6464

@@ -69,7 +69,7 @@ public function getElement($index);
6969
*
7070
* @return Boolean Whether the element at this index is a property
7171
*
72-
* @throws Exception\OutOfBoundsException If the offset is invalid.
72+
* @throws Exception\OutOfBoundsException If the offset is invalid
7373
*/
7474
public function isProperty($index);
7575

@@ -80,7 +80,7 @@ public function isProperty($index);
8080
*
8181
* @return Boolean Whether the element at this index is an array index
8282
*
83-
* @throws Exception\OutOfBoundsException If the offset is invalid.
83+
* @throws Exception\OutOfBoundsException If the offset is invalid
8484
*/
8585
public function isIndex($index);
8686
}

0 commit comments

Comments
 (0)
0