Skip to content

Commit 16084d8

Browse files
authored
Correct PHPDoc for string parameters
`@param String $var` should be replaced by `@param string $var` to avoid warnings such as `Argument '1' passed to __construct() is expected to be of type INTERMediator\FileMakerServer\RESTAPI\String, string given`.
1 parent 0e76de1 commit 16084d8

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

src/FMDataAPI.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,16 @@ class FMDataAPI
3939
/**
4040
* FMDataAPI constructor. If you want to activate OAuth authentication, $user and $password are set as
4141
* oAuthRequestId and oAuthIdentifier. Moreover, call useOAuth method before accessing layouts.
42-
* @param String $solution The database file name which is just hosting.
42+
* @param string $solution The database file name which is just hosting.
4343
* Every database must have the access privillege 'fmrest' including external data sources.
44-
* @param String $user The fmrest privilege accessible user to the database.
44+
* @param string $user The fmrest privilege accessible user to the database.
4545
* If you are going to call useOAuth method, you have to specify the data for X-FM-Data-OAuth-Request-Id.
46-
* @param String $password The password of above user.
46+
* @param string $password The password of above user.
4747
* If you are going to call useOAuth method, you have to specify the data for X-FM-Data-OAuth-Identifier.
48-
* @param String $host FileMaker Server's host name or IP address. If omitted, 'localhost' is chosen.
48+
* @param string $host FileMaker Server's host name or IP address. If omitted, 'localhost' is chosen.
4949
* The value "localserver" tries to connect directory 127.0.0.1, and you don't have to set $port and $protocol.
5050
* @param int $port FileMaker Server's port number. If omitted, 443 is chosen.
51-
* @param String $protocol FileMaker Server's protocol name. If omitted, 'https' is chosen.
51+
* @param string $protocol FileMaker Server's protocol name. If omitted, 'https' is chosen.
5252
* @param array $fmDataSource Authentication information for external data sources.
5353
* Ex. [{"database"=>"<databaseName>", "username"=>"<username>", "password"=>"<password>"].
5454
* If you use OAuth, "oAuthRequestId" and "oAuthIdentifier" keys have to be spedified.
@@ -66,7 +66,7 @@ public function __construct(
6666

6767
/**
6868
* Can't set the value to the undefined name.
69-
* @param String $key The property name
69+
* @param string $key The property name
7070
* @return FileMakerLayout FileMakerLayout object
7171
* @ignore
7272
*/
@@ -77,7 +77,7 @@ public function __set($key, $value)
7777

7878
/**
7979
* Handle the undefined name as the layout name.
80-
* @param String $key The property name
80+
* @param string $key The property name
8181
* @return FileMakerLayout FileMakerLayout object
8282
* @ignore
8383
*/
@@ -89,7 +89,7 @@ public function __get($key)
8989
/**
9090
* Refers the FileMakerLayout object as the proxy of the layout.
9191
* If the layout doesn't exist, no error arises here. Any errors might arise on methods of FileMakerLayout class.
92-
* @param String $layout_name Layout name.
92+
* @param string $layout_name Layout name.
9393
* @return FileMakerLayout object which is proxy of FileMaker's layout.
9494
*/
9595
public function layout($layout_name)

0 commit comments

Comments
 (0)