[#9301] - Doc to support correct type hinting in IDE for JDate::modify()
- Fixed in Code Base
- 30 Sep 2016
- Medium
- Build: staging
- # 9301
- Diff
- izharaazmi:patch-6
- Success continuous-integration/travis-ci/pr The Travis CI build passed Details
User tests: Successful: Unsuccessful:
Summary of Changes
This method is a part of the parent class (PHP native DateTime) which is type-hinted to return DateTime. Marking return type to JDate when called as JDate method.
Testing Instructions
Only relevant for IDE (such as PHPStorm) users. Check the typehint of the return value from JDate::modify().
Without this patch it shows DateTime
After this patch it will show JDate
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Labels |
Added:
?
|
||
The PHP Documentation shows the prototype like public DateTime DateTime::modify ( string $modify ). See DateTime::modify
Also the return tag is supposed to contain data types and not the values. Therefore, I think it should be JDate|bool instead of JDate|false if we want to hint false as a possible return value. See: PHPDoc @method and PHPDoc @return
Please advise.
Whatever PHPDoc says :)
I am in doubt because public DateTime DateTime::modify ( string $modify ) at PHP.net does not suggest bool as typehint but the description says so. True for many other PHP functions too.
Add bool to JDate::add, JDate::sub and JDate::modify?
brianteeman
- | Category | ⇒ | Libraries |
Can we have this reviewed please!
Bakual
- | Status | Pending | ⇒ | Fixed in Code Base |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2016-09-30 12:25:18 |
| Closed_By | ⇒ | Bakual |
| Labels |
Added:
?
|
||
This can be
JDate|falseaccording to the PHP docs here http://php.net/manual/en/datetime.modify.php#refsect1-datetime.modify-returnvalues - can you amend please :)