Repository navigation
Google_Http_MediaFileUpload PHPDoc issues? #1881
Description
I've been using Google_Http_MediaFileUpload to upload videos to YouTube. I have no issue with the actual functionalities of the code, only with the type hinting that seems to be incorrect for a lot of the constructor / methods parameters.
Code example
The following code is mostly taken from the documentation.
$chunkSizeBytes = 10 * 1024 * 1024; // 10 MB
$fileSize = filesize($videoFile->getRealPath());
$this->googleClient->setDefer(true);
$insertRequest = $ytService->videos->insert(
'snippet,status',
$ytVideo
);
$media = new \Google_Http_MediaFileUpload($this->googleClient, $insertRequest, 'video/*', null, true, $chunkSizeBytes);
$media->setFileSize($fileSize);This works perfectly fine, but triggers a lot of linting warnings from, for example, PHPStan or Intelephense in VSCode, because of the PHPDoc block of Google_Http_MediaFileUpload constructor.
Here's the warnings:
Parameter #2 $request of class Google_Http_MediaFileUpload constructor expects 'Psr\Http\Message\RequestInterface', 'Google_Service_YouTube_Video' given.
Parameter #4 $data of class Google_Http_MediaFileUpload constructor expects string, null given.
Parameter #6 $chunkSize of class Google_Http_MediaFileUpload constructor expects bool, int given.
For the first, I'm not really sure what's the issue here. Using the result of $ytService->videos->insert is what the doc says to do, but the returned type is not compatible at all (but it works when it actually runs, so it's correct...)
Is it intentional that $chunkSize is defined as a bool (seems weird to me, but maybe there's a reason)? $data should also specify |null.
Activity
ThibaultVlacich commentedon Jul 17, 2020
I guess this might be related to googleapis/google-api-php-client-services#172 and googleapis/google-api-php-client-services#179 ?
xhezairbey commentedon Jun 13, 2022
I see It's been two years since this was reported, and I can confirm it's still an issue even with v2.12.6.
In a similar example, the ops report holds true both for
$request (RequestInterface)and$chunkSize (bool)$request = $this->service->videos->insert('snippet,status', $video, []);when $request passed onto theGoogle_Http_MediaFileUpload::construct()raises warning aboutI'm about to find out wether passing the $insertRequest breaks the internal functionality for
MediaFileUpload::process()since that method call is dependant on receiving the proper $request object.wayonhigh commentedon Apr 15, 2024
I have just come across this issue in version [2.15.3] (https://github.com/googleapis/google-api-php-client/releases/tag/v2.15.3)
Is there anyway to fix it to stop it showing as a 'Problem' in VSCode?
tinusg commentedon May 13, 2024
@wayonhigh Yes there is. I just found out:
Add this line before 1293:
/** @var \Psr\Http\Message\RequestInterface $insertRequest */It's a PHPDoc comment that clarifies the actual variable type.
wayonhigh commentedon May 13, 2024
@tinusg thank you! Actually, since I posted that question, I moved from Intelephense to Devsense Intelliphp and it doesn't show as a "problem"
tinusg commentedon May 13, 2024
I'll check that out as well, thanks!