913 questions
0
votes
0
answers
9
views
phpDocumentor.phar fails to generate output: cannot create directory inside phar
I am running phpDocumentor on Windows using phpDocumentor.phar.
I run the following command:
php phpDocumentor.phar run -d [class directory] -t [output directory]
The program scans my files correctly ...
- 1
0
votes
0
answers
45
views
How can I prevent Eclipse PHP "MyClass cannot be resolved to a type" error?
I have a bunch of common reusable classes stored in a "repo" folder hierarchy.
Each class has its own file, each file has a namespace coherent with its place in the folder hierarchy.
I ...
- 818
2
votes
2
answers
145
views
What's the purpose of using a @method phpdoc annotation for an interface instead of a method signature
I'm looking at the code of Laravel Fortify. In the service provider, you can register Action classes to perform specific jobs like this:
Fortify::createUsersUsing(CreateNewUser::class);
Fortify::...
- 3,099
0
votes
0
answers
17
views
Permission denied", while attempting to create directory ".phpdoc/cache" [duplicate]
I have a compose.yml and Dockerfile in the same directory. compose.yml contains:
services:
documentation:
build:
context: .
args:
GID: 1000
GROUP: my-name
...
- 47
1
vote
1
answer
103
views
How to describe anonymous classes and methods?
I need to run tests on a certain class, but adding a method that was not originally present.
Previously this need could be satisfied using MockBuilder::addMethods(), but this method has been ...
- 1,280
0
votes
1
answer
73
views
How to type hint a property on $this in php?
Assume that in a template.phtml, there is a property someInstance of the class SomeClass defined on $this.
So in the file, one has access to:
$this->someInstance
yet the developer has no immediate ...
- 67.7k
1
vote
1
answer
142
views
Expanding the PHPDoc of a PHP class what found in a Composer package
There is a Illuminate\Database\Schema\ColumnDefinition class in the laravel/framework package. How can I extend its PHPDoc @method annotations externally? This is a special class by Fluent, for ...
- 18.7k
0
votes
0
answers
78
views
PhpStorm can't find object declaration to go to, has no suggestions for properties
This is old PHP 5 code and is probably coded wrong (it doesn't use typical autoloading), but I'm flummoxed as to how to get the editor to know which class an object in a call is using, like this:
$...
- 45
0
votes
0
answers
69
views
How to typehint an intermediate value in chained code using PHPDoc
I have the following code:
$id = $ui->getWidget('import_id')->value;
I know the class type of $ui. The getWidget() method can return one or more types of widget classes based on the parameter ...
- 2,249
0
votes
1
answer
42
views
PhpDocumentor Guide links missing
I am trying to create a link from one page in the documentation to another in a .rst file:
Link to another page :doc:`Another Page`
However when I run PHPDocumentor
php phpDocumentor.phar -c .\phpdoc....
- 5,135
3
votes
0
answers
92
views
PHP doc doesn't respect indentation in code example in VSCode
I've added roughly the following PHPDoc to document a class, using markdown style backticks to add an example of the classes usage
/**
* This is some documentation for a class
*
* usage:
*
* ``...
- 103
0
votes
0
answers
75
views
Keeping PHPDoc comments in blade templates up to date with Laravel Controllers
My project has a number of Controllers with $data arrays that are then passed to \Illuminate\Contracts\Routing\ResponseFactory::view::getResponse. Other developers on my team will often add new keys ...
- 2,581
0
votes
0
answers
122
views
IDE phpdoc type hints for properties with attributes
I'm working with PHP and I've encountered a challenge with IDE support for typed arrays. Here's a snippet of my code:
<?php
class User extends BaseData
{
public function __construct(
...
- 66
1
vote
1
answer
257
views
PHPDOC Abstract class does not insert extended class type <T> into methods returns
I've got following code:
<?php
/**
* @template T
*/
abstract class A {
/**
* @return T
*/
public function read() {
// return statement
}
}
class C {}
/**
* @...
- 158
0
votes
0
answers
43
views
How can PHPDoc comments be used with contracovariance return types?
I have a table that stores encrypted json values for some sensitive data. The issue is that the json properties may alter slightly based on the type of record.
To overcome this, I created data ...
- 6,749
0
votes
0
answers
670
views
Access to an undefined property trait larastan
I´m trying to solve errors in my proyect with larastan. One error that this library, returned it´s: Access to an undefined property App\Cargador\Prevalidaciones\PrevalidarCodificacionUTF8::$tarea
...
- 343
2
votes
1
answer
142
views
PHP - PHPDoc typehint when trying to iterate over integer
I have this code
/** @var array{total: integer, records: array} $response */
$response = $this->getResponse();
foreach($response['total'] as $value) {
$this->saveRecord($value);
}
Shouldn'...
- 1,103
1
vote
0
answers
56
views
Is it possible define param type from class variable with phpdoc in PHP
now I have this:
class UserProvider
{
protected string $className = User::class;
/**
* @param User $entity
*/
public function getData($entity): array
{
$data['name'] ...
- 8,670
0
votes
0
answers
266
views
PhpDoc: <static> in trait methods refers to trait instance
I'm having an issue in type-checking some methods of a trait.
I'm using a sort of facade-pattern and my aim would be to inject some methods of a facade in other classes through a trait that has ...
- 1
1
vote
0
answers
1k
views
phpstan array shape definition using a class constant
Is there a way to use class constants to define array shapes in phpstan?
The purpose is to enable the definition to be used by PHP code, otherwise we have to repeat the definition (once for phpstan ...
- 3,988
1
vote
1
answer
1k
views
How to document a Laravel model attribute as deprecated?
I have an eloquent model in Laravel that I would like to mark an user_id attribute as deprecated using the @deprectated tag in PHPDoc.
I can add the @property tag to my model to document user_id but ...
- 579
1
vote
2
answers
425
views
PHPDoc for conditional polymorphic call
For $item there's a polymorphic loggable relationship. In the database this is stored in items as loggable_type and loggable_id (for PHP 8+ in and Laravel).
for($items as $item) {
// ...
if ($...
0
votes
1
answer
68
views
PHP - Spoofing return-type covariance for code prediction
Consider:
abstract class BaseModel {
protected static string $dataObjectClass;
public function toDataObject(): ?IDataObject
{
return static::$dataObjectClass::from($this);
}
}
...
- 627
1
vote
2
answers
108
views
Is there a "must-use" attribute in PHP or PHPDoc?
Is it possible to specify, either in plain PHP 8+ or PHPDoc that a function return value must be used, like the Rust equivalent?
Imagine a function:
public function doSomething(): ImportantObject {
...
0
votes
0
answers
123
views
PHPStorm correct PHPDoc for a Collection of Strings
I have this collection and would like to annotate the correct PHPDoc for this collection. Would it be Collection<string>?
Illuminate\Support\Collection^ {#525
#items: array:3 [
0 => &...
- 459
4
votes
1
answer
6k
views
PHPStan error: Method should return specific types but returns mixed
I'm using PHPStan for static analysis in my PHP 8.4.2 project, and I'm encountering an issue with a class method that returns multiple types or null. Here's my method with type hints and PHPDoc ...
- 51
0
votes
0
answers
129
views
PHPDoc not passed with variables from controller to views in Yii2 and PhpStorm
Simplified code:
Model:
/**
* @return array{name:string,age:int,group:int}
*/
public function fetchStudent($id){
//fetch $id student from db and return array
(...)
}
My controller:
$students = ...
- 419
2
votes
0
answers
1k
views
PSALM / PHPStan / PHPDoc Types: using templates/generics as array keys (of multiple elements array)
I cannot figure how to annotate an array returned from API Response.
Response have a structure:
array{'totalCount': numeric-string, $vehicleType: array}
Instead of variable $vehicleType there can be ...
- 21
2
votes
1
answer
1k
views
How to auto generate all phpdoc comments for a specific custom class?
This github file contains this auto-generated phpdoc comment
/**
* ...
* <autodoc generated by `composer phpdoc`>
*
* @property int $year
* @property int ...
- 175
3
votes
2
answers
4k
views
Describe an array containing an object (stdClass) with @phpstan-return in PHP DocBlock? - PHPStan
I have an example function in PHP (8.2) that returns an array. Inside this array there is also an object, more precisely stdClass.
I use PHPStan as a static analyzer tool. How can I specify this (...
- 772
0
votes
1
answer
510
views
PhpDocs: Link to another method in "@param" tag's description?
Is it possible to link to another method/class/property/etc of my project, inline inside the @param tag?
Like this:
/**
* My method's description.
*
* @param string $myArg Pass here result of {@...
- 9,039
0
votes
1
answer
98
views
Is there any way to automate refactoring old style comments to phpDoc format?
I'm refactoring a huge amount of code which has all function documented in simple comments like this:
//This is foo funtion
function foo($foo)
{
}
And my goal is to make it looks like this:
/**
...
- 54
0
votes
0
answers
52
views
PhpDoc show indirect extended method
We have some magic behaviour that adds additional features to class.
Right now we have lots of similar code:
/**
* @see \App\Behaviour::someMethod
* @method mixed someMethod(string ...$params)
*
* ...
- 43.9k
0
votes
1
answer
539
views
PhpStorm PHPDoc type inference: is there a way to manipulate an array and let PhpStorm know its type is same as the original array?
An example is better than any explaining: Let's say I have the following code
function arrayToIdMap(array $models) : array
{
$result = [];
foreach ($models as $model) {
/** @var ...
- 703
0
votes
0
answers
29
views
The @propery tag in the class description breaks doc file
I am trying to document php project using doxygen and have a problem.
In the project that I am working on, developers often use the @property tag. PHPDoc supports it and calls it the "Magic" ...
- 199
0
votes
0
answers
267
views
PHP: Understanding @templates annotation with the use of @throws tags
I'am using PhpStorm and have started using @template annotations.
However, I have trouble understanding exactly how they work in relation to @throws tags.
Here are some examples (of fantasy) to ...
- 1,280
2
votes
1
answer
1k
views
How to document PHP Array keys and INI files
When using phpdoc doc blocks, is it possible to describe the keys for an array?
/**
* @var array
*/
private $smtpSettings
= array(
'SMTPDebug' => (bool)true,
'SMTPSecure' =>...
- 31
2
votes
0
answers
1k
views
PhpStorm Generic Classes not working at all
This is all happening for me in PhpStorm 2022.2.1
I've been trying to set up a class in PHP that supports Generics, but to no avail. No matter what I tried, PhpStorm always type hints as mixed. Here ...
- 126
2
votes
1
answer
93
views
CakePHP: How to update the Models PHPDocs?
I have a huge project with 100+ tables in my database. Over the years, we add some new columns in some tables, but we forgot to reflect this on Models phpDocs. Those phpdocs were initially generate by ...
- 474
1
vote
2
answers
1k
views
PhpStorm 2022.2.2 Laravel Model Relationships and Attributes recognised as magic methods
How can I declare my model relationships and custom attributes properly so that they will be available from auto-completion and have the warning "property accessed via magic method" ...
- 1,579
2
votes
3
answers
13k
views
How to autogenerate phpDOC for classes/function on VSCode
Any idea how to generate phpdoc on VSCode? I have installed intellisense, intelephense extensions but when I type /** it just adds */ so it becomes something like
/** */ and that's all. No ...
- 41
0
votes
0
answers
1k
views
How to understand this phpStan error (has parameter $astTreeData with no value type specified in iterable type array.)
Say I have a formatter function like this:
function prepareValue(mixed $value): string
{
...
return "{$value}";
}
/**
* @param array<int, array> $astTreeData
* @return ...
- 1
1
vote
0
answers
1k
views
UndefinedDocblockClass psalm error when using a trait to mark magic properties as deprecated
I'm trying to use PhpDoc to hint all the deprecated magic properties set on a Laravel Model using the mixin described in this answer.
I am using JetBrains PhpStorm 2022.1.1, PHP 8.1.6 and Psalm 4.23.0
...
- 28.8k
0
votes
0
answers
36
views
Php, code competion for inline-factory / dynamic method name?
given this snippet:
class Test
{
public function run2()
{
}
}
class Factory
{
public function createTest()
{
return new Test();
}
}
$factory = new Factory();
$m = '...
- 6,259
1
vote
0
answers
207
views
How to use custom annotations to document code in php
In my php code I have a lot of places, where I need to customize the default behaviour of the programming logic for different customers. For documentation purposes I want to annonate every custom ...
0
votes
2
answers
520
views
Method @returns a child class of an property
I have a abstract class Foo and a abstract builder FooBuilder
abstract class Foo {
}
abstract class FooBuilder {
protected Foo $model;
/**
* Return the class instance
*
* @return Model //...
- 633
0
votes
0
answers
72
views
PHPWORD generates "mirrored" table instead of normal
I use PHPWORD library to generate .docx document with a simple table.
This is the code:
require "vendor/autoload.php";
$phpWord = new \PhpOffice\PhpWord\PhpWord();
$phpWord->...
- 41
1
vote
1
answer
158
views
Is there a way to remove the default package called application showing in PHPDocumentator?
PHPDoc shows a default application package, and cannot figure out how to remove it.
- 11
1
vote
0
answers
46
views
How to document thrown exceptions with a PHPdoc tag `@method`? [duplicate]
Is there any way how I can also document the thrown exceptions if the method is documented via the PHPdoc tag @method? According to the official documentation on @method this seems impossible. But ...
- 1,931
0
votes
1
answer
1k
views
PHPDoc & Psalm - Annotate an "array of classes"
In my code I created an EventFactory like this:
private array $events = [
'post_created' => PostCreatedEvent::class,
'exercise_executed' => ExerciseExecutedEvent::class,
];
public ...
