Remove legacy code, update typings by ocean90 · Pull Request #7 · wearerequired/common-php

ocean90 · 2026-01-25T12:45:33Z

No description provided.

…ies in README

Copilot

Pull request overview

This pull request modernizes the codebase by removing deprecated legacy classes and shortcode functionality while comprehensively updating type declarations throughout the library to leverage PHP's typed properties and constants.

Changes:

Removed legacy compatibility classes (PostType, PostMeta, Taxonomy, TermMeta) and shortcode-related code
Added strict type declarations and updated all property and method signatures with proper type hints
Introduced auth_callback adapter methods in PostMeta and TermMeta for compatibility with johnbillion/args library

Reviewed changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
phpstan.neon.dist	Updated analysis path from src/ to inc/ directory
phpcs.xml.dist	Excluded MissingVar sniff to accommodate new typed properties
composer.json	Increased PHPStan memory limit for analysis
inc/TermMetaAdminUI.php	Added strict types, typed properties, void return types, and fixed action argument count
inc/TermMeta.php	Added strict types, typed constant, empty key validation, auth_callback adapter, and enhanced type annotations
inc/Taxonomy.php	Added strict types, typed constant and properties, improved type safety with array_map in set_object_types
inc/PostType.php	Added strict types, typed constant, comprehensive PHPStan type assertions for WordPress registration args
inc/PostMeta.php	Added strict types, typed constant, empty key validation, auth_callback adapter, and enhanced type annotations
inc/Container.php	Added strict types, typed properties, renamed parameter for clarity
inc/Admin/PostAction.php	Added strict types, typed constant, void return types
inc/Admin/PageView.php	Added strict types, void return type
inc/Admin/Page.php	Added strict types, typed constants and properties, improved type safety with nullable and union types
inc/Admin/AjaxAction.php	Added strict types, typed constant, void return types
inc/Contracts/Taxonomy.php	Added typed NAME constant to interface
inc/Contracts/Registrable.php	Added strict types declaration
inc/Shortcode.php	Removed - legacy shortcode functionality
inc/Contracts/ShortcodeView.php	Removed - legacy shortcode interface
inc/Legacy/TermMeta.php	Removed - deprecated legacy compatibility class
inc/Legacy/Taxonomy.php	Removed - deprecated legacy compatibility class
inc/Legacy/PostType.php	Removed - deprecated legacy compatibility class
inc/Legacy/PostMeta.php	Removed - deprecated legacy compatibility class
README.md	Added comprehensive usage examples

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-25T12:54:47Z

inc/PostMeta.php

 	/**
 	 * Post meta key.
 	 */
-	public const KEY = null;
+	public const string KEY = '';


Changing the default value of KEY from null to an empty string is a breaking change. Child classes that previously relied on the constant being null (e.g., checking static::KEY === null) will need to be updated to check for an empty string instead. Consider documenting this breaking change in release notes or migration guide.

Copilot · 2026-01-25T12:54:47Z

inc/Contracts/Taxonomy.php

+	 *
+	 * Implementations are expected to override this.
+	 */
+	public const string NAME = '';


The Taxonomy interface now defines a NAME constant, but the PostType interface does not have an equivalent constant despite the PostType class defining public const string NAME = 'post';. Consider adding a NAME constant to the PostType interface for consistency, or document why Taxonomy needs this in its interface while PostType does not.

Suggested change

public const string NAME = '';

public const NAME = '';

Copilot · 2026-01-25T12:54:47Z

inc/PostMeta.php

 	 * @return string Type of the data.
 	 */
+	/** @return 'array'|'boolean'|'integer'|'number'|'object'|'string' */


There's a duplicate return type annotation. The PHPDoc @return annotation on line 108 appears to be redundant since line 106-107 already documents the return type. Consider removing line 108 or integrating it into the main docblock to avoid duplicate documentation.

Suggested change

* @return string Type of the data.

*/

/** @return 'array'|'boolean'|'integer'|'number'|'object'|'string' */

