Skip to content

Commit ac7df0d

Browse files
Manual property phpdoc fixes
1 parent bb78749 commit ac7df0d

18 files changed

+171
-56
lines changed

src/Parse/Internal/AddOperation.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@
1313
class AddOperation implements FieldOperation
1414
{
1515
/**
16-
* @var - Array with objects to add.
16+
* Array with objects to add.
17+
*
18+
* @var array
1719
*/
1820
private $objects;
1921

src/Parse/Internal/AddUniqueOperation.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@
1313
class AddUniqueOperation implements FieldOperation
1414
{
1515
/**
16-
* @var - Array containing objects to add.
16+
* Array containing objects to add.
17+
*
18+
* @var array
1719
*/
1820
private $objects;
1921

src/Parse/Internal/IncrementOperation.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212
class IncrementOperation implements FieldOperation
1313
{
1414
/**
15-
* @var int - Amount to increment by.
15+
* Amount to increment by.
16+
*
17+
* @var int
1618
*/
1719
private $value;
1820

src/Parse/Internal/ParseRelationOperation.php

+11-3
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,23 @@
1414
class ParseRelationOperation implements FieldOperation
1515
{
1616
/**
17-
* @var string - The className of the target objects.
17+
* The className of the target objects.
18+
*
19+
* @var string
1820
*/
1921
private $targetClassName;
22+
2023
/**
21-
* @var array - Array of objects to add to this relation.
24+
* Array of objects to add to this relation.
25+
*
26+
* @var array
2227
*/
2328
private $relationsToAdd = [];
29+
2430
/**
25-
* @var array - Array of objects to remove from this relation.
31+
* Array of objects to remove from this relation.
32+
*
33+
* @var array
2634
*/
2735
private $relationsToRemove = [];
2836

src/Parse/Internal/RemoveOperation.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515
class RemoveOperation implements FieldOperation
1616
{
1717
/**
18-
* @var - Array with objects to remove.
18+
* Array with objects to remove.
19+
*
20+
* @var array
1921
*/
2022
private $objects;
2123

src/Parse/Internal/SetOperation.php

+6-2
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,16 @@
1212
class SetOperation implements FieldOperation
1313
{
1414
/**
15-
* @var - Value to set for this operation.
15+
* Value to set for this operation.
16+
*
17+
* @var mixed
1618
*/
1719
private $value;
1820

1921
/**
20-
* @var - If the value should be forced as object.
22+
* If the value should be forced as object.
23+
*
24+
* @var bool
2125
*/
2226
private $isAssociativeArray;
2327

src/Parse/ParseACL.php

+6-6
Original file line numberDiff line numberDiff line change
@@ -19,32 +19,32 @@ class ParseACL implements Encodable
1919
const PUBLIC_KEY = '*';
2020

2121
/**
22-
* @var array -
22+
* @var array
2323
*/
2424
private $permissionsById = [];
2525

2626
/**
27-
* @var bool -
27+
* @var bool
2828
*/
2929
private $shared = false;
3030

3131
/**
32-
* @var ParseUser -
32+
* @var ParseUser
3333
*/
3434
private static $lastCurrentUser = null;
3535

3636
/**
37-
* @var ParseACL -
37+
* @var ParseACL
3838
*/
3939
private static $defaultACLWithCurrentUser = null;
4040

4141
/**
42-
* @var ParseACL -
42+
* @var ParseACL
4343
*/
4444
private static $defaultACL = null;
4545

4646
/**
47-
* @var bool -
47+
* @var bool
4848
*/
4949
private static $defaultACLUsesCurrentUser = false;
5050

src/Parse/ParseAnalytics.php

+2
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,11 @@ class ParseAnalytics
4343
public static function track($name, $dimensions = [])
4444
{
4545
$name = trim($name);
46+
4647
if (strlen($name) === 0) {
4748
throw new Exception('A name for the custom event must be provided.');
4849
}
50+
4951
foreach ($dimensions as $key => $value) {
5052
if (!is_string($key) || !is_string($value)) {
5153
throw new Exception('Dimensions expected string keys and values.');

src/Parse/ParseBytes.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010
class ParseBytes implements Internal\Encodable
1111
{
1212
/**
13-
* @var - byte array
13+
* Byte array.
14+
*
15+
* @var array
1416
*/
1517
private $byteArray;
1618

src/Parse/ParseClient.php

+20-6
Original file line numberDiff line numberDiff line change
@@ -17,37 +17,51 @@ final class ParseClient
1717
const HOST_NAME = 'https://api.parse.com';
1818

1919
/**
20-
* @var - String for applicationId.
20+
* The application id.
21+
*
22+
* @var string
2123
*/
2224
private static $applicationId;
2325

2426
/**
25-
* @var - String for REST API Key.
27+
* The REST API Key.
28+
*
29+
* @var string
2630
*/
2731
private static $restKey;
2832

2933
/**
30-
* @var - String for Master Key.
34+
* The Master Key.
35+
*
36+
* @var string
3137
*/
3238
private static $masterKey;
3339

3440
/**
35-
* @var - Boolean for Enable/Disable curl exceptions.
41+
* Enable/Disable curl exceptions.
42+
*
43+
* @var bool
3644
*/
3745
private static $enableCurlExceptions;
3846

3947
/**
40-
* @var ParseStorageInterface Object for managing persistence
48+
* The object for managing persistence.
49+
*
50+
* @var ParseStorageInterface
4151
*/
4252
private static $storage;
4353

4454
/**
45-
* @var - Boolean for enabling revocable sessions.
55+
* Are revocable sessions enabled?
56+
*
57+
* @var bool
4658
*/
4759
private static $forceRevocableSession = false;
4860

4961
/**
5062
* Constant for version string to include with requests.
63+
*
64+
* @var string
5165
*/
5266
const VERSION_STRING = 'php1.1.0';
5367

src/Parse/ParseConfig.php

-4
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,13 @@ public function get($key)
2525
if (isset($this->currentConfig[$key])) {
2626
return $this->currentConfig[$key];
2727
}
28-
29-
return;
3028
}
3129

3230
public function escape($key)
3331
{
3432
if (isset($this->currentConfig[$key])) {
3533
return htmlentities($this->currentConfig[$key]);
3634
}
37-
38-
return;
3935
}
4036

4137
protected function setConfig($config)

src/Parse/ParseFile.php

+15-4
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,30 @@
1010
class ParseFile implements \Parse\Internal\Encodable
1111
{
1212
/**
13-
* @var - Filename
13+
* The filename.
14+
*
15+
* @var string
1416
*/
1517
private $name;
18+
1619
/**
17-
* @var - URL of File data stored on Parse.
20+
* The URL of file data stored on Parse.
21+
*
22+
* @var string
1823
*/
1924
private $url;
25+
2026
/**
21-
* @var - Data
27+
* The data.
28+
*
29+
* @var string
2230
*/
2331
private $data;
32+
2433
/**
25-
* @var - Mime type
34+
* The mime type.
35+
*
36+
* @var string
2637
*/
2738
private $mimeType;
2839

src/Parse/ParseGeoPoint.php

+7-2
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,16 @@
1010
class ParseGeoPoint implements \Parse\Internal\Encodable
1111
{
1212
/**
13-
* @var - Float value for latitude.
13+
* The latitude.
14+
*
15+
* @var float
1416
*/
1517
private $latitude;
18+
1619
/**
17-
* @var - Float value for longitude.
20+
* The longitude.
21+
*
22+
* @var float
1823
*/
1924
private $longitude;
2025

src/Parse/ParseObject.php

+38-10
Original file line numberDiff line numberDiff line change
@@ -20,44 +20,72 @@
2020
class ParseObject implements Encodable
2121
{
2222
/**
23-
* @var array - Data as it exists on the server.
23+
* Data as it exists on the server.
24+
*
25+
* @var array
2426
*/
2527
protected $serverData;
28+
2629
/**
27-
* @var array - Set of unsaved operations.
30+
* Set of unsaved operations.
31+
*
32+
* @var array
2833
*/
2934
protected $operationSet;
35+
3036
/**
31-
* @var array - Estimated value of applying operationSet to serverData.
37+
* Estimated value of applying operationSet to serverData.
38+
*
39+
* @var array
3240
*/
3341
private $estimatedData;
42+
3443
/**
35-
* @var array - Determine if data available for a given key or not.
44+
* Determine if data available for a given key or not.
45+
*
46+
* @var array
3647
*/
3748
private $dataAvailability;
49+
3850
/**
39-
* @var - Class Name for data on Parse.
51+
* Class name for data on Parse.
52+
*
53+
* @var string
4054
*/
4155
private $className;
56+
4257
/**
43-
* @var string - Unique identifier on Parse.
58+
* Unique identifier on Parse.
59+
*
60+
* @var string
4461
*/
4562
private $objectId;
63+
4664
/**
47-
* @var \DateTime - Timestamp when object was created.
65+
* Timestamp when object was created.
66+
*
67+
* @var \DateTime
4868
*/
4969
private $createdAt;
70+
5071
/**
51-
* @var \DateTime - Timestamp when object was last updated.
72+
* Timestamp when object was last updated.
73+
*
74+
* @var \DateTime
5275
*/
5376
private $updatedAt;
77+
5478
/**
55-
* @var bool - Whether the object has been fully fetched from Parse.
79+
* Whether the object has been fully fetched from Parse.
80+
*
81+
* @var bool
5682
*/
5783
private $hasBeenFetched;
5884

5985
/**
60-
* @var array - Holds the registered subclasses and Parse class names.
86+
* Holds the registered subclasses and Parse class names.
87+
*
88+
* @var array
6189
*/
6290
private static $registeredSubclasses = [];
6391

0 commit comments

Comments
 (0)