Updated PHPDoc and PHPStan annotations

[mspirkov]

Q	A
Is bugfix	✔️
New feature	❌
Breaks BC	❌
Fixed issues	comma-separated list of tickets # fixed by the PR, if any

Removed unnecessary annotations. Missing annotations have also been added.

Summary by CodeRabbit

• Documentation
  • Updated and refined class-level and method-level documentation for improved clarity.
  • Added or adjusted PHPDoc annotations to better describe class relationships and generics.
  • Removed redundant or outdated PHPDoc comments from various methods.

[coderabbitai]

Walkthrough

PHPDoc comments specifying return type annotations for several methods were removed across multiple controller and action classes. Additionally, class-level PHPDoc annotations were introduced or updated to clarify generic type relationships for certain action classes. No functional or structural code changes were made.

Changes

File(s)	Change Summary
src/usecase/Controller.php src/usecase/contact/ContactController.php src/usecase/contact/ContactForm.php src/usecase/site/SiteController.php	Removed PHPDoc return type annotations from various actions() and attributeLabels() methods.
src/usecase/contact/IndexAction.php	Replaced constructor parameter PHPDoc with class-level @extends Action<ContactController>.
src/usecase/site/AboutAction.php	Added class-level PHPDoc annotation @extends Action<SiteController>.

Poem

A nibble here, a nibble there,
Docblocks vanish in the air.
New type hints hop into place,
Generics clarified with grace.
No code disturbed, just comments pruned,
The rabbit’s work is finely tuned!
🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/usecase/contact/IndexAction.php (1)

11-13: Prefer fully-qualified class reference in the annotation

To make the annotation resilient to future namespace changes and clearer to tools that do not resolve relative names inside PHPDoc, consider:

- * @extends Action<ContactController>
+ * @extends Action<\app\usecase\contact\ContactController>

A tiny nit, but it can avoid surprises in large codebases.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6e16572 and 3b5665b.

📒 Files selected for processing (6)

• src/usecase/Controller.php (0 hunks)
• src/usecase/contact/ContactController.php (0 hunks)
• src/usecase/contact/ContactForm.php (0 hunks)
• src/usecase/contact/IndexAction.php (1 hunks)
• src/usecase/site/AboutAction.php (1 hunks)
• src/usecase/site/SiteController.php (0 hunks)

💤 Files with no reviewable changes (4)

• src/usecase/contact/ContactForm.php
• src/usecase/site/SiteController.php
• src/usecase/Controller.php
• src/usecase/contact/ContactController.php

🔇 Additional comments (1)

src/usecase/site/AboutAction.php (1)

9-11: Ensure a generic-aware stub for yii\base\Action exists

@extends Action<SiteController> only improves static analysis if PHPStan sees Action as a generic class. Verify that a stub (or an upgraded yiisoft/yii2-stubs) declares something like

/**
 * @template TController of \yii\web\Controller
 * @extends \yii\base\Component
 */
abstract class Action { /* … */ }

Without it, the angle-bracket parameter is ignored and you lose the intended type-safety.

[terabytesoftw]

Thks 👍