* @return 'array'|'boolean'|'integer'|'number'|'object'|'string' Type of the data.

*/

Copilot · 2026-01-25T12:54:47Z

inc/Admin/Page.php

@@ -137,16 +133,16 @@ class Page implements Registrable {
 	 *
 	 * @var string


The @var annotation incorrectly states the type as "string" but the property is actually typed as "string|false" on line 136. The documentation should be updated to match the actual type.

Suggested change

* @var string

* @var string|false

Copilot · 2026-01-25T12:54:48Z

inc/Admin/Page.php

@@ -253,7 +247,7 @@ private function get_callback() {
 	 *
 	 * @return string The hook name of the menu page.


The @return annotation incorrectly states the return type as "string" but the method signature on line 250 actually returns "string|false". The documentation should be updated to reflect the actual return type.

Suggested change

* @return string The hook name of the menu page.

* @return string|false The hook name of the menu page.

Copilot · 2026-01-25T12:54:48Z

inc/TermMeta.php

 	/**
 	 * Term meta key.
 	 */
-	public const KEY = null;
+	public const string KEY = '';


Changing the default value of KEY from null to an empty string is a breaking change. Child classes that previously relied on the constant being null (e.g., checking static::KEY === null) will need to be updated to check for an empty string instead. Consider documenting this breaking change in release notes or migration guide.

Copilot · 2026-01-25T12:54:48Z

inc/TermMeta.php

 	 * @return string Type of the data.
 	 */
+	/** @return 'array'|'boolean'|'integer'|'number'|'object'|'string' */


There's a duplicate return type annotation. The PHPDoc @return annotation on line 108 appears to be redundant since line 106-107 already documents the return type. Consider removing line 108 or integrating it into the main docblock to avoid duplicate documentation.

Suggested change

* @return string Type of the data.

*/

/** @return 'array'|'boolean'|'integer'|'number'|'object'|'string' */

* @return string Type of the data. One of 'array', 'boolean', 'integer', 'number', 'object', or 'string'.

*/

Copilot · 2026-01-25T12:54:48Z

inc/PostMeta.php

+	/**
+	 * Adapter for the narrower `johnbillion/args` auth callback signature.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param bool   $allowed        Whether the user can add the post meta.
+	 * @param string $meta_key       The meta key.
+	 * @param string $object_type    Object type.
+	 * @param string $object_subtype Object subtype.
+	 * @return bool Whether the user is allowed to edit meta.
+	 */
+	public function auth_callback( bool $allowed, string $meta_key, string $object_type, string $object_subtype = '' ): bool { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+		return $this->auth( $allowed, $meta_key, 0, 0, '', [] );
+	}


The auth_callback adapter passes hardcoded dummy values (0, 0, '', []) for the object_id, user_id, cap, and caps parameters when calling the auth method. This means child classes that override the auth method will not have access to the actual values of these parameters when the callback is invoked via johnbillion/args. Consider documenting this limitation or ensuring that child classes that need these parameters override auth_callback instead of auth.

Copilot · 2026-01-25T12:54:48Z

inc/TermMeta.php

+	/**
+	 * Adapter for the narrower `johnbillion/args` auth callback signature.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param bool   $allowed        Whether the user can add the term meta.
+	 * @param string $meta_key       The meta key.
+	 * @param string $object_type    Object type.
+	 * @param string $object_subtype Object subtype.
+	 * @return bool Whether the user is allowed to edit meta.
+	 */
+	public function auth_callback( bool $allowed, string $meta_key, string $object_type, string $object_subtype = '' ): bool { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+		return $this->auth( $allowed, $meta_key, 0, 0, '', [] );
+	}


The auth_callback adapter passes hardcoded dummy values (0, 0, '', []) for the object_id, user_id, cap, and caps parameters when calling the auth method. This means child classes that override the auth method will not have access to the actual values of these parameters when the callback is invoked via johnbillion/args. Consider documenting this limitation or ensuring that child classes that need these parameters override auth_callback instead of auth.

…ate parameters

ocean90 · 2026-02-03T15:14:02Z

@copilot open a new pull request to apply changes based on the comments in this thread

Copilot · 2026-02-03T15:14:13Z

@ocean90 I've opened a new pull request, #8, to work on those changes. Once the pull request is ready, I'll request review from you.

* Initial plan * Fix PHPDoc annotations and add PostType NAME constant Co-authored-by: ocean90 <617637+ocean90@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: ocean90 <617637+ocean90@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 23 out of 23 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-03T15:31:37Z

inc/PostType.php

+			 *   menu_position?: int,
+			 *   menu_icon?: string,
+			 *   capability_type?: string|array<int, string>,
+			 *   capabilities?: string[],


The type annotation for capabilities is string[], but according to WordPress documentation, this should be an associative array with specific keys like 'edit_post', 'read_post', 'delete_post', etc., mapping to capability names. The more accurate type would be array<string, string> to reflect the associative nature of this array.

Suggested change

* capabilities?: string[],

* capabilities?: array<string, string>,

Copilot · 2026-02-03T15:31:38Z

inc/Contracts/Taxonomy.php

@@ -13,4 +13,10 @@
 * @since 0.3.2
 */
 interface Taxonomy {


For consistency with other interface files in the codebase (like Registrable.php), this interface should also include declare( strict_types=1 ); after the opening PHP tag and before the namespace declaration.

Copilot · 2026-02-03T15:31:38Z

inc/Contracts/PostType.php

@@ -13,4 +13,10 @@
 * @since 0.3.2
 */
 interface PostType {


For consistency with other interface files in the codebase (like Registrable.php), this interface should also include declare( strict_types=1 ); after the opening PHP tag and before the namespace declaration.

ocean90 added 20 commits January 23, 2026 15:53

Update phpstan.neon.dist to change paths from 'src/' to 'inc/'

04cc382

Add detailed example functions for post types, post meta, and taxonom…

55bd2c2

…ies in README

Increase memory limit for PHPStan analysis script in composer.json

57872bb

Remove deprecated Legacy implementations

c90e645

Add strict_types declarations

600c49b

Type Admin helpers

21cab20

Type Container registry

9794843

Fix Page get_callback phpdoc

ac448b5

Type shortcode view contract

884f8e3

Align ShortcodeView attribute types

7646d35

Widen ShortcodeView attribute keys

91179c8

Type PostType NAME and args

8de801c

Type Taxonomy object types

0d31acc

Fix meta registration typings

06f2cf4

Type TermMetaAdminUI and taxonomy contract

5e2f4a3

Exclude Squiz.Commenting.VariableComment.MissingVar rule

c534953

Fix PHPCS issues

a3ddf9b

Remove Shortcode and ShortcodeView classes

f16ef04

Document factory-based registration

6072839

Remove FACTORIES.md documentation file

640ae89

ocean90 requested a review from Copilot January 25, 2026 12:45

Copilot started reviewing on behalf of ocean90 January 25, 2026 12:46 View session

Copilot AI reviewed Jan 25, 2026

View reviewed changes

Refactor render_column method to use filter instead of action and upd…

1d8df61

…ate parameters

Copilot AI mentioned this pull request Feb 3, 2026

Fix PHPDoc annotations and add PostType NAME constant #8

Merged

ocean90 requested a review from Copilot February 3, 2026 15:21

Copilot started reviewing on behalf of ocean90 February 3, 2026 15:22 View session

Copilot AI reviewed Feb 3, 2026

View reviewed changes

		@@ -137,16 +133,16 @@ class Page implements Registrable {
		*
		* @var string

		@@ -253,7 +247,7 @@ private function get_callback() {
		*
		* @return string The hook name of the menu page.

	* @return string The hook name of the menu page.
	* @return string\|false The hook name of the menu page.

	* capabilities?: string[],
	* capabilities?: array<string, string>,

Conversation

ocean90 commented Jan 25, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

Uh oh!

ocean90 commented Feb 3, 2026

Uh oh!

Copilot AI commented Feb 3, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants