Skip to content

Commit 875b856

Browse files
authored
Merge pull request msyk#101 from msyk/mod20240911-2
Added some exclamations about password parameter
2 parents c7767a3 + 0f27f1e commit 875b856

2 files changed

Lines changed: 4 additions & 1 deletion

File tree

samples/FMDataAPI_Sample.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
// FMDataAPI class handles an error as an exception by default.
1818
try {
19-
// Instantiate the class FMDataAPI with database name, user name, password and host.
19+
// Instantiate the class FMDataAPI with database name, username, password and host.
2020
// Although the port number and protocol can be set in parameters of constructor,
2121
// these parameters can be omitted with default values.
2222
$fmdb = new FMDataAPI("TestDB", "web", null, "localhost");

src/FMDataAPI.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ class FMDataAPI
4646
* @param string $user The fmrest privilege accessible user to the database.
4747
* If you’re going to call useOAuth method, you have to specify the data for X-FM-Data-OAuth-Request-Id.
4848
* @param string|null $password The password of the above user.
49+
* This can be null for testing purpose only. Null data is going to replace the string "password".
50+
* This prevents to be detected as a security issue.
51+
* On the real solutions, you have to set a valid password string.
4952
* If you’re going to call useOAuth method, you have to specify the data for X-FM-Data-OAuth-Identifier.
5053
* @param string|null $host FileMaker Server's host name or IP address. If omitted, 'localhost' is chosen.
5154
* The value "localserver" tries to connect directory 127.0.0.1, and you don't have to set $port and $protocol.

0 commit comments

Comments
 (0)