From 65bb7d82adb5d018edf734bac0f6957ac0d4937d Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 24 Sep 2025 19:01:13 +0300 Subject: [PATCH 01/50] Repo set up --- .editorconfig | 18 ++++++ .env.testing | 57 +++++++++++++++++ .env.testing.slic | 57 +++++++++++++++++ .gitattributes | 11 ++++ .github/CODEOWNERS | 1 + .github/workflows/compatibility.yml | 40 ++++++++++++ .github/workflows/phpcs.yml | 34 +++++++++++ .github/workflows/static-analysis.yml | 21 +++++++ .github/workflows/tests-php.yml | 88 +++++++++++++++++++++++++++ .gitignore | 28 +++++++++ CHANGELOG.md | 9 +++ codeception.dist.yml | 20 ++++++ codeception.slic.yml | 3 + composer.json | 85 ++++++++++++++++++++++++++ phpcs.xml | 29 +++++++++ phpstan.neon.dist | 35 +++++++++++ schema-models.php | 20 ++++++ 17 files changed, 556 insertions(+) create mode 100644 .editorconfig create mode 100644 .env.testing create mode 100644 .env.testing.slic create mode 100644 .gitattributes create mode 100644 .github/CODEOWNERS create mode 100644 .github/workflows/compatibility.yml create mode 100644 .github/workflows/phpcs.yml create mode 100644 .github/workflows/static-analysis.yml create mode 100644 .github/workflows/tests-php.yml create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 codeception.dist.yml create mode 100644 codeception.slic.yml create mode 100644 composer.json create mode 100644 phpcs.xml create mode 100644 phpstan.neon.dist create mode 100644 schema-models.php diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..d240d02 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,18 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_style = tab +insert_final_newline = true +trim_trailing_whitespace = true + +[*.md] +trim_trailing_whitespace = true + +[*.{neon,neon.dist}] +indent_style = tab + +[**.{jshintrc,json,scss-lint,yml}] +indent_style = space +indent_size = 2 \ No newline at end of file diff --git a/.env.testing b/.env.testing new file mode 100644 index 0000000..ac84e89 --- /dev/null +++ b/.env.testing @@ -0,0 +1,57 @@ +# This file will be consumed by both the CI and the tests. +# Some environment variables might not apply to one but might apply to the other: modify with care. + +# What version of WordPress we want to install and test against. +# This has to be compatible with the `wp core download` command, see https://developer.wordpress.org/cli/commands/core/download/. +WP_VERSION=latest + +# This is where, in the context of the CI, we'll install and configure WordPress. +# See `.travis.yml` for more information. +WP_ROOT_FOLDER=/tmp/wordpress + +# The WordPress installation will be served from the Docker container. +# See `dev/docker/ci-compose.yml` for more information. +WP_URL=http://localhost:8080 +WP_DOMAIN=localhost:8080 + +# The credentials that will be used to access the site in acceptance tests +# in methods like `$I->loginAsAdmin();`. +WP_ADMIN_USERNAME=admin +WP_ADMIN_PASSWORD=password + +WP_DB_PORT=4306 + +# The databse is served from the Docker `db` container. +# See `dev/docker/ci-compose.yml` for more information. +WP_TABLE_PREFIX=wp_ +WP_DB_HOST=127.0.0.1:4306 +WP_DB_NAME=wordpress +WP_DB_USER=root +WP_DB_PASSWORD= + +# The test databse is served from the Docker `db` container. +# See `dev/docker/ci-compose.yml` for more information. +WP_TEST_DB_HOST=127.0.0.1:4306 +WP_TEST_DB_NAME=test +WP_TEST_DB_USER=root +WP_TEST_DB_PASSWORD= + +# We're using Selenium and Chrome for acceptance testing. +# In CI context we're starting a Docker container to handle that. +# See the `dev/docker/ci-compose.yml` file. +CHROMEDRIVER_HOST=localhost +CHROMEDRIVER_PORT=4444 + +# The URL of the WordPress installation from the point of view of the Chromedriver container. +# Why not just use `wordpress`? While Chrome will accept an `http://wordpress` address WordPress +# will not, we call the WordPress container with a seemingly looking legit URL and leverage the +# lines that, in the `wp-config.php` file, will make it so that WordPress will use as its home +# URL whatever URL we reach it with. +# See the `dev/docker/wp-config.php` template for more information. +WP_CHROMEDRIVER_URL="wp.test" + +# To run the tests let's force the background-processing lib to run in synchronous (single PHP thread) mode. +TRIBE_NO_ASYNC=1 + +# We're using Docker to run the tests. +USING_CONTAINERS=1 diff --git a/.env.testing.slic b/.env.testing.slic new file mode 100644 index 0000000..20de04b --- /dev/null +++ b/.env.testing.slic @@ -0,0 +1,57 @@ +# This file will be consumed by both the CI and the tests. +# Some environment variables might not apply to one but might apply to the other: modify with care. + +# What version of WordPress we want to install and test against. +# This has to be compatible with the `wp core download` command, see https://developer.wordpress.org/cli/commands/core/download/. +WP_VERSION=latest + +# This is where, in the context of the CI, we'll install and configure WordPress. +# See `.travis.yml` for more information. +WP_ROOT_FOLDER=/var/www/html + +# The WordPress installation will be served from the Docker container. +# See `dev/docker/ci-compose.yml` for more information. +WP_URL=http://wordpress.test +WP_DOMAIN=wordpress.test + +# The credentials that will be used to access the site in acceptance tests +# in methods like `$I->loginAsAdmin();`. +WP_ADMIN_USERNAME=admin +WP_ADMIN_PASSWORD=password + +WP_DB_PORT=3306 + +# The databse is served from the Docker `db` container. +# See `dev/docker/ci-compose.yml` for more information. +WP_TABLE_PREFIX=wp_ +WP_DB_HOST=db +WP_DB_NAME=test +WP_DB_USER=root +WP_DB_PASSWORD=password + +# The test databse is served from the Docker `db` container. +# See `dev/docker/ci-compose.yml` for more information. +WP_TEST_DB_HOST=db +WP_TEST_DB_NAME=test +WP_TEST_DB_USER=root +WP_TEST_DB_PASSWORD=password + +# We're using Selenium and Chrome for acceptance testing. +# In CI context we're starting a Docker container to handle that. +# See the `dev/docker/ci-compose.yml` file. +CHROMEDRIVER_HOST=chrome +CHROMEDRIVER_PORT=4444 + +# The URL of the WordPress installation from the point of view of the Chromedriver container. +# Why not just use `wordpress`? While Chrome will accept an `http://wordpress` address WordPress +# will not, we call the WordPress container with a seemingly looking legit URL and leverage the +# lines that, in the `wp-config.php` file, will make it so that WordPress will use as its home +# URL whatever URL we reach it with. +# See the `dev/docker/wp-config.php` template for more information. +WP_CHROMEDRIVER_URL=http://wordpress.test + +# To run the tests let's force the background-processing lib to run in synchronous (single PHP thread) mode. +TRIBE_NO_ASYNC=1 + +# We're using Docker to run the tests. +USING_CONTAINERS=1 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..c50ac9c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +* text +.* export-ignore +composer.lock text -diff +phpstan.* export-ignore +phpunit.* export-ignore +tests export-ignore +codeception.* export-ignore +phpcs.xml export-ignore +phpstan.neon.dist export-ignore +docs export-ignore +schema-models.php export-ignore diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..b778c9e --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @dpanta94 \ No newline at end of file diff --git a/.github/workflows/compatibility.yml b/.github/workflows/compatibility.yml new file mode 100644 index 0000000..78c7a0e --- /dev/null +++ b/.github/workflows/compatibility.yml @@ -0,0 +1,40 @@ +name: PHP Compatibility +on: + pull_request: +jobs: + php-compatibility: + name: PHP ${{ matrix.php-version }} + runs-on: ubuntu-latest + strategy: + matrix: + php-version: ["7.4", "8.0", "8.1", "8.2", "8.3", "8.4"] + + steps: + - uses: actions/checkout@v4 + + - name: Configure PHP environment + uses: shivammathur/setup-php@v2 + with: + php-version: 7.4 + extensions: mbstring, intl + coverage: none + + - name: Get Composer Cache Directory + id: composer-cache + run: | + echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT + + - uses: actions/cache@v4 + with: + path: ${{ steps.composer-cache.outputs.dir }} + key: ${{ runner.os }}-composer-${{ hashFiles('composer.lock') }} + restore-keys: | + ${{ runner.os }}-composer- + + - uses: ramsey/composer-install@v3 + with: + composer-options: "--ignore-platform-reqs" + dependency-versions: highest + + - name: Run PHP Compatibility + run: composer compatibility:php-${{ matrix.php-version }} diff --git a/.github/workflows/phpcs.yml b/.github/workflows/phpcs.yml new file mode 100644 index 0000000..c58c87a --- /dev/null +++ b/.github/workflows/phpcs.yml @@ -0,0 +1,34 @@ +name: 'PHPCS' +on: + pull_request: +jobs: + phpcs: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Composer install + uses: php-actions/composer@v6 + with: + php_version: 7.4 + php_extensions: zip mysqli + args: --ignore-platform-reqs + + - name: Fix and Push phpcbf issues + continue-on-error: true + run: | + vendor/bin/phpcbf ./ + + - name: Commit & Push changes + uses: actions-js/push@master + continue-on-error: true + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + branch: ${{ github.head_ref }} + + - name: PHP Code Sniffer + run: | + vendor/bin/phpcs ./ diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml new file mode 100644 index 0000000..e63c3cd --- /dev/null +++ b/.github/workflows/static-analysis.yml @@ -0,0 +1,21 @@ +name: Static Analysis +on: + pull_request: +jobs: + phpstsan: + name: phpstan + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Configure PHP environment + uses: shivammathur/setup-php@v2 + with: + php-version: '8.0' + extensions: mbstring, intl + coverage: none + - uses: ramsey/composer-install@v2 + with: + composer-options: "--ignore-platform-reqs --optimize-autoloader" + - name: Run PHPStan static analysis + run: composer test:analysis diff --git a/.github/workflows/tests-php.yml b/.github/workflows/tests-php.yml new file mode 100644 index 0000000..0ab5542 --- /dev/null +++ b/.github/workflows/tests-php.yml @@ -0,0 +1,88 @@ +name: 'Tests' +on: + pull_request: +jobs: + test: + strategy: + matrix: + suite: + - wpunit + runs-on: ubuntu-latest + steps: + - name: Checkout the repository + uses: actions/checkout@v4 + # ------------------------------------------------------------------------------ + # Set up PHP to run slic + # ------------------------------------------------------------------------------ + - name: Configure PHP environment + uses: shivammathur/setup-php@v2 + with: + php-version: 7.4 + # ------------------------------------------------------------------------------ + # Checkout slic + # ------------------------------------------------------------------------------ + - name: Checkout slic + uses: actions/checkout@v4 + with: + repository: stellarwp/slic + ref: main + path: slic + fetch-depth: 1 + # ------------------------------------------------------------------------------ + # Prepare our composer cache directory + # ------------------------------------------------------------------------------ + - name: Get Composer Cache Directory + id: get-composer-cache-dir + run: | + echo "::set-output name=dir::$(composer config cache-files-dir)" + - uses: actions/cache@v4 + id: composer-cache + with: + path: ${{ steps.get-composer-cache-dir.outputs.dir }} + key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} + restore-keys: | + ${{ runner.os }}-composer- + # ------------------------------------------------------------------------------ + # Initialize slic + # ------------------------------------------------------------------------------ + - name: Set up slic env vars + run: | + echo "SLIC_BIN=${GITHUB_WORKSPACE}/slic/slic" >> $GITHUB_ENV + echo "SLIC_WP_DIR=${GITHUB_WORKSPACE}/slic/_wordpress" >> $GITHUB_ENV + echo "SLIC_WORDPRESS_DOCKERFILE=Dockerfile.base" >> $GITHUB_ENV + - name: Set run context for slic + run: echo "SLIC=1" >> $GITHUB_ENV && echo "CI=1" >> $GITHUB_ENV + - name: Start ssh-agent + run: | + mkdir -p "${HOME}/.ssh"; + ssh-agent -a /tmp/ssh_agent.sock; + - name: Export SSH_AUTH_SOCK env var + run: echo "SSH_AUTH_SOCK=/tmp/ssh_agent.sock" >> $GITHUB_ENV + - name: Set up slic for CI + run: | + cd ${GITHUB_WORKSPACE}/.. + ${SLIC_BIN} here + ${SLIC_BIN} interactive off + ${SLIC_BIN} build-prompt off + ${SLIC_BIN} build-subdir off + ${SLIC_BIN} xdebug off + ${SLIC_BIN} debug on + ${SLIC_BIN} info + ${SLIC_BIN} config + - name: Start the Chrome container + run: ${SLIC_BIN} up chrome + - name: Set up StellarWP Schema Models + run: | + ${SLIC_BIN} use schema-models + ${SLIC_BIN} composer install + - name: Init the WordPress container + run: | + ${SLIC_BIN} up wordpress + ${SLIC_BIN} wp core version + ${SLIC_BIN} wp core update --force --version=6.7 + ${SLIC_BIN} wp core version + - name: Ensure Kadence is installed + run: | + ${SLIC_BIN} wp theme install kadence --activate + - name: Run suites + run: ${SLIC_BIN} run ${{ matrix.suite }} --ext DotReporter diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..53ee91a --- /dev/null +++ b/.gitignore @@ -0,0 +1,28 @@ +composer.lock +vendor/ +tests/_support/_generated + +# Dev tools +.buildpath +*.iml +.project +.idea/ +.vscode/ + +# Third party dependencies +vendor/ + +# Tests +codeception.yml +tests/_output/* +tests/*.suite.yml +!tests/_data/*.sql +tests/*.pem +tests/*.cert +tests/*.key + +.DS_Store +DOCKER_ENV +Dockerfile-* +output.log +docker_tag diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..b73e831 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,9 @@ +# Change Log + +All notable changes to this project will be documented in this file. This project adhere to the [Semantic Versioning](http://semver.org/) standard. + +## [0.0.1] 2025-09-24 + +* Feature - Initial release of Schema Models. + +[0.0.1]: https://github.com/stellarwp/schema-models/releases/tag/0.0.1 diff --git a/codeception.dist.yml b/codeception.dist.yml new file mode 100644 index 0000000..d350739 --- /dev/null +++ b/codeception.dist.yml @@ -0,0 +1,20 @@ +actor: Tester +bootstrap: _bootstrap.php +paths: + tests: tests + log: tests/_output + data: tests/_data + helpers: tests/_support + wp_root: "%WP_ROOT_FOLDER%" +settings: + colors: true + memory_limit: 1024M +snapshot: + refresh: true +coverage: + enabled: true + include: + - src/**/*.php +params: + # read dynamic configuration parameters from the .env file + - .env.testing diff --git a/codeception.slic.yml b/codeception.slic.yml new file mode 100644 index 0000000..9bcf605 --- /dev/null +++ b/codeception.slic.yml @@ -0,0 +1,3 @@ +params: + # read dynamic configuration parameters from the .env file + - .env.testing.slic diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..2bea5ed --- /dev/null +++ b/composer.json @@ -0,0 +1,85 @@ +{ + "name": "stellarwp/schema-models", + "description": "A library for offloading tasks to background processes.", + "type": "library", + "license": "MIT", + "config": { + "platform": { + "php": "7.4" + }, + "allow-plugins": { + "dealerdirect/phpcodesniffer-composer-installer": true + } + }, + "autoload": { + "psr-4": { + "StellarWP\\SchemaModels\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "StellarWP\\SchemaModels\\Tests\\": "tests/_support/Helper/" + } + }, + "authors": [ + { + "name": "StellarWP", + "email": "dev@stellarwp.com" + }, + { + "name": "Dimitrios Pantazis", + "email": "dimi@stellarwp.com" + } + ], + "minimum-stability": "stable", + "require": { + "php": ">=7.4", + "stellarwp/models": "^2.0", + "stellarwp/schema": "^3.0" + }, + "require-dev": { + "stellarwp/coding-standards": "^2.1", + "codeception/module-asserts": "^1.3", + "codeception/module-cli": "^1.1", + "codeception/module-db": "^1.2", + "codeception/module-filesystem": "^1.0", + "codeception/module-phpbrowser": "^1.0", + "codeception/module-rest": "^2.0", + "codeception/module-webdriver": "^1.4", + "codeception/util-universalframework": "^1.0", + "lucatume/wp-browser": "^3.5.7", + "phpcompatibility/phpcompatibility-wp": "^2.1", + "szepeviktor/phpstan-wordpress": "^2.0", + "lucatume/di52": "^4.0", + "slope-it/clock-mock": "^0.4.0", + "lucatume/codeception-snapshot-assertions": "^0.4.0" + }, + "scripts": { + "test:analysis": [ + "phpstan analyse -c phpstan.neon.dist --memory-limit=512M" + ], + "compatibility:php-7.4": "phpcs ./src -s --standard=PHPCompatibilityWP --runtime-set testVersion 7.4", + "compatibility:php-8.0": "phpcs ./src -s --standard=PHPCompatibilityWP --runtime-set testVersion 8.0", + "compatibility:php-8.1": "phpcs ./src -s --standard=PHPCompatibilityWP --runtime-set testVersion 8.1", + "compatibility:php-8.2": "phpcs ./src -s --standard=PHPCompatibilityWP --runtime-set testVersion 8.2", + "compatibility:php-8.3": "phpcs ./src -s --standard=PHPCompatibilityWP --runtime-set testVersion 8.3", + "compatibility:php-8.4": "phpcs ./src -s --standard=PHPCompatibilityWP --runtime-set testVersion 8.4", + "compatibility": [ + "@compatibility:php-7.4", + "@compatibility:php-8.0", + "@compatibility:php-8.1", + "@compatibility:php-8.2", + "@compatibility:php-8.3", + "@compatibility:php-8.4" + ] + }, + "scripts-descriptions": { + "test:analysis": "Run static code analysis.", + "compatibility:php-7.4": "Run PHPCompatibilityWP compatibility checks for PHP 7.4.", + "compatibility:php-8.0": "Run PHPCompatibilityWP compatibility checks for PHP 8.0.", + "compatibility:php-8.1": "Run PHPCompatibilityWP compatibility checks for PHP 8.1.", + "compatibility:php-8.2": "Run PHPCompatibilityWP compatibility checks for PHP 8.2.", + "compatibility:php-8.3": "Run PHPCompatibilityWP compatibility checks for PHP 8.3.", + "compatibility:php-8.4": "Run PHPCompatibilityWP compatibility checks for PHP 8.4." + } +} diff --git a/phpcs.xml b/phpcs.xml new file mode 100644 index 0000000..c8bf9b9 --- /dev/null +++ b/phpcs.xml @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + */tests/* + */vendor/* + */docs/* + diff --git a/phpstan.neon.dist b/phpstan.neon.dist new file mode 100644 index 0000000..8dddba4 --- /dev/null +++ b/phpstan.neon.dist @@ -0,0 +1,35 @@ +# Configuration for PHPStan +# https://phpstan.org/config-reference + +includes: + # @see https://github.com/phpstan/phpstan-src/blob/master/conf/bleedingEdge.neon + - phar://phpstan.phar/conf/bleedingEdge.neon + # Include this extension + - vendor/szepeviktor/phpstan-wordpress/extension.neon + +parameters: + parallel: + jobSize: 10 + maximumNumberOfProcesses: 32 + minimumNumberOfJobsPerProcess: 2 + level: 5 + inferPrivatePropertyTypeFromConstructor: true + reportUnmatchedIgnoredErrors: false + treatPhpDocTypesAsCertain: false + scanDirectories: + - vendor/woocommerce/action-scheduler/ + + # Paths to be analyzed. + paths: + - %currentWorkingDirectory%/src + + ignoreErrors: + # Uses func_get_args() + - '#^Function add_query_arg invoked with [123] parameters?, 0 required\.$#' + # Uses func_get_args() + - '#^Function apply_filters(_ref_array)? invoked with [34567] parameters, 2 required\.$#' + - '#^Constant WP_CONTENT_DIR not found\.$#' + - '#^Constant WP_CONTENT_URL not found\.$#' + - '#^Constant WPMU_PLUGIN_URL not found\.$#' + - '#^Constant WP_PLUGIN_DIR not found\.$#' + - '#^Constant WP_PLUGIN_URL not found\.$#' diff --git a/schema-models.php b/schema-models.php new file mode 100644 index 0000000..453b918 --- /dev/null +++ b/schema-models.php @@ -0,0 +1,20 @@ + Date: Wed, 24 Sep 2025 19:22:14 +0300 Subject: [PATCH 02/50] Moved implementation from models --- src/Contracts/SchemaModel.php | 112 +++++++ src/SchemaModel.php | 537 ++++++++++++++++++++++++++++++++++ 2 files changed, 649 insertions(+) create mode 100644 src/Contracts/SchemaModel.php create mode 100644 src/SchemaModel.php diff --git a/src/Contracts/SchemaModel.php b/src/Contracts/SchemaModel.php new file mode 100644 index 0000000..63c95c9 --- /dev/null +++ b/src/Contracts/SchemaModel.php @@ -0,0 +1,112 @@ + $attributes Attributes. + */ + public function __construct( array $attributes = [] ) { + $this->propertyCollection = ModelPropertyCollection::fromPropertyDefinitions( $this->getPropertyDefinitionsFromSchema(), $attributes ); + } + + abstract public function getTableInterface(): Table_Interface; + + /** + * Gets the primary value of the model. + * + * @since 0.0.1 + * + * @return mixed + */ + public function getPrimaryValue() { + return $this->getAttribute( $this->getPrimaryColumn() ); + } + + /** + * Gets the primary column of the model. + * + * @since 0.0.1 + * + * @return string + */ + public function getPrimaryColumn(): string { + return $this->getTableInterface()::uid_column(); + } + + /** + * Magic method to get the relationships of the model. + * + * @since 0.0.1 + * + * @param string $name The name of the method. + * @param array $arguments The arguments of the method. + * + * @return array|void The relationships of the model. + * + * @throws BadMethodCallException If the method does not exist on the model. + * @throws BadMethodCallException If the relationship does not exist on the model. + * @throws BadMethodCallException If the relationship is not a many to many relationship. + */ + public function __call( string $name, array $arguments ) { + if ( ! str_starts_with( $name, 'get_' ) && ! str_starts_with( $name, 'set_' ) ) { + throw new BadMethodCallException( "Method {$name} does not exist on the model." ); + } + + $property = str_replace( [ 'get_', 'set_' ], '', $name ); + $relationships = $this->getRelationships(); + + if ( ! $this->hasProperty( $property ) && ! isset( $relationships[ $property ] ) ) { + throw new BadMethodCallException( "`{$property}` is not a property or a relationship on the model." ); + } + + $is_getter = str_starts_with( $name, 'get_' ); + + if ( $is_getter ) { + if ( isset( $relationships[ $property ] ) ) { + return $this->getRelationship( $property ); + } + + return $this->getAttribute( $property ); + } + + $args = $arguments['0'] ?? null; + $args = (array) $args; + if ( isset( $relationships[ $property ] ) ) { + $args ? $this->setRelationship( $property, $args ) : $this->deleteRelationshipData( $property ); + return; + } + + $this->setAttribute( $property, $args ); + } + + /** + * Gets the relationships of the model. + * + * @since 0.0.1 + * + * @return array The relationships of the model. + */ + public function getRelationships(): array { + return static::$relationships; + } + + /** + * Deletes the relationship data for a given key. + * + * @since 0.0.1 + * + * @param string $key The key of the relationship. + * + * @throws InvalidArgumentException If the relationship does not exist. + */ + public function deleteRelationshipData( string $key ): void { + if ( ! isset( $this->getRelationships()[ $key ] ) ) { + throw new InvalidArgumentException( "Relationship {$key} does not exist." ); + } + + if ( $this->getRelationships()[ $key ]['type'] === Relationship::MANY_TO_MANY ) { + $this->getRelationships()[ $key ]['through']::delete( $this->getPrimaryValue(), $this->getRelationships()[ $key ]['columns']['this'] ); + } + } + + /** + * Adds an ID to a relationship. + * + * @since 0.0.1 + * + * @param string $key The key of the relationship. + * @param int $id The ID to add. + * + * @throws InvalidArgumentException If the relationship does not exist. + */ + public function addToRelationship( string $key, int $id ): void { + if ( ! isset( $this->getRelationships()[ $key ] ) ) { + throw new InvalidArgumentException( "Relationship {$key} does not exist." ); + } + + if ( ! isset( $this->relationshipData[ $key ] ) ) { + $this->relationshipData[ $key ] = []; + } + + if ( ! isset( $this->relationshipData[ $key ]['insert'] ) ) { + $this->relationshipData[ $key ]['insert'] = []; + } + + $this->relationshipData[ $key ]['insert'][] = $id; + + if ( ! empty( $this->relationshipData[ $key ]['delete'] ) ) { + $this->relationshipData[ $key ]['delete'] = array_diff( $this->relationshipData[ $key ]['delete'], [ $id ] ); + } + + $this->relationshipData[ $key ]['current'] = array_unique( array_merge( $this->relationshipData[ $key ]['current'] ?? [], [ $id ] ) ); + } + + /** + * Removes an ID from a relationship. + * + * @since 0.0.1 + * + * @param string $key The key of the relationship. + * @param int $id The ID to remove. + * + * @throws InvalidArgumentException If the relationship does not exist. + */ + public function removeFromRelationship( string $key, int $id ): void { + if ( ! isset( $this->getRelationships()[ $key ] ) ) { + throw new InvalidArgumentException( "Relationship {$key} does not exist." ); + } + + if ( ! isset( $this->relationshipData[ $key ] ) ) { + $this->relationshipData[ $key ] = []; + } + + if ( ! isset( $this->relationshipData[ $key ]['delete'] ) ) { + $this->relationshipData[ $key ]['delete'] = []; + } + + $this->relationshipData[ $key ]['delete'][] = $id; + + if ( ! empty( $this->relationshipData[ $key ]['insert'] ) ) { + $this->relationshipData[ $key ]['insert'] = array_diff( $this->relationshipData[ $key ]['insert'], [ $id ] ); + } + + $this->relationshipData[ $key ]['current'] = array_diff( $this->relationshipData[ $key ]['current'] ?? [], [ $id ] ); + } + + /** + * Get the property definitions from the schema. + * + * @since 0.0.1 + * + * @return array + */ + private function getPropertyDefinitionsFromSchema(): array { + $table_interface = $this->getTableInterface(); + /** @var Table_Schema_Interface $table_schema */ + $table_schema = $table_interface::get_current_schema(); + + $property_definitions = []; + + foreach ( $table_schema->get_columns() as $column ) { + $definition = ( new ModelPropertyDefinition() )->type( $column->get_php_type() ); + if ( $column->get_nullable() ) { + $definition->nullable(); + } + + if ( $column->get_default() ) { + $definition->default( $column->get_default() ); + } + + if ( is_callable( [ $this->getTableInterface(), 'cast_value_based_on_type' ] ) ) { + $definition->castWith( fn( $value ) => $this->getTableInterface()::cast_value_based_on_type( $column->get_php_type(), $value ) ); + } + + $property_definitions[ $column->get_name() ] = $definition; + } + + static::$properties = $property_definitions; + + return $property_definitions; + } + + /** + * Sets a relationship. + * + * @since 2.0.0 + * + * @param string $key Relationship name. + * @param mixed $value Relationship value. + */ + protected function setRelationship( string $key, $value ): void { + $old_value = $this->relationshipData[ $key ]['current'] ?? null; + $this->relationshipData[ $key ]['current'] = $value; + + if ( $old_value ) { + if ( is_array( $old_value ) ) { + foreach ( $old_value as $i ) { + $this->removeFromRelationship( $key, $i ); + } + } else { + $this->removeFromRelationship( $key, $old_value ); + } + } + + if ( is_array( $value ) ) { + foreach ( $value as $i ) { + if ( ! is_int( $i ) ) { + throw new InvalidArgumentException( "Relationship {$key} must be an integer." ); + } + + $this->addToRelationship( $key, $i ); + } + } else { + if ( ! is_int( $value ) ) { + throw new InvalidArgumentException( "Relationship {$key} must be an integer." ); + } + + $this->addToRelationship( $key, $value ); + } + } + + /** + * Returns a relationship. + * + * @since 0.0.1 + * + * @param string $key Relationship name. + * + * @return Model|Model[] + */ + protected function getRelationship( string $key ) { + $relationships = $this->getRelationships(); + if ( ! isset( $relationships[ $key ] ) ) { + throw new InvalidArgumentException( "Relationship {$key} does not exist." ); + } + + if ( isset( $this->relationshipData[ $key ]['current'] ) ) { + return $this->relationshipData[ $key ]['current']; + } + + $relationship = $relationships[ $key ]; + + $relationship_type = $relationship['type']; + + switch ( $relationship_type ) { + case Relationship::BELONGS_TO: + case Relationship::HAS_ONE: + if ( 'post' === $relationship['entity'] ) { + return $this->relationshipData[ $key ]['current'] = get_post( $this->getAttribute( $key ) ); + } + + throw new InvalidArgumentException( "Relationship {$key} is not a post relationship." ); + case Relationship::HAS_MANY: + case Relationship::BELONGS_TO_MANY: + case Relationship::MANY_TO_MANY: + return $this->relationshipData[ $key ]['current'] = wp_list_pluck( + $relationship['through']::get_all_by( + $relationship['columns']['this'], + $this->getPrimaryValue() + ), + $relationship['columns']['other'] + ); + } + + return null; + } + + /** + * Saves the relationship data. + * + * @since 0.0.1 + * + * @return void + */ + private function saveRelationshipData(): void { + foreach ( $this->getRelationships() as $key => $relationship ) { + if ( Relationship::MANY_TO_MANY !== $relationship['type'] ) { + continue; + } + + if ( ! empty( $this->relationshipData[ $key ]['insert'] ) ) { + $insert_data = []; + foreach ( $this->relationshipData[ $key ]['insert'] as $insert_id ) { + $insert_data[] = [ + $this->getRelationships()[ $key ]['columns']['this'] => $this->getPrimaryValue(), + $this->getRelationships()[ $key ]['columns']['other'] => $insert_id, + ]; + } + + // First delete them to avoid duplicates. + $relationship['through']::delete_many( + $this->relationshipData[ $key ]['insert'], + $this->getRelationships()[ $key ]['columns']['other'], + DB::prepare( ' AND %i = %d', $this->getRelationships()[ $key ]['columns']['this'], $this->getPrimaryValue() ) + ); + + $relationship['through']::insert_many( $insert_data ); + } + + if ( ! empty( $this->relationshipData[ $key ]['delete'] ) ) { + $relationship['through']::delete_many( + $this->relationshipData[ $key ]['delete'], + $this->get_relationships()[ $key ]['columns']['other'], + DB::prepare( ' AND %i = %d', $this->get_relationships()[ $key ]['columns']['this'], $this->getPrimaryValue() ) + ); + } + } + } + + /** + * Saves the model. + * + * @since 0.0.1 + * + * @return int The id of the saved model. + * + * @throws RuntimeException If the model fails to save. + */ + public function save(): int { + if ( ! $this->isDirty() ) { + $this->saveRelationshipData(); + return $this->getPrimaryValue(); + } + + $table_interface = $this->getTableInterface(); + $result = $table_interface::upsert( $this->toArray() ); + + if ( ! $result ) { + throw new RuntimeException( __( 'Failed to save the model.', 'tribe-common' ) ); + } + + $id = $this->getPrimaryValue(); + + if ( ! $id ) { + $id = DB::last_insert_id(); + $this->setAttribute( $this->getPrimaryColumn(), $id ); + } + + $this->commitChanges(); + + $this->saveRelationshipData(); + + return $id; + } + + /** + * Deletes the model. + * + * @since TBD + * + * @return bool Whether the model was deleted. + * + * @throws RuntimeException If the model ID required to delete the model is not set. + */ + public function delete(): bool { + $uid = $this->getPrimaryValue(); + + if ( ! $uid ) { + throw new RuntimeException( __( 'Model ID is required to delete the model.', 'tribe-common' ) ); + } + + $this->deleteAllRelationshipData(); + + return $this->getTableInterface()::delete( $uid ); + } + + /** + * Deletes all the relationship data. + * + * @since 0.0.1 + * + * @return void + */ + private function deleteAllRelationshipData(): void { + if ( empty( $this->getRelationships() ) ) { + return; + } + + foreach ( array_keys( $this->getRelationships() ) as $key ) { + $this->deleteRelationshipData( $key ); + } + } + + /** + * Sets a relationship for the model. + * + * @since 0.0.1 + * + * @param string $key The key of the relationship. + * @param string $type The type of the relationship. + * @param ?string $through A table interface that provides the relationship. + * @param string $relationship_entity The entity of the relationship. + */ + protected function defineRelationship( string $key, string $type, ?string $through = null, string $relationship_entity = 'post' ): void { + static::$relationships[ $key ] = [ + 'type' => $type, + 'through' => $through, + 'entity' => $relationship_entity, + ]; + } + + /** + * Sets the relationship columns for the model. + * + * @since 0.0.1 + * + * @param string $key The key of the relationship. + * @param string $this_entity_column The column of the relationship. + * @param string $other_entity_column The other entity column. + * + * @throws InvalidArgumentException If the relationship does not exist. + */ + protected function defineRelationshipColumns( string $key, string $this_entity_column, string $other_entity_column ): void { + if ( ! isset( $this->getRelationships()[ $key ] ) ) { + throw new InvalidArgumentException( "Relationship {$key} does not exist." ); + } + + static::$relationships[ $key ]['columns'] = [ + 'this' => $this_entity_column, + 'other' => $other_entity_column, + ]; + } + + /** + * Constructs a model instance from database query data. + * + * @param object|array $queryData + * @param int $mode The level of strictness to take when constructing the object, by default it will ignore extra keys but error on missing keys. + * @return static + */ + public static function fromData($data, $mode = self::BUILD_MODE_IGNORE_EXTRA) { + if ( ! is_object( $data ) && ! is_array( $data ) ) { + throw new InvalidArgumentException( 'Query data must be an object or array' ); + } + + $data = (array) $data; + + $model = new static(); + + foreach (static::propertyKeys() as $key) { + $property_definition = static::getPropertyDefinition( $key ); + if ( $key !== $model->getPrimaryColumn() && ! array_key_exists( $key, $data ) && ! $property_definition->hasDefault() ) { + throw new InvalidArgumentException( "Property '$key' does not exist." ); + } + + if ( ! isset( $data[ $key ] ) ) { + continue; + } + + // Remember not to use $type, as it may be an array that includes the default value. Safer to use getPropertyType(). + $model->setAttribute( $key, static::castValueForProperty( static::getPropertyDefinition( $key ), $data[ $key ], $key ) ); + } + + foreach ( $model->getRelationships() as $key => $relationship ) { + if ( ! isset( $data[ $key ] ) ) { + continue; + } + + $model->setRelationship( $key, $data[ $key ] ); + } + + if ( $model->getPrimaryValue() ) { + $model->commitChanges(); + } + + return $model; + } +} From c839624e32ebbcfb887d68a70bc4dd7c0366104c Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 24 Sep 2025 20:44:09 +0300 Subject: [PATCH 03/50] Fix tests --- composer.json | 2 +- tests/_bootstrap.php | 3 + tests/_data/.gitkeep | 0 tests/_output/.gitignore | 2 + tests/_support/Helper/Container.php | 25 ++++ .../Helper/Schema/MockModelSchema.php | 12 ++ .../MockModelSchemaWithRelationship.php | 19 +++ .../_support/Helper/Schema/MockModelTable.php | 46 ++++++ .../Schema/MockRelationshipModelTable.php | 46 ++++++ .../Helper/Schema/MockRelationshipTable.php | 43 ++++++ tests/_support/Helper/Wpunit.php | 10 ++ tests/_support/WpunitTester.php | 26 ++++ tests/config.php | 16 ++ tests/wpunit.suite.dist.yml | 22 +++ tests/wpunit/SchemaModelRelationshipsTest.php | 137 ++++++++++++++++++ tests/wpunit/SchemaModelTest.php | 101 +++++++++++++ tests/wpunit/_bootstrap.php | 40 +++++ 17 files changed, 549 insertions(+), 1 deletion(-) create mode 100644 tests/_bootstrap.php create mode 100644 tests/_data/.gitkeep create mode 100644 tests/_output/.gitignore create mode 100644 tests/_support/Helper/Container.php create mode 100644 tests/_support/Helper/Schema/MockModelSchema.php create mode 100644 tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php create mode 100644 tests/_support/Helper/Schema/MockModelTable.php create mode 100644 tests/_support/Helper/Schema/MockRelationshipModelTable.php create mode 100644 tests/_support/Helper/Schema/MockRelationshipTable.php create mode 100644 tests/_support/Helper/Wpunit.php create mode 100644 tests/_support/WpunitTester.php create mode 100644 tests/config.php create mode 100644 tests/wpunit.suite.dist.yml create mode 100644 tests/wpunit/SchemaModelRelationshipsTest.php create mode 100644 tests/wpunit/SchemaModelTest.php create mode 100644 tests/wpunit/_bootstrap.php diff --git a/composer.json b/composer.json index 2bea5ed..1b82b32 100644 --- a/composer.json +++ b/composer.json @@ -34,7 +34,7 @@ "minimum-stability": "stable", "require": { "php": ">=7.4", - "stellarwp/models": "^2.0", + "stellarwp/models": "dev-feat/introduce-schema-model", "stellarwp/schema": "^3.0" }, "require-dev": { diff --git a/tests/_bootstrap.php b/tests/_bootstrap.php new file mode 100644 index 0000000..b615677 --- /dev/null +++ b/tests/_bootstrap.php @@ -0,0 +1,3 @@ +defineRelationship( 'posts', Relationship::MANY_TO_MANY, MockRelationshipTable::class ); + $this->defineRelationshipColumns( 'posts', 'mock_model_id', 'post_id' ); + } + public function getTableInterface(): Table_Interface { + return new MockRelationshipModelTable(); + } +} diff --git a/tests/_support/Helper/Schema/MockModelTable.php b/tests/_support/Helper/Schema/MockModelTable.php new file mode 100644 index 0000000..3f9701d --- /dev/null +++ b/tests/_support/Helper/Schema/MockModelTable.php @@ -0,0 +1,46 @@ +set_default( 'Michael' ); + $columns[] = ( new String_Column( 'lastName' ) ); + $columns[] = ( new Text_Column( 'emails' ) )->set_php_type( PHP_Types::JSON ); + $columns[] = ( new Float_Column( 'microseconds' ) )->set_length( 17 )->set_precision( 6 ); + $columns[] = ( new Integer_Column( 'int' ) ); + $columns[] = ( new DateTime_Column( 'date' ) ); + + $table_name = static::table_name( true ); + + return [ + static::SCHEMA_VERSION => fn() => new Table_Schema( $table_name, $columns ), + ]; + } + + public static function transform_from_array( array $data ): MockModelSchema { + return MockModelSchema::fromData( $data ); + } +} diff --git a/tests/_support/Helper/Schema/MockRelationshipModelTable.php b/tests/_support/Helper/Schema/MockRelationshipModelTable.php new file mode 100644 index 0000000..25b8422 --- /dev/null +++ b/tests/_support/Helper/Schema/MockRelationshipModelTable.php @@ -0,0 +1,46 @@ +set_default( 'Michael' ); + $columns[] = ( new String_Column( 'lastName' ) ); + $columns[] = ( new Text_Column( 'emails' ) )->set_php_type( PHP_Types::JSON ); + $columns[] = ( new Float_Column( 'microseconds' ) )->set_length( 17 )->set_precision( 6 ); + $columns[] = ( new Integer_Column( 'int' ) ); + $columns[] = ( new DateTime_Column( 'date' ) ); + + $table_name = static::table_name( true ); + + return [ + static::SCHEMA_VERSION => fn() => new Table_Schema( $table_name, $columns ), + ]; + } + + public static function transform_from_array( array $data ): MockModelSchemaWithRelationship { + return MockModelSchemaWithRelationship::fromData( $data ); + } +} diff --git a/tests/_support/Helper/Schema/MockRelationshipTable.php b/tests/_support/Helper/Schema/MockRelationshipTable.php new file mode 100644 index 0000000..b1da3f0 --- /dev/null +++ b/tests/_support/Helper/Schema/MockRelationshipTable.php @@ -0,0 +1,43 @@ +set_columns( 'post_id', 'mock_model_id' ); + + $table_name = static::table_name( true ); + + return [ + static::SCHEMA_VERSION => fn() => new Table_Schema( $table_name, $columns, $indexes ), + ]; + } + + public static function transform_from_array( array $data ) { + return $data; + } +} diff --git a/tests/_support/Helper/Wpunit.php b/tests/_support/Helper/Wpunit.php new file mode 100644 index 0000000..96b4182 --- /dev/null +++ b/tests/_support/Helper/Wpunit.php @@ -0,0 +1,10 @@ + getenv( 'WP_ROOT_FOLDER' ) . '/wp-content', + 'ABSPATH' => getenv( 'WP_ROOT_FOLDER' ) . '/', +]; + +foreach ( $constants as $key => $value ) { + if ( defined( $key ) ) { + continue; + } + + define( $key, $value ); +} diff --git a/tests/wpunit.suite.dist.yml b/tests/wpunit.suite.dist.yml new file mode 100644 index 0000000..db2e3f5 --- /dev/null +++ b/tests/wpunit.suite.dist.yml @@ -0,0 +1,22 @@ +# Codeception Test Suite Configuration + +# suite for WordPress functional tests. +# Emulate web requests and make application process them. +actor: WpunitTester +bootstrap: _bootstrap.php +modules: + enabled: + - \Helper\Wpunit + - WPLoader + config: + WPLoader: + wpRootFolder: "%WP_ROOT_FOLDER%" + dbName: "%WP_TEST_DB_NAME%" + dbHost: "%WP_TEST_DB_HOST%" + dbUser: "%WP_TEST_DB_USER%" + dbPassword: "%WP_TEST_DB_PASSWORD%" + tablePrefix: "%WP_TABLE_PREFIX%" + domain: "%WP_DOMAIN%" + title: stellarwp/schema-models integration tests + configFile: tests/config.php + theme: kadence diff --git a/tests/wpunit/SchemaModelRelationshipsTest.php b/tests/wpunit/SchemaModelRelationshipsTest.php new file mode 100644 index 0000000..0b5e7fa --- /dev/null +++ b/tests/wpunit/SchemaModelRelationshipsTest.php @@ -0,0 +1,137 @@ +post->create_many( 2 ); + $model_data = [ + 'lastName' => 'Angelo', + 'emails' => [ 'angelo@stellarwp.com', 'michael@stellarwp.com' ], + 'microseconds' => microtime( true ), + 'int' => '1234567890', + 'date' => new DateTime( '2023-06-13 17:25:00' ), + 'posts' => [ $post_id_1, $post_id_2 ], + ]; + + $model = MockModelSchemaWithRelationship::fromData( $model_data, 1 ); + $this->assertTrue( $model->isDirty() ); + $id = $model->save(); + $this->assertFalse( $model->isDirty() ); + + $this->assertIsInt( $id ); + $this->assertGreaterThan( 0, $id ); + + $this->assertEquals( 'Michael', $model->get_firstName() ); + $this->assertEquals( $model_data['lastName'], $model->get_lastName() ); + $this->assertEquals( $model_data['emails'], $model->get_emails() ); + $this->assertEquals( $model_data['microseconds'], $model->get_microseconds() ); + $this->assertEquals( $model_data['int'], $model->get_int() ); + $this->assertEquals( $model_data['date'], $model->get_date() ); + $this->assertEquals( $model_data['posts'], $model->get_posts() ); + } + + public function test_queries_returns_models() { + [ $post_id_1, $post_id_2, $post_id_3, $post_id_4 ] = self::factory()->post->create_many( 4 ); + $model_data = [ + [ + 'lastName' => 'Angelo', + 'emails' => [ 'michael@stellarwp.com', 'angelo@stellarwp.com' ], + 'microseconds' => microtime( true ), + 'int' => '1234567890', + 'date' => new DateTime( '2023-06-13 17:25:00' ), + 'posts' => [ $post_id_1, $post_id_2 ], + ], + [ + 'lastName' => 'Doe', + 'emails' => [ 'john@doe.com' ], + 'microseconds' => 30.0 + microtime( true ), + 'int' => '0987654321', + 'date' => new DateTime( '2021-03-10 19:37:23' ), + ], + [ + 'firstName' => 'Dimi', + 'lastName' => 'Dimitrov', + 'emails' => 'dimi@stellarwp.com', + 'microseconds' => 10.0 + microtime( true ), + 'int' => '019287465', + 'date' => new DateTime( '2024-11-23 18:49:54' ), + 'posts' => [ $post_id_4 ], + ], + ]; + + $models = []; + + foreach ( $model_data as $data ) { + $model = MockModelSchemaWithRelationship::fromData( $data, 1 ); + $model->save(); + $models[] = $model; + } + + $table = $models[0]->getTableInterface(); + + $results = iterator_to_array($table::get_all()); + + $this->assertCount( 3, $results ); + $this->assertInstanceOf( MockModelSchemaWithRelationship::class, $results[0] ); + $this->assertInstanceOf( MockModelSchemaWithRelationship::class, $results[1] ); + $this->assertInstanceOf( MockModelSchemaWithRelationship::class, $results[2] ); + $this->assertEquals( $models[0]->get_id(), $results[0]->get_id() ); + $this->assertEquals( $models[1]->get_id(), $results[1]->get_id() ); + $this->assertEquals( $models[2]->get_id(), $results[2]->get_id() ); + $this->assertEquals( $models[0]->get_firstName(), $results[0]->get_firstName() ); + $this->assertEquals( $models[1]->get_firstName(), $results[1]->get_firstName() ); + $this->assertEquals( $models[2]->get_firstName(), $results[2]->get_firstName() ); + $this->assertEquals( $models[0]->get_lastName(), $results[0]->get_lastName() ); + $this->assertEquals( $models[1]->get_lastName(), $results[1]->get_lastName() ); + $this->assertEquals( $models[2]->get_lastName(), $results[2]->get_lastName() ); + $this->assertEquals( $models[0]->get_emails(), $results[0]->get_emails() ); + $this->assertEquals( $models[1]->get_emails(), $results[1]->get_emails() ); + $this->assertEquals( $models[2]->get_emails(), $results[2]->get_emails() ); + $this->assertEquals( $models[0]->get_microseconds(), $results[0]->get_microseconds() ); + $this->assertEquals( $models[1]->get_microseconds(), $results[1]->get_microseconds() ); + $this->assertEquals( $models[2]->get_microseconds(), $results[2]->get_microseconds() ); + $this->assertEquals( $models[0]->get_int(), $results[0]->get_int() ); + $this->assertEquals( $models[1]->get_int(), $results[1]->get_int() ); + $this->assertEquals( $models[2]->get_int(), $results[2]->get_int() ); + $this->assertEquals( $models[0]->get_date(), $results[0]->get_date() ); + $this->assertEquals( $models[1]->get_date(), $results[1]->get_date() ); + $this->assertEquals( $models[2]->get_date(), $results[2]->get_date() ); + $this->assertEquals( $models[0]->get_posts(), $results[0]->get_posts() ); + $this->assertEquals( $models[1]->get_posts(), $results[1]->get_posts() ); + $this->assertEquals( $models[2]->get_posts(), $results[2]->get_posts() ); + } + + public function test_delete() { + [ $post_id_1, $post_id_2 ] = self::factory()->post->create_many( 2 ); + $model_data = [ + 'lastName' => 'Angelo', + 'emails' => [ 'michael@stellarwp.com', 'angelo@stellarwp.com' ], + 'microseconds' => microtime( true ), + 'int' => '1234567890', + 'date' => new DateTime( '2023-06-13 17:25:00' ), + 'posts' => [ $post_id_1, $post_id_2 ], + ]; + + $model = MockModelSchemaWithRelationship::fromData( $model_data, 1 ); + $model->save(); + + $results = DB::get_col( DB::prepare( "SELECT %i FROM %i WHERE %i = %d", 'post_id', MockRelationshipTable::table_name(), 'mock_model_id', $model->get_id() ) ); + + $this->assertEquals( $model_data['posts'], $results ); + + $this->assertInstanceOf( MockModelSchemaWithRelationship::class, $model->getTableInterface()::get_by_id( $model->get_id() ) ); + $this->assertGreaterThan( 0, $model->get_id() ); + $this->assertTrue( $model->delete() ); + $this->assertNull( $model->getTableInterface()::get_by_id( $model->get_id() ) ); + + $results = DB::get_col( DB::prepare( "SELECT %i FROM %i WHERE %i = %d", 'post_id', MockRelationshipTable::table_name(), 'mock_model_id', $model->get_id() ) ); + $this->assertEmpty( $results ); + } +} diff --git a/tests/wpunit/SchemaModelTest.php b/tests/wpunit/SchemaModelTest.php new file mode 100644 index 0000000..0a780a2 --- /dev/null +++ b/tests/wpunit/SchemaModelTest.php @@ -0,0 +1,101 @@ + 'Angelo', + 'emails' => [ 'angelo@stellarwp.com', 'michael@stellarwp.com' ], + 'microseconds' => microtime( true ), + 'int' => '1234567890', + 'date' => new DateTime( '2023-06-13 17:25:00' ), + ]; + + $model = MockModelSchema::fromData( $model_data, 1 ); + $this->assertTrue( $model->isDirty() ); + $id = $model->save(); + $this->assertFalse( $model->isDirty() ); + + $this->assertIsInt( $id ); + $this->assertGreaterThan( 0, $id ); + + $this->assertEquals( 'Michael', $model->get_firstName() ); + $this->assertEquals( $model_data['lastName'], $model->get_lastName() ); + $this->assertEquals( $model_data['emails'], $model->get_emails() ); + $this->assertEquals( $model_data['microseconds'], $model->get_microseconds() ); + $this->assertEquals( $model_data['int'], $model->get_int() ); + $this->assertEquals( $model_data['date'], $model->get_date() ); + } + + public function test_queries_returns_models() { + $model_data = [ + [ + 'lastName' => 'Angelo', + 'emails' => [ 'michael@stellarwp.com', 'angelo@stellarwp.com' ], + 'microseconds' => microtime( true ), + 'int' => '1234567890', + 'date' => new DateTime( '2023-06-13 17:25:00' ), + ], + [ + 'firstName' => 'Dimi', + 'lastName' => 'Dimitrov', + 'emails' => 'dimi@stellarwp.com', + 'microseconds' => 10.0 + microtime( true ), + 'int' => '1234567890', + 'date' => new DateTime( '2024-06-13 17:25:00' ), + ], + ]; + + $models = []; + + foreach ( $model_data as $data ) { + $model = MockModelSchema::fromData( $data, 1 ); + $model->save(); + $models[] = $model; + } + + $table = $models[0]->getTableInterface(); + + $results = iterator_to_array($table::get_all()); + + $this->assertCount( 2, $results ); + $this->assertInstanceOf( MockModelSchema::class, $results[0] ); + $this->assertInstanceOf( MockModelSchema::class, $results[1] ); + $this->assertEquals( $models[0]->get_id(), $results[0]->get_id() ); + $this->assertEquals( $models[1]->get_id(), $results[1]->get_id() ); + $this->assertEquals( $models[0]->get_firstName(), $results[0]->get_firstName() ); + $this->assertEquals( $models[1]->get_firstName(), $results[1]->get_firstName() ); + $this->assertEquals( $models[0]->get_lastName(), $results[0]->get_lastName() ); + $this->assertEquals( $models[1]->get_lastName(), $results[1]->get_lastName() ); + $this->assertEquals( $models[0]->get_emails(), $results[0]->get_emails() ); + $this->assertEquals( $models[1]->get_emails(), $results[1]->get_emails() ); + $this->assertEquals( $models[0]->get_microseconds(), $results[0]->get_microseconds() ); + $this->assertEquals( $models[1]->get_microseconds(), $results[1]->get_microseconds() ); + $this->assertEquals( $models[0]->get_int(), $results[0]->get_int() ); + $this->assertEquals( $models[1]->get_int(), $results[1]->get_int() ); + $this->assertEquals( $models[0]->get_date(), $results[0]->get_date() ); + $this->assertEquals( $models[1]->get_date(), $results[1]->get_date() ); + } + + public function test_delete() { + $model_data = [ + 'lastName' => 'Angelo', + 'emails' => [ 'michael@stellarwp.com', 'angelo@stellarwp.com' ], + 'microseconds' => microtime( true ), + 'int' => '1234567890', + 'date' => new DateTime( '2023-06-13 17:25:00' ), + ]; + + $model = MockModelSchema::fromData( $model_data, 1 ); + $model->save(); + $this->assertInstanceOf( MockModelSchema::class, $model->getTableInterface()::get_by_id( $model->get_id() ) ); + $this->assertGreaterThan( 0, $model->get_id() ); + $this->assertTrue( $model->delete() ); + $this->assertNull( $model->getTableInterface()::get_by_id( $model->get_id() ) ); + } +} diff --git a/tests/wpunit/_bootstrap.php b/tests/wpunit/_bootstrap.php new file mode 100644 index 0000000..11a2c99 --- /dev/null +++ b/tests/wpunit/_bootstrap.php @@ -0,0 +1,40 @@ + Date: Wed, 24 Sep 2025 17:45:49 +0000 Subject: [PATCH 04/50] chore: autopublish 2025-09-24T17:45:49Z --- src/SchemaModel.php | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 91093ba..0561f1b 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -255,10 +255,10 @@ private function getPropertyDefinitionsFromSchema(): array { * @since 2.0.0 * * @param string $key Relationship name. - * @param mixed $value Relationship value. + * @param mixed $value Relationship value. */ protected function setRelationship( string $key, $value ): void { - $old_value = $this->relationshipData[ $key ]['current'] ?? null; + $old_value = $this->relationshipData[ $key ]['current'] ?? null; $this->relationshipData[ $key ]['current'] = $value; if ( $old_value ) { @@ -494,10 +494,10 @@ protected function defineRelationshipColumns( string $key, string $this_entity_c * Constructs a model instance from database query data. * * @param object|array $queryData - * @param int $mode The level of strictness to take when constructing the object, by default it will ignore extra keys but error on missing keys. + * @param int $mode The level of strictness to take when constructing the object, by default it will ignore extra keys but error on missing keys. * @return static */ - public static function fromData($data, $mode = self::BUILD_MODE_IGNORE_EXTRA) { + public static function fromData( $data, $mode = self::BUILD_MODE_IGNORE_EXTRA ) { if ( ! is_object( $data ) && ! is_array( $data ) ) { throw new InvalidArgumentException( 'Query data must be an object or array' ); } @@ -506,7 +506,7 @@ public static function fromData($data, $mode = self::BUILD_MODE_IGNORE_EXTRA) { $model = new static(); - foreach (static::propertyKeys() as $key) { + foreach ( static::propertyKeys() as $key ) { $property_definition = static::getPropertyDefinition( $key ); if ( $key !== $model->getPrimaryColumn() && ! array_key_exists( $key, $data ) && ! $property_definition->hasDefault() ) { throw new InvalidArgumentException( "Property '$key' does not exist." ); From 178e7a1cc9bfab1aad4748cc7325defb2e6d7662 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 24 Sep 2025 20:46:25 +0300 Subject: [PATCH 05/50] remove WC from phpstan config --- phpstan.neon.dist | 2 -- 1 file changed, 2 deletions(-) diff --git a/phpstan.neon.dist b/phpstan.neon.dist index 8dddba4..1b3c906 100644 --- a/phpstan.neon.dist +++ b/phpstan.neon.dist @@ -16,8 +16,6 @@ parameters: inferPrivatePropertyTypeFromConstructor: true reportUnmatchedIgnoredErrors: false treatPhpDocTypesAsCertain: false - scanDirectories: - - vendor/woocommerce/action-scheduler/ # Paths to be analyzed. paths: From 4601d9fcbe9c5c8f48b55e2727c52155e3dadd20 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 24 Sep 2025 20:52:39 +0300 Subject: [PATCH 06/50] Fixing phpcs issues --- phpcs.xml | 2 ++ src/SchemaModel.php | 29 ++++++++++++++++++++++++----- 2 files changed, 26 insertions(+), 5 deletions(-) diff --git a/phpcs.xml b/phpcs.xml index c8bf9b9..278ea66 100644 --- a/phpcs.xml +++ b/phpcs.xml @@ -11,6 +11,8 @@ + + diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 0561f1b..7a3a884 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -49,6 +49,13 @@ public function __construct( array $attributes = [] ) { $this->propertyCollection = ModelPropertyCollection::fromPropertyDefinitions( $this->getPropertyDefinitionsFromSchema(), $attributes ); } + /** + * Gets the table interface of the model. + * + * @since 0.0.1 + * + * @return Table_Interface + */ abstract public function getTableInterface(): Table_Interface; /** @@ -256,6 +263,8 @@ private function getPropertyDefinitionsFromSchema(): array { * * @param string $key Relationship name. * @param mixed $value Relationship value. + * + * @throws InvalidArgumentException If the relationship is not an integer. */ protected function setRelationship( string $key, $value ): void { $old_value = $this->relationshipData[ $key ]['current'] ?? null; @@ -296,6 +305,8 @@ protected function setRelationship( string $key, $value ): void { * @param string $key Relationship name. * * @return Model|Model[] + * + * @throws InvalidArgumentException If the relationship does not exist. */ protected function getRelationship( string $key ) { $relationships = $this->getRelationships(); @@ -315,20 +326,23 @@ protected function getRelationship( string $key ) { case Relationship::BELONGS_TO: case Relationship::HAS_ONE: if ( 'post' === $relationship['entity'] ) { - return $this->relationshipData[ $key ]['current'] = get_post( $this->getAttribute( $key ) ); + $this->relationshipData[ $key ]['current'] = get_post( $this->getAttribute( $key ) ); + return $this->relationshipData[ $key ]['current']; } throw new InvalidArgumentException( "Relationship {$key} is not a post relationship." ); case Relationship::HAS_MANY: case Relationship::BELONGS_TO_MANY: case Relationship::MANY_TO_MANY: - return $this->relationshipData[ $key ]['current'] = wp_list_pluck( + $this->relationshipData[ $key ]['current'] = wp_list_pluck( $relationship['through']::get_all_by( $relationship['columns']['this'], $this->getPrimaryValue() ), $relationship['columns']['other'] ); + + return $this->relationshipData[ $key ]['current']; } return null; @@ -395,7 +409,7 @@ public function save(): int { $result = $table_interface::upsert( $this->toArray() ); if ( ! $result ) { - throw new RuntimeException( __( 'Failed to save the model.', 'tribe-common' ) ); + throw new RuntimeException( __( 'Failed to save the model.', 'stellarwp-schema-models' ) ); } $id = $this->getPrimaryValue(); @@ -425,7 +439,7 @@ public function delete(): bool { $uid = $this->getPrimaryValue(); if ( ! $uid ) { - throw new RuntimeException( __( 'Model ID is required to delete the model.', 'tribe-common' ) ); + throw new RuntimeException( __( 'Model ID is required to delete the model.', 'stellarwp-schema-models' ) ); } $this->deleteAllRelationshipData(); @@ -493,9 +507,14 @@ protected function defineRelationshipColumns( string $key, string $this_entity_c /** * Constructs a model instance from database query data. * - * @param object|array $queryData + * @param object|array $data The data to construct the model from. * @param int $mode The level of strictness to take when constructing the object, by default it will ignore extra keys but error on missing keys. + * * @return static + * + * @throws InvalidArgumentException If the data is not an object or array. + * @throws InvalidArgumentException If the property does not exist. + * @throws InvalidArgumentException If the relationship does not exist. */ public static function fromData( $data, $mode = self::BUILD_MODE_IGNORE_EXTRA ) { if ( ! is_object( $data ) && ! is_array( $data ) ) { From 45e077868c0ef10ccff28acd308b4458e6c8f16b Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 24 Sep 2025 21:13:58 +0300 Subject: [PATCH 07/50] Fixing phpstan issues --- src/SchemaModel.php | 59 +++++++++++++++++++++++++++++++++++++-------- 1 file changed, 49 insertions(+), 10 deletions(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 7a3a884..f1fcaee 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -20,6 +20,7 @@ use StellarWP\Models\Model; use StellarWP\Models\ModelPropertyCollection; use StellarWP\Models\ModelPropertyDefinition; +use WP_Post; /** * The schema model. @@ -38,6 +39,20 @@ abstract class SchemaModel extends Model implements SchemaModelInterface { */ private array $relationshipData = []; + /** + * The model relationships assigned to their relationship types. + * + * @var array> + */ + protected static array $relationships = []; // @phpstan-ignore-line + + /** + * The model properties assigned to their types. + * + * @var array + */ + protected static array $properties = []; // @phpstan-ignore-line + /** * Constructor. * @@ -45,10 +60,18 @@ abstract class SchemaModel extends Model implements SchemaModelInterface { * * @param array $attributes Attributes. */ - public function __construct( array $attributes = [] ) { + final public function __construct( array $attributes = [] ) { $this->propertyCollection = ModelPropertyCollection::fromPropertyDefinitions( $this->getPropertyDefinitionsFromSchema(), $attributes ); + $this->constructRelationships(); } + /** + * Constructs the relationships of the model. + * + * @return void + */ + protected function constructRelationships(): void {} + /** * Gets the table interface of the model. * @@ -58,6 +81,17 @@ public function __construct( array $attributes = [] ) { */ abstract public function getTableInterface(): Table_Interface; + /** + * Gets the table class of the model. + * + * @since 0.0.1 + * + * @return string + */ + protected function getTableClass(): string { + return get_class( $this->getTableInterface() ); + } + /** * Gets the primary value of the model. * @@ -77,7 +111,7 @@ public function getPrimaryValue() { * @return string */ public function getPrimaryColumn(): string { - return $this->getTableInterface()::uid_column(); + return $this->getTableClass()::uid_column(); } /** @@ -244,8 +278,8 @@ private function getPropertyDefinitionsFromSchema(): array { $definition->default( $column->get_default() ); } - if ( is_callable( [ $this->getTableInterface(), 'cast_value_based_on_type' ] ) ) { - $definition->castWith( fn( $value ) => $this->getTableInterface()::cast_value_based_on_type( $column->get_php_type(), $value ) ); + if ( is_callable( [ $this->getTableClass(), 'cast_value_based_on_type' ] ) ) { + $definition->castWith( fn( $value ) => $this->getTableClass()::cast_value_based_on_type( $column->get_php_type(), $value ) ); } $property_definitions[ $column->get_name() ] = $definition; @@ -304,7 +338,7 @@ protected function setRelationship( string $key, $value ): void { * * @param string $key Relationship name. * - * @return Model|Model[] + * @return null|WP_Post|Model|Model[] * * @throws InvalidArgumentException If the relationship does not exist. */ @@ -383,8 +417,8 @@ private function saveRelationshipData(): void { if ( ! empty( $this->relationshipData[ $key ]['delete'] ) ) { $relationship['through']::delete_many( $this->relationshipData[ $key ]['delete'], - $this->get_relationships()[ $key ]['columns']['other'], - DB::prepare( ' AND %i = %d', $this->get_relationships()[ $key ]['columns']['this'], $this->getPrimaryValue() ) + $this->getRelationships()[ $key ]['columns']['other'], + DB::prepare( ' AND %i = %d', $this->getRelationships()[ $key ]['columns']['this'], $this->getPrimaryValue() ) ); } } @@ -405,8 +439,7 @@ public function save(): int { return $this->getPrimaryValue(); } - $table_interface = $this->getTableInterface(); - $result = $table_interface::upsert( $this->toArray() ); + $result = $this->getTableClass()::upsert( $this->toArray() ); if ( ! $result ) { throw new RuntimeException( __( 'Failed to save the model.', 'stellarwp-schema-models' ) ); @@ -444,7 +477,7 @@ public function delete(): bool { $this->deleteAllRelationshipData(); - return $this->getTableInterface()::delete( $uid ); + return $this->getTableClass()::delete( $uid ); } /** @@ -512,6 +545,7 @@ protected function defineRelationshipColumns( string $key, string $this_entity_c * * @return static * + * @throws InvalidArgumentException If the abstract is used directly. * @throws InvalidArgumentException If the data is not an object or array. * @throws InvalidArgumentException If the property does not exist. * @throws InvalidArgumentException If the relationship does not exist. @@ -523,6 +557,11 @@ public static function fromData( $data, $mode = self::BUILD_MODE_IGNORE_EXTRA ) $data = (array) $data; + if ( self::class === static::class ) { + throw new InvalidArgumentException( 'SchemaModel cannot be instantiated directly.' ); + } + + // @phpstan-ignore-next-line $model = new static(); foreach ( static::propertyKeys() as $key ) { From 80848e264c25f7c1c6efcde86766627f2f627515 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 24 Sep 2025 21:25:59 +0300 Subject: [PATCH 08/50] Fix constructor overwrite --- .../Helper/Schema/MockModelSchemaWithRelationship.php | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php b/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php index 4cc3d13..b56a191 100644 --- a/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php +++ b/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php @@ -7,12 +7,11 @@ use StellarWP\Models\ValueObjects\Relationship; class MockModelSchemaWithRelationship extends SchemaModel { - public function __construct( array $attributes = [] ) { - parent::__construct( $attributes ); - + protected function constructRelationships(): void { $this->defineRelationship( 'posts', Relationship::MANY_TO_MANY, MockRelationshipTable::class ); $this->defineRelationshipColumns( 'posts', 'mock_model_id', 'post_id' ); } + public function getTableInterface(): Table_Interface { return new MockRelationshipModelTable(); } From 8d4d71a87a30b1ab427bba5002c3cdb99e53b998 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 24 Sep 2025 21:29:59 +0300 Subject: [PATCH 09/50] Fix lowercase Datetime --- tests/_support/Helper/Schema/MockModelTable.php | 4 ++-- tests/_support/Helper/Schema/MockRelationshipModelTable.php | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/tests/_support/Helper/Schema/MockModelTable.php b/tests/_support/Helper/Schema/MockModelTable.php index 3f9701d..0969602 100644 --- a/tests/_support/Helper/Schema/MockModelTable.php +++ b/tests/_support/Helper/Schema/MockModelTable.php @@ -10,7 +10,7 @@ use StellarWP\Schema\Columns\Text_Column; use StellarWP\Schema\Columns\Float_Column; use StellarWP\Schema\Columns\Integer_Column; -use StellarWP\Schema\Columns\DateTime_Column; +use StellarWP\Schema\Columns\Datetime_Column; use StellarWP\Schema\Columns\PHP_Types; class MockModelTable extends Table { @@ -31,7 +31,7 @@ public static function get_schema_history(): array { $columns[] = ( new Text_Column( 'emails' ) )->set_php_type( PHP_Types::JSON ); $columns[] = ( new Float_Column( 'microseconds' ) )->set_length( 17 )->set_precision( 6 ); $columns[] = ( new Integer_Column( 'int' ) ); - $columns[] = ( new DateTime_Column( 'date' ) ); + $columns[] = ( new Datetime_Column( 'date' ) ); $table_name = static::table_name( true ); diff --git a/tests/_support/Helper/Schema/MockRelationshipModelTable.php b/tests/_support/Helper/Schema/MockRelationshipModelTable.php index 25b8422..b01ae56 100644 --- a/tests/_support/Helper/Schema/MockRelationshipModelTable.php +++ b/tests/_support/Helper/Schema/MockRelationshipModelTable.php @@ -10,7 +10,7 @@ use StellarWP\Schema\Columns\Text_Column; use StellarWP\Schema\Columns\Float_Column; use StellarWP\Schema\Columns\Integer_Column; -use StellarWP\Schema\Columns\DateTime_Column; +use StellarWP\Schema\Columns\Datetime_Column; use StellarWP\Schema\Columns\PHP_Types; class MockRelationshipModelTable extends Table { @@ -31,7 +31,7 @@ public static function get_schema_history(): array { $columns[] = ( new Text_Column( 'emails' ) )->set_php_type( PHP_Types::JSON ); $columns[] = ( new Float_Column( 'microseconds' ) )->set_length( 17 )->set_precision( 6 ); $columns[] = ( new Integer_Column( 'int' ) ); - $columns[] = ( new DateTime_Column( 'date' ) ); + $columns[] = ( new Datetime_Column( 'date' ) ); $table_name = static::table_name( true ); From 7303951f9deff27797fb7460de5c6bea8e65dd4a Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Mon, 29 Sep 2025 18:44:17 +0300 Subject: [PATCH 10/50] Updated translation of defaults --- src/SchemaModel.php | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index f1fcaee..0ac2b53 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -21,6 +21,8 @@ use StellarWP\Models\ModelPropertyCollection; use StellarWP\Models\ModelPropertyDefinition; use WP_Post; +use StellarWP\Schema\Columns\Contracts\Column; +use DateTime; /** * The schema model. @@ -260,6 +262,8 @@ public function removeFromRelationship( string $key, int $id ): void { * @since 0.0.1 * * @return array + * + * @throws RuntimeException On unknown reserved keyword. */ private function getPropertyDefinitionsFromSchema(): array { $table_interface = $this->getTableInterface(); @@ -275,7 +279,23 @@ private function getPropertyDefinitionsFromSchema(): array { } if ( $column->get_default() ) { - $definition->default( $column->get_default() ); + $default = $column->get_default(); + if ( in_array( $default, Column::SQL_RESERVED_DEFAULTS, true ) ) { + switch ( $default ) { + case 'CURRENT_TIMESTAMP': + case 'CURRENT_DATE': + case 'CURRENT_TIME': + $default = new DateTime(); + break; + case 'NULL': + $default = null; + break; + default: + throw new RuntimeException( 'Unknown default RESERVED Keyword: ' . $default ); + } + } + + $definition->default( $default ); } if ( is_callable( [ $this->getTableClass(), 'cast_value_based_on_type' ] ) ) { From 827dc23efbeb4469219ca1eaf181bde009a21c94 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Tue, 30 Sep 2025 16:47:12 +0300 Subject: [PATCH 11/50] Update schema/models to their latest versions --- composer.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/composer.json b/composer.json index 1b82b32..cd0e9e3 100644 --- a/composer.json +++ b/composer.json @@ -34,8 +34,8 @@ "minimum-stability": "stable", "require": { "php": ">=7.4", - "stellarwp/models": "dev-feat/introduce-schema-model", - "stellarwp/schema": "^3.0" + "stellarwp/models": "dev-add-phpstan", + "stellarwp/schema": "^3.1" }, "require-dev": { "stellarwp/coding-standards": "^2.1", From 6277caef735ad38b70387822d06228e1b789977c Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Tue, 30 Sep 2025 16:59:26 +0300 Subject: [PATCH 12/50] add empty new lines --- .github/CODEOWNERS | 2 +- tests/_output/.gitignore | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index b778c9e..cc3f5a2 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1 @@ -* @dpanta94 \ No newline at end of file +* @dpanta94 diff --git a/tests/_output/.gitignore b/tests/_output/.gitignore index c96a04f..d6b7ef3 100644 --- a/tests/_output/.gitignore +++ b/tests/_output/.gitignore @@ -1,2 +1,2 @@ * -!.gitignore \ No newline at end of file +!.gitignore From cde3e1d1c0a6ce3e0d8aabdfa388c2db5b89837a Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 1 Oct 2025 19:24:14 +0300 Subject: [PATCH 13/50] Upgraded models/schema --- composer.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/composer.json b/composer.json index cd0e9e3..4d1b5c6 100644 --- a/composer.json +++ b/composer.json @@ -34,8 +34,8 @@ "minimum-stability": "stable", "require": { "php": ">=7.4", - "stellarwp/models": "dev-add-phpstan", - "stellarwp/schema": "^3.1" + "stellarwp/models": "dev-release/2.0.0", + "stellarwp/schema": "dev-feat/adding-the-order-by-param-in-get-all-by" }, "require-dev": { "stellarwp/coding-standards": "^2.1", From 1fdccc93cb48732aee9d684c5b250b9c75d17e7f Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 1 Oct 2025 19:28:33 +0300 Subject: [PATCH 14/50] remove contructor overwrite --- src/SchemaModel.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 0ac2b53..e473ac4 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -56,14 +56,14 @@ abstract class SchemaModel extends Model implements SchemaModelInterface { protected static array $properties = []; // @phpstan-ignore-line /** - * Constructor. + * Acts as the constructor. * * @since 0.0.1 * * @param array $attributes Attributes. */ - final public function __construct( array $attributes = [] ) { - $this->propertyCollection = ModelPropertyCollection::fromPropertyDefinitions( $this->getPropertyDefinitionsFromSchema(), $attributes ); + protected function afterConstruct() { + $this->propertyCollection = ModelPropertyCollection::fromPropertyDefinitions( $this->getPropertyDefinitionsFromSchema() ); $this->constructRelationships(); } From 1ae70e4b4be3d50c26f9575e96ad2eefb5667ffa Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 1 Oct 2025 19:40:04 +0300 Subject: [PATCH 15/50] Fix phpcs and phpstan --- src/SchemaModel.php | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index e473ac4..a2ed6ee 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -59,10 +59,8 @@ abstract class SchemaModel extends Model implements SchemaModelInterface { * Acts as the constructor. * * @since 0.0.1 - * - * @param array $attributes Attributes. */ - protected function afterConstruct() { + protected function afterConstruct(): void { $this->propertyCollection = ModelPropertyCollection::fromPropertyDefinitions( $this->getPropertyDefinitionsFromSchema() ); $this->constructRelationships(); } From 3e1611766fa8203cf62c12d10bee96b9e3d370ca Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 1 Oct 2025 20:48:50 +0300 Subject: [PATCH 16/50] Clean cache of definitions --- composer.json | 2 +- src/SchemaModel.php | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/composer.json b/composer.json index 4d1b5c6..4a49aa9 100644 --- a/composer.json +++ b/composer.json @@ -34,7 +34,7 @@ "minimum-stability": "stable", "require": { "php": ">=7.4", - "stellarwp/models": "dev-release/2.0.0", + "stellarwp/models": "dev-feature/definition-cache-control", "stellarwp/schema": "dev-feat/adding-the-order-by-param-in-get-all-by" }, "require-dev": { diff --git a/src/SchemaModel.php b/src/SchemaModel.php index a2ed6ee..7e1252e 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -61,6 +61,7 @@ abstract class SchemaModel extends Model implements SchemaModelInterface { * @since 0.0.1 */ protected function afterConstruct(): void { + self::purgePropertyDefinitionCache(); $this->propertyCollection = ModelPropertyCollection::fromPropertyDefinitions( $this->getPropertyDefinitionsFromSchema() ); $this->constructRelationships(); } @@ -579,7 +580,6 @@ public static function fromData( $data, $mode = self::BUILD_MODE_IGNORE_EXTRA ) throw new InvalidArgumentException( 'SchemaModel cannot be instantiated directly.' ); } - // @phpstan-ignore-next-line $model = new static(); foreach ( static::propertyKeys() as $key ) { @@ -596,7 +596,7 @@ public static function fromData( $data, $mode = self::BUILD_MODE_IGNORE_EXTRA ) $model->setAttribute( $key, static::castValueForProperty( static::getPropertyDefinition( $key ), $data[ $key ], $key ) ); } - foreach ( $model->getRelationships() as $key => $relationship ) { + foreach ( array_keys( $model->getRelationships() ) as $key ) { if ( ! isset( $data[ $key ] ) ) { continue; } From 225d54be731cd8b34d0bac0296c996197859483b Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 1 Oct 2025 22:48:11 +0300 Subject: [PATCH 17/50] Updating models and making sure tests are passing --- src/Contracts/SchemaModel.php | 2 +- src/SchemaModel.php | 40 +++++++++++++------ .../Helper/Schema/MockModelSchema.php | 2 +- .../MockModelSchemaWithRelationship.php | 2 +- tests/wpunit/SchemaModelRelationshipsTest.php | 6 +-- tests/wpunit/SchemaModelTest.php | 6 +-- 6 files changed, 36 insertions(+), 22 deletions(-) diff --git a/src/Contracts/SchemaModel.php b/src/Contracts/SchemaModel.php index 63c95c9..9ba8b69 100644 --- a/src/Contracts/SchemaModel.php +++ b/src/Contracts/SchemaModel.php @@ -40,7 +40,7 @@ public function getPrimaryColumn(): string; * * @return Table_Interface */ - public function getTableInterface(): Table_Interface; + public static function getTableInterface(): Table_Interface; /** * Magic method to get the relationships of the model. diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 7e1252e..76c2daa 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -23,6 +23,7 @@ use WP_Post; use StellarWP\Schema\Columns\Contracts\Column; use DateTime; +use DateTimeInterface; /** * The schema model. @@ -61,8 +62,6 @@ abstract class SchemaModel extends Model implements SchemaModelInterface { * @since 0.0.1 */ protected function afterConstruct(): void { - self::purgePropertyDefinitionCache(); - $this->propertyCollection = ModelPropertyCollection::fromPropertyDefinitions( $this->getPropertyDefinitionsFromSchema() ); $this->constructRelationships(); } @@ -80,7 +79,7 @@ protected function constructRelationships(): void {} * * @return Table_Interface */ - abstract public function getTableInterface(): Table_Interface; + abstract public static function getTableInterface(): Table_Interface; /** * Gets the table class of the model. @@ -89,8 +88,8 @@ abstract public function getTableInterface(): Table_Interface; * * @return string */ - protected function getTableClass(): string { - return get_class( $this->getTableInterface() ); + protected static function getTableClass(): string { + return get_class( static::getTableInterface() ); } /** @@ -256,23 +255,38 @@ public function removeFromRelationship( string $key, int $id ): void { } /** - * Get the property definitions from the schema. + * Generates the property definitions for the model. + * + * This method processes the raw property definitions from static::$properties and static::properties(), + * converting shorthand notation to ModelPropertyDefinition instances and locking them. + * + * Child classes can override this method to customize how property definitions are generated, + * either by completely replacing the logic or by calling parent::generatePropertyDefinitions() + * and modifying the results. * * @since 0.0.1 * * @return array - * - * @throws RuntimeException On unknown reserved keyword. */ - private function getPropertyDefinitionsFromSchema(): array { - $table_interface = $this->getTableInterface(); + protected static function generatePropertyDefinitions(): array { + $table_interface = static::getTableInterface(); /** @var Table_Schema_Interface $table_schema */ $table_schema = $table_interface::get_current_schema(); + /** @var array $processedDefinitions */ $property_definitions = []; foreach ( $table_schema->get_columns() as $column ) { - $definition = ( new ModelPropertyDefinition() )->type( $column->get_php_type() ); + $definition_type = [ $column->get_php_type() ]; + if ( 'json' === $column->get_php_type() ) { + $definition_type[] = 'array'; + } + + if ( DateTimeInterface::class === $column->get_php_type() ) { + $definition_type[] = 'object'; + } + + $definition = ( new ModelPropertyDefinition() )->type( ...$definition_type ); if ( $column->get_nullable() ) { $definition->nullable(); } @@ -297,8 +311,8 @@ private function getPropertyDefinitionsFromSchema(): array { $definition->default( $default ); } - if ( is_callable( [ $this->getTableClass(), 'cast_value_based_on_type' ] ) ) { - $definition->castWith( fn( $value ) => $this->getTableClass()::cast_value_based_on_type( $column->get_php_type(), $value ) ); + if ( is_callable( [ static::getTableClass(), 'cast_value_based_on_type' ] ) ) { + $definition->castWith( fn( $value ) => static::getTableClass()::cast_value_based_on_type( $column->get_php_type(), $value ) ); } $property_definitions[ $column->get_name() ] = $definition; diff --git a/tests/_support/Helper/Schema/MockModelSchema.php b/tests/_support/Helper/Schema/MockModelSchema.php index e3ff933..d265343 100644 --- a/tests/_support/Helper/Schema/MockModelSchema.php +++ b/tests/_support/Helper/Schema/MockModelSchema.php @@ -6,7 +6,7 @@ use StellarWP\Schema\Tables\Contracts\Table_Interface; class MockModelSchema extends SchemaModel { - public function getTableInterface(): Table_Interface { + public static function getTableInterface(): Table_Interface { return new MockModelTable(); } } diff --git a/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php b/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php index b56a191..e3f2b32 100644 --- a/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php +++ b/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php @@ -12,7 +12,7 @@ protected function constructRelationships(): void { $this->defineRelationshipColumns( 'posts', 'mock_model_id', 'post_id' ); } - public function getTableInterface(): Table_Interface { + public static function getTableInterface(): Table_Interface { return new MockRelationshipModelTable(); } } diff --git a/tests/wpunit/SchemaModelRelationshipsTest.php b/tests/wpunit/SchemaModelRelationshipsTest.php index 0b5e7fa..d98f8ab 100644 --- a/tests/wpunit/SchemaModelRelationshipsTest.php +++ b/tests/wpunit/SchemaModelRelationshipsTest.php @@ -74,7 +74,7 @@ public function test_queries_returns_models() { $models[] = $model; } - $table = $models[0]->getTableInterface(); + $table = $models[0]::getTableInterface(); $results = iterator_to_array($table::get_all()); @@ -126,10 +126,10 @@ public function test_delete() { $this->assertEquals( $model_data['posts'], $results ); - $this->assertInstanceOf( MockModelSchemaWithRelationship::class, $model->getTableInterface()::get_by_id( $model->get_id() ) ); + $this->assertInstanceOf( MockModelSchemaWithRelationship::class, $model::getTableInterface()::get_by_id( $model->get_id() ) ); $this->assertGreaterThan( 0, $model->get_id() ); $this->assertTrue( $model->delete() ); - $this->assertNull( $model->getTableInterface()::get_by_id( $model->get_id() ) ); + $this->assertNull( $model::getTableInterface()::get_by_id( $model->get_id() ) ); $results = DB::get_col( DB::prepare( "SELECT %i FROM %i WHERE %i = %d", 'post_id', MockRelationshipTable::table_name(), 'mock_model_id', $model->get_id() ) ); $this->assertEmpty( $results ); diff --git a/tests/wpunit/SchemaModelTest.php b/tests/wpunit/SchemaModelTest.php index 0a780a2..6ce74f2 100644 --- a/tests/wpunit/SchemaModelTest.php +++ b/tests/wpunit/SchemaModelTest.php @@ -59,7 +59,7 @@ public function test_queries_returns_models() { $models[] = $model; } - $table = $models[0]->getTableInterface(); + $table = $models[0]::getTableInterface(); $results = iterator_to_array($table::get_all()); @@ -93,9 +93,9 @@ public function test_delete() { $model = MockModelSchema::fromData( $model_data, 1 ); $model->save(); - $this->assertInstanceOf( MockModelSchema::class, $model->getTableInterface()::get_by_id( $model->get_id() ) ); + $this->assertInstanceOf( MockModelSchema::class, $model::getTableInterface()::get_by_id( $model->get_id() ) ); $this->assertGreaterThan( 0, $model->get_id() ); $this->assertTrue( $model->delete() ); - $this->assertNull( $model->getTableInterface()::get_by_id( $model->get_id() ) ); + $this->assertNull( $model::getTableInterface()::get_by_id( $model->get_id() ) ); } } From 67dd968d2f8207b0a748a2d94847ea6e0ea28595 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 1 Oct 2025 19:48:39 +0000 Subject: [PATCH 18/50] chore: autopublish 2025-10-01T19:48:39Z --- src/SchemaModel.php | 1 - 1 file changed, 1 deletion(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 76c2daa..efe7ad4 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -18,7 +18,6 @@ use StellarWP\Schema\Tables\Contracts\Table_Schema_Interface; use RuntimeException; use StellarWP\Models\Model; -use StellarWP\Models\ModelPropertyCollection; use StellarWP\Models\ModelPropertyDefinition; use WP_Post; use StellarWP\Schema\Columns\Contracts\Column; From 157133c27d796baf5355ae5abdf1aa81787798dc Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 1 Oct 2025 22:53:55 +0300 Subject: [PATCH 19/50] Update schema requirements --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index 4a49aa9..c4903b2 100644 --- a/composer.json +++ b/composer.json @@ -35,7 +35,7 @@ "require": { "php": ">=7.4", "stellarwp/models": "dev-feature/definition-cache-control", - "stellarwp/schema": "dev-feat/adding-the-order-by-param-in-get-all-by" + "stellarwp/schema": "^3.1.1" }, "require-dev": { "stellarwp/coding-standards": "^2.1", From 8c78f83efa2f5eaaed00f69c5769cf36c3dabec3 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 1 Oct 2025 22:56:55 +0300 Subject: [PATCH 20/50] Fix static analysis --- src/SchemaModel.php | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index efe7ad4..c22b020 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -272,7 +272,7 @@ protected static function generatePropertyDefinitions(): array { /** @var Table_Schema_Interface $table_schema */ $table_schema = $table_interface::get_current_schema(); - /** @var array $processedDefinitions */ + /** @var array $property_definitions */ $property_definitions = []; foreach ( $table_schema->get_columns() as $column ) { @@ -593,6 +593,7 @@ public static function fromData( $data, $mode = self::BUILD_MODE_IGNORE_EXTRA ) throw new InvalidArgumentException( 'SchemaModel cannot be instantiated directly.' ); } + // @phpstan-ignore-next-line It is safe to instantiate the model like that since the constructor is final. $model = new static(); foreach ( static::propertyKeys() as $key ) { From effab56e91a71cfd5808be7eb08197629d47be50 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 1 Oct 2025 22:57:13 +0300 Subject: [PATCH 21/50] Fix phpcs --- src/SchemaModel.php | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index c22b020..21b819d 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -266,6 +266,8 @@ public function removeFromRelationship( string $key, int $id ): void { * @since 0.0.1 * * @return array + * + * @throws RuntimeException On unknown reserved keyword. */ protected static function generatePropertyDefinitions(): array { $table_interface = static::getTableInterface(); From 70dab24ab2e8b9600f893afd020db972fa4fc79e Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 1 Oct 2025 23:54:45 +0300 Subject: [PATCH 22/50] Fixing a bug on setting the attributes --- src/SchemaModel.php | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 21b819d..f828f0c 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -150,9 +150,8 @@ public function __call( string $name, array $arguments ) { } $args = $arguments['0'] ?? null; - $args = (array) $args; if ( isset( $relationships[ $property ] ) ) { - $args ? $this->setRelationship( $property, $args ) : $this->deleteRelationshipData( $property ); + $args ? $this->setRelationship( $property, (array) $args ) : $this->deleteRelationshipData( $property ); return; } From b26ee9adc727d28ee4aa4cdbea89bcd0b1474c6e Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Thu, 2 Oct 2025 00:11:11 +0300 Subject: [PATCH 23/50] Updating schema version --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index c4903b2..66da0a7 100644 --- a/composer.json +++ b/composer.json @@ -35,7 +35,7 @@ "require": { "php": ">=7.4", "stellarwp/models": "dev-feature/definition-cache-control", - "stellarwp/schema": "^3.1.1" + "stellarwp/schema": "dev-fix/error-on-update-evaluation" }, "require-dev": { "stellarwp/coding-standards": "^2.1", From 429859234c9afbfeab1b4b69975237b5fae2995c Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Thu, 2 Oct 2025 16:05:00 +0300 Subject: [PATCH 24/50] Updated schema version --- composer.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/composer.json b/composer.json index 66da0a7..4caca89 100644 --- a/composer.json +++ b/composer.json @@ -34,8 +34,8 @@ "minimum-stability": "stable", "require": { "php": ">=7.4", - "stellarwp/models": "dev-feature/definition-cache-control", - "stellarwp/schema": "dev-fix/error-on-update-evaluation" + "stellarwp/models": "dev-release/2.0.0", + "stellarwp/schema": "^3.1.2" }, "require-dev": { "stellarwp/coding-standards": "^2.1", From 25a8a1c62eeb028c569baeabc96549f484f4acaa Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Thu, 2 Oct 2025 16:05:06 +0300 Subject: [PATCH 25/50] Remove __call method from contract --- src/Contracts/SchemaModel.php | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/src/Contracts/SchemaModel.php b/src/Contracts/SchemaModel.php index 9ba8b69..02aa41c 100644 --- a/src/Contracts/SchemaModel.php +++ b/src/Contracts/SchemaModel.php @@ -42,18 +42,6 @@ public function getPrimaryColumn(): string; */ public static function getTableInterface(): Table_Interface; - /** - * Magic method to get the relationships of the model. - * - * @since 0.0.1 - * - * @param string $name The name of the method. - * @param array $arguments The arguments of the method. - * - * @return array|void The relationships of the model. - */ - public function __call( string $name, array $arguments ); - /** * Gets the relationships of the model. * From 6039db84678821b51ee28944f78531cba15a83f4 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Thu, 2 Oct 2025 16:05:59 +0300 Subject: [PATCH 26/50] updated initial version to be a minor release --- CHANGELOG.md | 4 ++-- schema-models.php | 2 +- src/Contracts/SchemaModel.php | 20 +++++++++--------- src/SchemaModel.php | 40 +++++++++++++++++------------------ 4 files changed, 33 insertions(+), 33 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b73e831..c914056 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,8 +2,8 @@ All notable changes to this project will be documented in this file. This project adhere to the [Semantic Versioning](http://semver.org/) standard. -## [0.0.1] 2025-09-24 +## [0.1.0] 2025-10-02 * Feature - Initial release of Schema Models. -[0.0.1]: https://github.com/stellarwp/schema-models/releases/tag/0.0.1 +[0.1.0]: https://github.com/stellarwp/schema-models/releases/tag/0.1.0 diff --git a/schema-models.php b/schema-models.php index 453b918..6e84b3e 100644 --- a/schema-models.php +++ b/schema-models.php @@ -9,7 +9,7 @@ * @wordpress-plugin * Plugin Name: Schema Models * Description: A library for models based on Schema definitions. - * Version: 0.0.1 + * Version: 0.1.0 * Author: StellarWP * Author URI: https://stellarwp.com * License: MIT diff --git a/src/Contracts/SchemaModel.php b/src/Contracts/SchemaModel.php index 02aa41c..b3e998c 100644 --- a/src/Contracts/SchemaModel.php +++ b/src/Contracts/SchemaModel.php @@ -2,7 +2,7 @@ /** * The schema model contract. * - * @since 0.0.1 + * @since 0.1.0 * * @package StellarWP\SchemaModels\Contracts; */ @@ -18,7 +18,7 @@ interface SchemaModel extends Model { /** * Gets the primary value of the model. * - * @since 0.0.1 + * @since 0.1.0 * * @return mixed */ @@ -27,7 +27,7 @@ public function getPrimaryValue(); /** * Gets the primary column of the model. * - * @since 0.0.1 + * @since 0.1.0 * * @return string */ @@ -36,7 +36,7 @@ public function getPrimaryColumn(): string; /** * Gets the table interface of the model. * - * @since 0.0.1 + * @since 0.1.0 * * @return Table_Interface */ @@ -45,7 +45,7 @@ public static function getTableInterface(): Table_Interface; /** * Gets the relationships of the model. * - * @since 0.0.1 + * @since 0.1.0 * * @return array The relationships of the model. */ @@ -54,7 +54,7 @@ public function getRelationships(): array; /** * Deletes the relationship data for a given key. * - * @since 0.0.1 + * @since 0.1.0 * * @param string $key The key of the relationship. */ @@ -63,7 +63,7 @@ public function deleteRelationshipData( string $key ): void; /** * Adds an ID to a relationship. * - * @since 0.0.1 + * @since 0.1.0 * * @param string $key The key of the relationship. * @param int $id The ID to add. @@ -73,7 +73,7 @@ public function addToRelationship( string $key, int $id ): void; /** * Removes an ID from a relationship. * - * @since 0.0.1 + * @since 0.1.0 * * @param string $key The key of the relationship. * @param int $id The ID to remove. @@ -83,7 +83,7 @@ public function removeFromRelationship( string $key, int $id ): void; /** * Saves the model. * - * @since 0.0.1 + * @since 0.1.0 * * @return int The ID of the saved model. */ @@ -92,7 +92,7 @@ public function save(): int; /** * Deletes the model. * - * @since 0.0.1 + * @since 0.1.0 * * @return bool Whether the model was deleted. */ diff --git a/src/SchemaModel.php b/src/SchemaModel.php index f828f0c..81839ee 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -2,7 +2,7 @@ /** * The schema model. * - * @since 0.0.1 + * @since 0.1.0 * * @package StellarWP\SchemaModels; */ @@ -27,7 +27,7 @@ /** * The schema model. * - * @since 0.0.1 + * @since 0.1.0 * * @package StellarWP\SchemaModels; */ @@ -35,7 +35,7 @@ abstract class SchemaModel extends Model implements SchemaModelInterface { /** * The relationship data of the model. * - * @since 0.0.1 + * @since 0.1.0 * * @var array */ @@ -58,7 +58,7 @@ abstract class SchemaModel extends Model implements SchemaModelInterface { /** * Acts as the constructor. * - * @since 0.0.1 + * @since 0.1.0 */ protected function afterConstruct(): void { $this->constructRelationships(); @@ -74,7 +74,7 @@ protected function constructRelationships(): void {} /** * Gets the table interface of the model. * - * @since 0.0.1 + * @since 0.1.0 * * @return Table_Interface */ @@ -83,7 +83,7 @@ abstract public static function getTableInterface(): Table_Interface; /** * Gets the table class of the model. * - * @since 0.0.1 + * @since 0.1.0 * * @return string */ @@ -94,7 +94,7 @@ protected static function getTableClass(): string { /** * Gets the primary value of the model. * - * @since 0.0.1 + * @since 0.1.0 * * @return mixed */ @@ -105,7 +105,7 @@ public function getPrimaryValue() { /** * Gets the primary column of the model. * - * @since 0.0.1 + * @since 0.1.0 * * @return string */ @@ -116,7 +116,7 @@ public function getPrimaryColumn(): string { /** * Magic method to get the relationships of the model. * - * @since 0.0.1 + * @since 0.1.0 * * @param string $name The name of the method. * @param array $arguments The arguments of the method. @@ -161,7 +161,7 @@ public function __call( string $name, array $arguments ) { /** * Gets the relationships of the model. * - * @since 0.0.1 + * @since 0.1.0 * * @return array The relationships of the model. */ @@ -172,7 +172,7 @@ public function getRelationships(): array { /** * Deletes the relationship data for a given key. * - * @since 0.0.1 + * @since 0.1.0 * * @param string $key The key of the relationship. * @@ -191,7 +191,7 @@ public function deleteRelationshipData( string $key ): void { /** * Adds an ID to a relationship. * - * @since 0.0.1 + * @since 0.1.0 * * @param string $key The key of the relationship. * @param int $id The ID to add. @@ -223,7 +223,7 @@ public function addToRelationship( string $key, int $id ): void { /** * Removes an ID from a relationship. * - * @since 0.0.1 + * @since 0.1.0 * * @param string $key The key of the relationship. * @param int $id The ID to remove. @@ -262,7 +262,7 @@ public function removeFromRelationship( string $key, int $id ): void { * either by completely replacing the logic or by calling parent::generatePropertyDefinitions() * and modifying the results. * - * @since 0.0.1 + * @since 0.1.0 * * @return array * @@ -367,7 +367,7 @@ protected function setRelationship( string $key, $value ): void { /** * Returns a relationship. * - * @since 0.0.1 + * @since 0.1.0 * * @param string $key Relationship name. * @@ -418,7 +418,7 @@ protected function getRelationship( string $key ) { /** * Saves the relationship data. * - * @since 0.0.1 + * @since 0.1.0 * * @return void */ @@ -460,7 +460,7 @@ private function saveRelationshipData(): void { /** * Saves the model. * - * @since 0.0.1 + * @since 0.1.0 * * @return int The id of the saved model. * @@ -516,7 +516,7 @@ public function delete(): bool { /** * Deletes all the relationship data. * - * @since 0.0.1 + * @since 0.1.0 * * @return void */ @@ -533,7 +533,7 @@ private function deleteAllRelationshipData(): void { /** * Sets a relationship for the model. * - * @since 0.0.1 + * @since 0.1.0 * * @param string $key The key of the relationship. * @param string $type The type of the relationship. @@ -551,7 +551,7 @@ protected function defineRelationship( string $key, string $type, ?string $throu /** * Sets the relationship columns for the model. * - * @since 0.0.1 + * @since 0.1.0 * * @param string $key The key of the relationship. * @param string $this_entity_column The column of the relationship. From 76e363cfa6bc837608e884bb475710835a36ad98 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Thu, 2 Oct 2025 16:07:35 +0300 Subject: [PATCH 27/50] Update src/SchemaModel.php Co-authored-by: Jason Adams --- src/SchemaModel.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 81839ee..e890187 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -85,7 +85,7 @@ abstract public static function getTableInterface(): Table_Interface; * * @since 0.1.0 * - * @return string + * @return class-string */ protected static function getTableClass(): string { return get_class( static::getTableInterface() ); From f3ab055b0bc04cb57b02d18261d828b8eed8cf62 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Thu, 2 Oct 2025 16:07:52 +0300 Subject: [PATCH 28/50] Update src/SchemaModel.php Co-authored-by: Jason Adams --- src/SchemaModel.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index e890187..0b7d9e7 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -537,7 +537,7 @@ private function deleteAllRelationshipData(): void { * * @param string $key The key of the relationship. * @param string $type The type of the relationship. - * @param ?string $through A table interface that provides the relationship. + * @param ?class-string $through A table interface that provides the relationship. * @param string $relationship_entity The entity of the relationship. */ protected function defineRelationship( string $key, string $type, ?string $through = null, string $relationship_entity = 'post' ): void { From 55bb14fb003c85d5c2d1d38394229a0736d0602c Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 2 Oct 2025 13:08:13 +0000 Subject: [PATCH 29/50] chore: autopublish 2025-10-02T13:08:13Z --- src/SchemaModel.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 0b7d9e7..669cccd 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -535,10 +535,10 @@ private function deleteAllRelationshipData(): void { * * @since 0.1.0 * - * @param string $key The key of the relationship. - * @param string $type The type of the relationship. + * @param string $key The key of the relationship. + * @param string $type The type of the relationship. * @param ?class-string $through A table interface that provides the relationship. - * @param string $relationship_entity The entity of the relationship. + * @param string $relationship_entity The entity of the relationship. */ protected function defineRelationship( string $key, string $type, ?string $through = null, string $relationship_entity = 'post' ): void { static::$relationships[ $key ] = [ From e1d4b2b2ce93994e68a29d14306773a770414f87 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Thu, 2 Oct 2025 16:10:47 +0300 Subject: [PATCH 30/50] phpcs and TBD replacements --- src/SchemaModel.php | 11 +++++------ tests/_support/Helper/Container.php | 4 ++-- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 0b7d9e7..190860a 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -326,7 +326,7 @@ protected static function generatePropertyDefinitions(): array { /** * Sets a relationship. * - * @since 2.0.0 + * @since 0.1.0 * * @param string $key Relationship name. * @param mixed $value Relationship value. @@ -495,7 +495,7 @@ public function save(): int { /** * Deletes the model. * - * @since TBD + * @since 0.1.0 * * @return bool Whether the model was deleted. * @@ -535,10 +535,10 @@ private function deleteAllRelationshipData(): void { * * @since 0.1.0 * - * @param string $key The key of the relationship. - * @param string $type The type of the relationship. + * @param string $key The key of the relationship. + * @param string $type The type of the relationship. * @param ?class-string $through A table interface that provides the relationship. - * @param string $relationship_entity The entity of the relationship. + * @param string $relationship_entity The entity of the relationship. */ protected function defineRelationship( string $key, string $type, ?string $through = null, string $relationship_entity = 'post' ): void { static::$relationships[ $key ] = [ @@ -607,7 +607,6 @@ public static function fromData( $data, $mode = self::BUILD_MODE_IGNORE_EXTRA ) continue; } - // Remember not to use $type, as it may be an array that includes the default value. Safer to use getPropertyType(). $model->setAttribute( $key, static::castValueForProperty( static::getPropertyDefinition( $key ), $data[ $key ], $key ) ); } diff --git a/tests/_support/Helper/Container.php b/tests/_support/Helper/Container.php index 3d864ac..b6e0566 100644 --- a/tests/_support/Helper/Container.php +++ b/tests/_support/Helper/Container.php @@ -2,7 +2,7 @@ /** * Schema Models's container for tests. * - * @since TBD + * @since 0.1.0 * * @package StellarWP\SchemaModels\Tests */ @@ -18,7 +18,7 @@ /** * Schema Models's container for tests. * - * @since TBD + * @since 0.1.0 * * @package StellarWP\SchemaModels\Tests */ From a55645d49a0410e565923f124fa5c68b2986c2ef Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Thu, 2 Oct 2025 16:42:43 +0300 Subject: [PATCH 31/50] Specifying the abstract instead of the interface to take advantage of the trait methods --- src/Contracts/SchemaModel.php | 4 ++-- src/SchemaModel.php | 8 ++++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/src/Contracts/SchemaModel.php b/src/Contracts/SchemaModel.php index b3e998c..4f332f2 100644 --- a/src/Contracts/SchemaModel.php +++ b/src/Contracts/SchemaModel.php @@ -11,7 +11,7 @@ namespace StellarWP\SchemaModels\Contracts; -use StellarWP\Schema\Tables\Contracts\Table_Interface; +use StellarWP\Schema\Tables\Contracts\Table as Table_Interface; use StellarWP\Models\Contracts\Model; interface SchemaModel extends Model { @@ -47,7 +47,7 @@ public static function getTableInterface(): Table_Interface; * * @since 0.1.0 * - * @return array The relationships of the model. + * @return array> The relationships of the model. */ public function getRelationships(): array; diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 190860a..fc1bbd6 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -14,7 +14,7 @@ use StellarWP\SchemaModels\Contracts\SchemaModel as SchemaModelInterface; use StellarWP\Models\ValueObjects\Relationship; use StellarWP\DB\DB; -use StellarWP\Schema\Tables\Contracts\Table_Interface; +use StellarWP\Schema\Tables\Contracts\Table as Table_Interface; use StellarWP\Schema\Tables\Contracts\Table_Schema_Interface; use RuntimeException; use StellarWP\Models\Model; @@ -44,6 +44,8 @@ abstract class SchemaModel extends Model implements SchemaModelInterface { /** * The model relationships assigned to their relationship types. * + * @since 0.1.0 + * * @var array> */ protected static array $relationships = []; // @phpstan-ignore-line @@ -51,6 +53,8 @@ abstract class SchemaModel extends Model implements SchemaModelInterface { /** * The model properties assigned to their types. * + * @since 0.1.0 + * * @var array */ protected static array $properties = []; // @phpstan-ignore-line @@ -163,7 +167,7 @@ public function __call( string $name, array $arguments ) { * * @since 0.1.0 * - * @return array The relationships of the model. + * @return array> The relationships of the model. */ public function getRelationships(): array { return static::$relationships; From 8083b12423b0c71b7a37420d9e1c11ec1617b15b Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Thu, 2 Oct 2025 16:57:46 +0300 Subject: [PATCH 32/50] Fix tests --- tests/_support/Helper/Schema/MockModelSchema.php | 2 +- .../_support/Helper/Schema/MockModelSchemaWithRelationship.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/_support/Helper/Schema/MockModelSchema.php b/tests/_support/Helper/Schema/MockModelSchema.php index d265343..fac28ad 100644 --- a/tests/_support/Helper/Schema/MockModelSchema.php +++ b/tests/_support/Helper/Schema/MockModelSchema.php @@ -3,7 +3,7 @@ namespace StellarWP\SchemaModels\Tests\Schema; use StellarWP\SchemaModels\SchemaModel; -use StellarWP\Schema\Tables\Contracts\Table_Interface; +use StellarWP\Schema\Tables\Contracts\Table as Table_Interface; class MockModelSchema extends SchemaModel { public static function getTableInterface(): Table_Interface { diff --git a/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php b/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php index e3f2b32..4a647ba 100644 --- a/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php +++ b/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php @@ -3,7 +3,7 @@ namespace StellarWP\SchemaModels\Tests\Schema; use StellarWP\SchemaModels\SchemaModel; -use StellarWP\Schema\Tables\Contracts\Table_Interface; +use StellarWP\Schema\Tables\Contracts\Table as Table_Interface; use StellarWP\Models\ValueObjects\Relationship; class MockModelSchemaWithRelationship extends SchemaModel { From ee24f207d00b2fc1473d2bfa5fbce4f078845ccf Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Thu, 2 Oct 2025 16:59:32 +0300 Subject: [PATCH 33/50] Fix static analysis --- src/SchemaModel.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index fc1bbd6..61c91ae 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -46,7 +46,7 @@ abstract class SchemaModel extends Model implements SchemaModelInterface { * * @since 0.1.0 * - * @var array> + * @var array */ protected static array $relationships = []; // @phpstan-ignore-line @@ -167,7 +167,7 @@ public function __call( string $name, array $arguments ) { * * @since 0.1.0 * - * @return array> The relationships of the model. + * @return array The relationships of the model. */ public function getRelationships(): array { return static::$relationships; From 1da00a3f25a4f9c83499c06d3b56c0b59a320a51 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Thu, 2 Oct 2025 17:02:08 +0300 Subject: [PATCH 34/50] Fix phpcs --- .github/workflows/phpcs.yml | 2 +- src/SchemaModel.php | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/phpcs.yml b/.github/workflows/phpcs.yml index c58c87a..5af9578 100644 --- a/.github/workflows/phpcs.yml +++ b/.github/workflows/phpcs.yml @@ -31,4 +31,4 @@ jobs: - name: PHP Code Sniffer run: | - vendor/bin/phpcs ./ + vendor/bin/phpcs ./ -s diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 61c91ae..07a5379 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -539,6 +539,8 @@ private function deleteAllRelationshipData(): void { * * @since 0.1.0 * + * phpcs:disable Squiz.Commenting.FunctionComment.IncorrectTypeHint + * * @param string $key The key of the relationship. * @param string $type The type of the relationship. * @param ?class-string $through A table interface that provides the relationship. @@ -552,6 +554,8 @@ protected function defineRelationship( string $key, string $type, ?string $throu ]; } + // phpcs:enable Squiz.Commenting.FunctionComment.IncorrectTypeHint + /** * Sets the relationship columns for the model. * From 2bf950545eaf358d8b8447a1f2f22b7b82b9f2de Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Thu, 2 Oct 2025 19:45:09 +0300 Subject: [PATCH 35/50] Update license to GPL3 --- LICENSE | 695 ++++++++++++++++++++++++++++++++++++++++++++++++-- composer.json | 2 +- 2 files changed, 675 insertions(+), 22 deletions(-) diff --git a/LICENSE b/LICENSE index 1f3f5bd..f288702 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,674 @@ -MIT License - -Copyright (c) 2025 StellarWP - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/composer.json b/composer.json index 4caca89..d342424 100644 --- a/composer.json +++ b/composer.json @@ -2,7 +2,7 @@ "name": "stellarwp/schema-models", "description": "A library for offloading tasks to background processes.", "type": "library", - "license": "MIT", + "license": "GPL-3.0-or-later", "config": { "platform": { "php": "7.4" From fa1f4419fe4cc8cfcb46951af9923a63fbc7eebb Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Thu, 2 Oct 2025 19:48:14 +0300 Subject: [PATCH 36/50] use our own exceptions --- .../BadMethodCallSchemaModelException.php | 21 +++++++++++++++++ src/Exceptions/SchemaModelException.php | 23 +++++++++++++++++++ src/SchemaModel.php | 12 +++++----- 3 files changed, 50 insertions(+), 6 deletions(-) create mode 100644 src/Exceptions/BadMethodCallSchemaModelException.php create mode 100644 src/Exceptions/SchemaModelException.php diff --git a/src/Exceptions/BadMethodCallSchemaModelException.php b/src/Exceptions/BadMethodCallSchemaModelException.php new file mode 100644 index 0000000..cb99c1c --- /dev/null +++ b/src/Exceptions/BadMethodCallSchemaModelException.php @@ -0,0 +1,21 @@ +getRelationships(); if ( ! $this->hasProperty( $property ) && ! isset( $relationships[ $property ] ) ) { - throw new BadMethodCallException( "`{$property}` is not a property or a relationship on the model." ); + throw new BadMethodCallSchemaModelException( "`{$property}` is not a property or a relationship on the model." ); } $is_getter = str_starts_with( $name, 'get_' ); From 0b132687a0a28ebf2d9f7d4545dbd3db8b59c01f Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Thu, 2 Oct 2025 23:14:53 +0300 Subject: [PATCH 37/50] Changes to match newer models API --- composer.json | 2 +- .../Relationships/ManyToManyWithPosts.php | 83 +++++ src/Contracts/SchemaModel.php | 21 +- src/Relationships/ManyToManyWithPosts.php | 143 +++++++++ src/SchemaModel.php | 297 ++++++------------ .../MockModelSchemaWithRelationship.php | 11 +- 6 files changed, 342 insertions(+), 215 deletions(-) create mode 100644 src/Contracts/Relationships/ManyToManyWithPosts.php create mode 100644 src/Relationships/ManyToManyWithPosts.php diff --git a/composer.json b/composer.json index d342424..32fae07 100644 --- a/composer.json +++ b/composer.json @@ -34,7 +34,7 @@ "minimum-stability": "stable", "require": { "php": ">=7.4", - "stellarwp/models": "dev-release/2.0.0", + "stellarwp/models": "dev-feature/improved-relationships", "stellarwp/schema": "^3.1.2" }, "require-dev": { diff --git a/src/Contracts/Relationships/ManyToManyWithPosts.php b/src/Contracts/Relationships/ManyToManyWithPosts.php new file mode 100644 index 0000000..0c27cd0 --- /dev/null +++ b/src/Contracts/Relationships/ManyToManyWithPosts.php @@ -0,0 +1,83 @@ + $tableInterface The table interface. + * + * @return self + */ + public function setTableInterface( string $tableInterface ): self; + + /** + * Gets the this entity column. + * + * @since 0.1.0 + * + * @return string + */ + public function getThisEntityColumn(): string; + + /** + * Gets the other entity column. + * + * @since 0.1.0 + * + * @return string + */ + public function getOtherEntityColumn(): string; + + /** + * Gets the table interface. + * + * @since 0.1.0 + * + * @return class-string + */ + public function getTableInterface(): string; +} diff --git a/src/Contracts/SchemaModel.php b/src/Contracts/SchemaModel.php index 4f332f2..d37ba32 100644 --- a/src/Contracts/SchemaModel.php +++ b/src/Contracts/SchemaModel.php @@ -13,6 +13,7 @@ use StellarWP\Schema\Tables\Contracts\Table as Table_Interface; use StellarWP\Models\Contracts\Model; +use StellarWP\Models\ModelRelationshipCollection; interface SchemaModel extends Model { /** @@ -34,22 +35,22 @@ public function getPrimaryValue(); public function getPrimaryColumn(): string; /** - * Gets the table interface of the model. + * Gets the relationship collection of the model. * * @since 0.1.0 * - * @return Table_Interface + * @return ModelRelationshipCollection */ - public static function getTableInterface(): Table_Interface; + public function getRelationships(): ModelRelationshipCollection; /** - * Gets the relationships of the model. + * Gets the table interface of the model. * * @since 0.1.0 * - * @return array> The relationships of the model. + * @return Table_Interface */ - public function getRelationships(): array; + public static function getTableInterface(): Table_Interface; /** * Deletes the relationship data for a given key. @@ -66,9 +67,9 @@ public function deleteRelationshipData( string $key ): void; * @since 0.1.0 * * @param string $key The key of the relationship. - * @param int $id The ID to add. + * @param mixed $id The ID to add. */ - public function addToRelationship( string $key, int $id ): void; + public function addToRelationship( string $key, $id ): void; /** * Removes an ID from a relationship. @@ -76,9 +77,9 @@ public function addToRelationship( string $key, int $id ): void; * @since 0.1.0 * * @param string $key The key of the relationship. - * @param int $id The ID to remove. + * @param mixed $id The ID to remove. */ - public function removeFromRelationship( string $key, int $id ): void; + public function removeFromRelationship( string $key, $id ): void; /** * Saves the model. diff --git a/src/Relationships/ManyToManyWithPosts.php b/src/Relationships/ManyToManyWithPosts.php new file mode 100644 index 0000000..721e16d --- /dev/null +++ b/src/Relationships/ManyToManyWithPosts.php @@ -0,0 +1,143 @@ + + */ + private string $tableInterface; + + /** + * The this entity column. + * + * @since 0.1.0 + * + * @var string + */ + private string $thisEntityColumn; + + /** + * The other entity column. + * + * @since 0.1.0 + * + * @var string + */ + private string $otherEntityColumn; + + /** + * Constructor. + * + * @since 0.1.0 + * + * @param string $key The relationship key/name. + */ + public function __construct( string $key ) { + parent::__construct( $key ); + + $this->manyToMany(); + } + + /** + * Sets the this entity column. + * + * @since 0.1.0 + * + * @param string $thisEntityColumn The this entity column. + * + * @return self + */ + public function setThisEntityColumn( string $thisEntityColumn ): self { + $this->thisEntityColumn = $thisEntityColumn; + + return $this; + } + + /** + * Sets the other entity column. + * + * @since 0.1.0 + * + * @param string $otherEntityColumn The other entity column. + * + * @return self + */ + public function setOtherEntityColumn( string $otherEntityColumn ): self { + $this->otherEntityColumn = $otherEntityColumn; + + return $this; + } + + /** + * Sets the table interface. + * + * @since 0.1.0 + * + * @param class-string $tableInterface The table interface. + * + * @return self + */ + public function setTableInterface( string $tableInterface ): self { + $this->tableInterface = $tableInterface; + + return $this; + } + + /** + * Gets the this entity column. + * + * @since 0.1.0 + * + * @return string + */ + public function getThisEntityColumn(): string { + return $this->thisEntityColumn; + } + + /** + * Gets the other entity column. + * + * @since 0.1.0 + * + * @return string + */ + public function getOtherEntityColumn(): string { + return $this->otherEntityColumn; + } + + /** + * Gets the table interface. + * + * @since 0.1.0 + * + * @return class-string + */ + public function getTableInterface(): string { + return $this->tableInterface; + } +} diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 012867a..ad945fa 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -12,14 +12,14 @@ use InvalidArgumentException; use StellarWP\SchemaModels\Exceptions\BadMethodCallSchemaModelException; use StellarWP\SchemaModels\Contracts\SchemaModel as SchemaModelInterface; -use StellarWP\Models\ValueObjects\Relationship; use StellarWP\DB\DB; use StellarWP\Schema\Tables\Contracts\Table as Table_Interface; use StellarWP\Schema\Tables\Contracts\Table_Schema_Interface; use RuntimeException; use StellarWP\Models\Model; use StellarWP\Models\ModelPropertyDefinition; -use WP_Post; +use StellarWP\Models\ModelRelationshipCollection; +use StellarWP\SchemaModels\Contracts\Relationships\ManyToManyWithPosts as ManyToManyWithPostsContract; use StellarWP\Schema\Columns\Contracts\Column; use DateTime; use DateTimeInterface; @@ -41,40 +41,6 @@ abstract class SchemaModel extends Model implements SchemaModelInterface { */ private array $relationshipData = []; - /** - * The model relationships assigned to their relationship types. - * - * @since 0.1.0 - * - * @var array - */ - protected static array $relationships = []; // @phpstan-ignore-line - - /** - * The model properties assigned to their types. - * - * @since 0.1.0 - * - * @var array - */ - protected static array $properties = []; // @phpstan-ignore-line - - /** - * Acts as the constructor. - * - * @since 0.1.0 - */ - protected function afterConstruct(): void { - $this->constructRelationships(); - } - - /** - * Constructs the relationships of the model. - * - * @return void - */ - protected function constructRelationships(): void {} - /** * Gets the table interface of the model. * @@ -95,6 +61,17 @@ protected static function getTableClass(): string { return get_class( static::getTableInterface() ); } + /** + * Gets the relationship collection of the model. + * + * @since 0.1.0 + * + * @return ModelRelationshipCollection + */ + public function getRelationships(): ModelRelationshipCollection { + return $this->relationshipCollection; + } + /** * Gets the primary value of the model. * @@ -137,25 +114,24 @@ public function __call( string $name, array $arguments ) { } $property = str_replace( [ 'get_', 'set_' ], '', $name ); - $relationships = $this->getRelationships(); - if ( ! $this->hasProperty( $property ) && ! isset( $relationships[ $property ] ) ) { + if ( ! $this->hasProperty( $property ) && ! $this->getRelationships()->has( $property ) ) { throw new BadMethodCallSchemaModelException( "`{$property}` is not a property or a relationship on the model." ); } $is_getter = str_starts_with( $name, 'get_' ); if ( $is_getter ) { - if ( isset( $relationships[ $property ] ) ) { - return $this->getRelationship( $property ); + if ( $this->getRelationships()->has( $property ) ) { + return $this->$property; } return $this->getAttribute( $property ); } $args = $arguments['0'] ?? null; - if ( isset( $relationships[ $property ] ) ) { - $args ? $this->setRelationship( $property, (array) $args ) : $this->deleteRelationshipData( $property ); + if ( $this->getRelationships()->has( $property ) ) { + $args ? $this->setCachedRelationship( $property, (array) $args ) : $this->deleteRelationshipData( $property ); return; } @@ -163,33 +139,55 @@ public function __call( string $name, array $arguments ) { } /** - * Gets the relationships of the model. + * Deletes the relationship data for a given key. * * @since 0.1.0 * - * @return array The relationships of the model. + * @param string $key The key of the relationship. + * + * @throws InvalidArgumentException If the relationship does not exist. */ - public function getRelationships(): array { - return static::$relationships; + public function deleteRelationshipData( string $key ): void { + if ( ! $this->getRelationships()->has( $key ) ) { + throw new InvalidArgumentException( "Relationship {$key} does not exist." ); + } + + /** @var ModelRelationshipDefinition $relationship */ + $definition = $this->getRelationships()->get( $key )->getDefinition(); + + if ( $definition instanceof ManyToManyWithPostsContract ) { + $definition->getTableInterface()::delete( $this->getPrimaryValue(), $definition->getThisEntityColumn() ); + } } /** - * Deletes the relationship data for a given key. + * Fetches a relationship's value. * * @since 0.1.0 * - * @param string $key The key of the relationship. + * @param string $key Relationship name. * - * @throws InvalidArgumentException If the relationship does not exist. + * @return Model|list|null */ - public function deleteRelationshipData( string $key ): void { - if ( ! isset( $this->getRelationships()[ $key ] ) ) { - throw new InvalidArgumentException( "Relationship {$key} does not exist." ); - } + protected function fetchRelationship( string $key ) { + $relationship = $this->getRelationships()->getOrFail( $key ); + $definition = $relationship->getDefinition(); - if ( $this->getRelationships()[ $key ]['type'] === Relationship::MANY_TO_MANY ) { - $this->getRelationships()[ $key ]['through']::delete( $this->getPrimaryValue(), $this->getRelationships()[ $key ]['columns']['this'] ); + if ( ! $definition instanceof ManyToManyWithPostsContract ) { + throw new InvalidArgumentException( "Relationship {$key} is not a many to many relationship. I don't know how to fetch it." ); } + + $table = $definition->getTableInterface(); + + return wp_list_pluck( + $table::get_all_by( + $definition->getThisEntityColumn(), + $this->getPrimaryValue(), + '=', + 1000 + ), + $definition->getOtherEntityColumn() + ); } /** @@ -198,12 +196,12 @@ public function deleteRelationshipData( string $key ): void { * @since 0.1.0 * * @param string $key The key of the relationship. - * @param int $id The ID to add. + * @param mixed $id The ID to add. * * @throws InvalidArgumentException If the relationship does not exist. */ - public function addToRelationship( string $key, int $id ): void { - if ( ! isset( $this->getRelationships()[ $key ] ) ) { + public function addToRelationship( string $key, $id ): void { + if ( ! $this->getRelationships()->has( $key ) ) { throw new InvalidArgumentException( "Relationship {$key} does not exist." ); } @@ -220,8 +218,6 @@ public function addToRelationship( string $key, int $id ): void { if ( ! empty( $this->relationshipData[ $key ]['delete'] ) ) { $this->relationshipData[ $key ]['delete'] = array_diff( $this->relationshipData[ $key ]['delete'], [ $id ] ); } - - $this->relationshipData[ $key ]['current'] = array_unique( array_merge( $this->relationshipData[ $key ]['current'] ?? [], [ $id ] ) ); } /** @@ -230,12 +226,12 @@ public function addToRelationship( string $key, int $id ): void { * @since 0.1.0 * * @param string $key The key of the relationship. - * @param int $id The ID to remove. + * @param mixed $id The ID to remove. * * @throws InvalidArgumentException If the relationship does not exist. */ - public function removeFromRelationship( string $key, int $id ): void { - if ( ! isset( $this->getRelationships()[ $key ] ) ) { + public function removeFromRelationship( string $key, $id ): void { + if ( ! $this->getRelationships()->has( $key ) ) { throw new InvalidArgumentException( "Relationship {$key} does not exist." ); } @@ -252,20 +248,11 @@ public function removeFromRelationship( string $key, int $id ): void { if ( ! empty( $this->relationshipData[ $key ]['insert'] ) ) { $this->relationshipData[ $key ]['insert'] = array_diff( $this->relationshipData[ $key ]['insert'], [ $id ] ); } - - $this->relationshipData[ $key ]['current'] = array_diff( $this->relationshipData[ $key ]['current'] ?? [], [ $id ] ); } /** * Generates the property definitions for the model. * - * This method processes the raw property definitions from static::$properties and static::properties(), - * converting shorthand notation to ModelPropertyDefinition instances and locking them. - * - * Child classes can override this method to customize how property definitions are generated, - * either by completely replacing the logic or by calling parent::generatePropertyDefinitions() - * and modifying the results. - * * @since 0.1.0 * * @return array @@ -273,9 +260,8 @@ public function removeFromRelationship( string $key, int $id ): void { * @throws RuntimeException On unknown reserved keyword. */ protected static function generatePropertyDefinitions(): array { - $table_interface = static::getTableInterface(); /** @var Table_Schema_Interface $table_schema */ - $table_schema = $table_interface::get_current_schema(); + $table_schema = static::getTableClass()::get_current_schema(); /** @var array $property_definitions */ $property_definitions = []; @@ -328,95 +314,46 @@ protected static function generatePropertyDefinitions(): array { } /** - * Sets a relationship. + * Updates the cached value for a given relationship. * * @since 0.1.0 * * @param string $key Relationship name. - * @param mixed $value Relationship value. + * @param Model|list|null $value The relationship value to cache. * * @throws InvalidArgumentException If the relationship is not an integer. */ - protected function setRelationship( string $key, $value ): void { - $old_value = $this->relationshipData[ $key ]['current'] ?? null; - $this->relationshipData[ $key ]['current'] = $value; + protected function setCachedRelationship( string $key, $value ): void { + $relationship = $this->getRelationships()->get( $key ); + + if ( ! $relationship ) { + throw new InvalidArgumentException( "Relationship '$key' is not defined on this model." ); + } + + if ( ! isset( $this->relationshipData[ $key ] ) || ! is_array( $this->relationshipData[ $key ] ) ) { + $this->relationshipData[ $key ] = []; + } + + $old_value = $relationship->isLoaded() && $relationship->getDefinition()->hasCachingEnabled() ? $relationship->getValue( fn() => true ) : null; + $relationship->setValue( $value ); if ( $old_value ) { if ( is_array( $old_value ) ) { foreach ( $old_value as $i ) { - $this->removeFromRelationship( $key, $i ); + $this->removeFromRelationship( $key, $i instanceof self ? $i->getPrimaryValue() : $i ); } } else { - $this->removeFromRelationship( $key, $old_value ); + $this->removeFromRelationship( $key, $old_value instanceof self ? $old_value->getPrimaryValue() : $old_value ); } } if ( is_array( $value ) ) { foreach ( $value as $i ) { - if ( ! is_int( $i ) ) { - throw new InvalidArgumentException( "Relationship {$key} must be an integer." ); - } - - $this->addToRelationship( $key, $i ); + $this->addToRelationship( $key, $i instanceof self ? $i->getPrimaryValue() : $i ); } } else { - if ( ! is_int( $value ) ) { - throw new InvalidArgumentException( "Relationship {$key} must be an integer." ); - } - - $this->addToRelationship( $key, $value ); - } - } - - /** - * Returns a relationship. - * - * @since 0.1.0 - * - * @param string $key Relationship name. - * - * @return null|WP_Post|Model|Model[] - * - * @throws InvalidArgumentException If the relationship does not exist. - */ - protected function getRelationship( string $key ) { - $relationships = $this->getRelationships(); - if ( ! isset( $relationships[ $key ] ) ) { - throw new InvalidArgumentException( "Relationship {$key} does not exist." ); - } - - if ( isset( $this->relationshipData[ $key ]['current'] ) ) { - return $this->relationshipData[ $key ]['current']; - } - - $relationship = $relationships[ $key ]; - - $relationship_type = $relationship['type']; - - switch ( $relationship_type ) { - case Relationship::BELONGS_TO: - case Relationship::HAS_ONE: - if ( 'post' === $relationship['entity'] ) { - $this->relationshipData[ $key ]['current'] = get_post( $this->getAttribute( $key ) ); - return $this->relationshipData[ $key ]['current']; - } - - throw new InvalidArgumentException( "Relationship {$key} is not a post relationship." ); - case Relationship::HAS_MANY: - case Relationship::BELONGS_TO_MANY: - case Relationship::MANY_TO_MANY: - $this->relationshipData[ $key ]['current'] = wp_list_pluck( - $relationship['through']::get_all_by( - $relationship['columns']['this'], - $this->getPrimaryValue() - ), - $relationship['columns']['other'] - ); - - return $this->relationshipData[ $key ]['current']; + $this->addToRelationship( $key, $value instanceof self ? $value->getPrimaryValue() : $value ); } - - return null; } /** @@ -427,8 +364,9 @@ protected function getRelationship( string $key ) { * @return void */ private function saveRelationshipData(): void { - foreach ( $this->getRelationships() as $key => $relationship ) { - if ( Relationship::MANY_TO_MANY !== $relationship['type'] ) { + foreach ( $this->getRelationships()->getAll() as $key => $relationship ) { + $definition = $relationship->getDefinition(); + if ( ! $definition instanceof ManyToManyWithPostsContract ) { continue; } @@ -436,26 +374,26 @@ private function saveRelationshipData(): void { $insert_data = []; foreach ( $this->relationshipData[ $key ]['insert'] as $insert_id ) { $insert_data[] = [ - $this->getRelationships()[ $key ]['columns']['this'] => $this->getPrimaryValue(), - $this->getRelationships()[ $key ]['columns']['other'] => $insert_id, + $definition->getThisEntityColumn() => $this->getPrimaryValue(), + $definition->getOtherEntityColumn() => $insert_id, ]; } // First delete them to avoid duplicates. - $relationship['through']::delete_many( + $definition->getTableInterface()::delete_many( $this->relationshipData[ $key ]['insert'], - $this->getRelationships()[ $key ]['columns']['other'], - DB::prepare( ' AND %i = %d', $this->getRelationships()[ $key ]['columns']['this'], $this->getPrimaryValue() ) + $definition->getOtherEntityColumn(), + DB::prepare( ' AND %i = %d', $definition->getThisEntityColumn(), $this->getPrimaryValue() ) ); - $relationship['through']::insert_many( $insert_data ); + $definition->getTableInterface()::insert_many( $insert_data ); } if ( ! empty( $this->relationshipData[ $key ]['delete'] ) ) { - $relationship['through']::delete_many( + $definition->getTableInterface()::delete_many( $this->relationshipData[ $key ]['delete'], - $this->getRelationships()[ $key ]['columns']['other'], - DB::prepare( ' AND %i = %d', $this->getRelationships()[ $key ]['columns']['this'], $this->getPrimaryValue() ) + $definition->getOtherEntityColumn(), + DB::prepare( ' AND %i = %d', $definition->getThisEntityColumn(), $this->getPrimaryValue() ) ); } } @@ -525,59 +463,16 @@ public function delete(): bool { * @return void */ private function deleteAllRelationshipData(): void { - if ( empty( $this->getRelationships() ) ) { + $relationships = $this->getRelationships()->getAll(); + if ( empty( $relationships ) ) { return; } - foreach ( array_keys( $this->getRelationships() ) as $key ) { + foreach ( array_keys( $relationships ) as $key ) { $this->deleteRelationshipData( $key ); } } - /** - * Sets a relationship for the model. - * - * @since 0.1.0 - * - * phpcs:disable Squiz.Commenting.FunctionComment.IncorrectTypeHint - * - * @param string $key The key of the relationship. - * @param string $type The type of the relationship. - * @param ?class-string $through A table interface that provides the relationship. - * @param string $relationship_entity The entity of the relationship. - */ - protected function defineRelationship( string $key, string $type, ?string $through = null, string $relationship_entity = 'post' ): void { - static::$relationships[ $key ] = [ - 'type' => $type, - 'through' => $through, - 'entity' => $relationship_entity, - ]; - } - - // phpcs:enable Squiz.Commenting.FunctionComment.IncorrectTypeHint - - /** - * Sets the relationship columns for the model. - * - * @since 0.1.0 - * - * @param string $key The key of the relationship. - * @param string $this_entity_column The column of the relationship. - * @param string $other_entity_column The other entity column. - * - * @throws InvalidArgumentException If the relationship does not exist. - */ - protected function defineRelationshipColumns( string $key, string $this_entity_column, string $other_entity_column ): void { - if ( ! isset( $this->getRelationships()[ $key ] ) ) { - throw new InvalidArgumentException( "Relationship {$key} does not exist." ); - } - - static::$relationships[ $key ]['columns'] = [ - 'this' => $this_entity_column, - 'other' => $other_entity_column, - ]; - } - /** * Constructs a model instance from database query data. * @@ -618,12 +513,12 @@ public static function fromData( $data, $mode = self::BUILD_MODE_IGNORE_EXTRA ) $model->setAttribute( $key, static::castValueForProperty( static::getPropertyDefinition( $key ), $data[ $key ], $key ) ); } - foreach ( array_keys( $model->getRelationships() ) as $key ) { + foreach ( array_keys( $model->getRelationships()->getAll() ) as $key ) { if ( ! isset( $data[ $key ] ) ) { continue; } - $model->setRelationship( $key, $data[ $key ] ); + $model->setCachedRelationship( $key, $data[ $key ] ); } if ( $model->getPrimaryValue() ) { diff --git a/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php b/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php index 4a647ba..e4b64ab 100644 --- a/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php +++ b/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php @@ -5,11 +5,16 @@ use StellarWP\SchemaModels\SchemaModel; use StellarWP\Schema\Tables\Contracts\Table as Table_Interface; use StellarWP\Models\ValueObjects\Relationship; +use StellarWP\SchemaModels\Relationships\ManyToManyWithPosts; class MockModelSchemaWithRelationship extends SchemaModel { - protected function constructRelationships(): void { - $this->defineRelationship( 'posts', Relationship::MANY_TO_MANY, MockRelationshipTable::class ); - $this->defineRelationshipColumns( 'posts', 'mock_model_id', 'post_id' ); + protected static function relationships(): array { + return [ + 'posts' => ( new ManyToManyWithPosts( 'posts' ) ) + ->setTableInterface( MockRelationshipTable::class ) + ->setThisEntityColumn( 'mock_model_id' ) + ->setOtherEntityColumn( 'post_id' ), + ]; } public static function getTableInterface(): Table_Interface { From 70b68966cbdedb8da246d1f526094e1ed295a23c Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 2 Oct 2025 20:15:20 +0000 Subject: [PATCH 38/50] chore: autopublish 2025-10-02T20:15:20Z --- src/SchemaModel.php | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index ad945fa..5c0cdb5 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -113,7 +113,7 @@ public function __call( string $name, array $arguments ) { throw new BadMethodCallSchemaModelException( "Method {$name} does not exist on the model." ); } - $property = str_replace( [ 'get_', 'set_' ], '', $name ); + $property = str_replace( [ 'get_', 'set_' ], '', $name ); if ( ! $this->hasProperty( $property ) && ! $this->getRelationships()->has( $property ) ) { throw new BadMethodCallSchemaModelException( "`{$property}` is not a property or a relationship on the model." ); @@ -171,7 +171,7 @@ public function deleteRelationshipData( string $key ): void { */ protected function fetchRelationship( string $key ) { $relationship = $this->getRelationships()->getOrFail( $key ); - $definition = $relationship->getDefinition(); + $definition = $relationship->getDefinition(); if ( ! $definition instanceof ManyToManyWithPostsContract ) { throw new InvalidArgumentException( "Relationship {$key} is not a many to many relationship. I don't know how to fetch it." ); @@ -318,7 +318,7 @@ protected static function generatePropertyDefinitions(): array { * * @since 0.1.0 * - * @param string $key Relationship name. + * @param string $key Relationship name. * @param Model|list|null $value The relationship value to cache. * * @throws InvalidArgumentException If the relationship is not an integer. @@ -374,7 +374,7 @@ private function saveRelationshipData(): void { $insert_data = []; foreach ( $this->relationshipData[ $key ]['insert'] as $insert_id ) { $insert_data[] = [ - $definition->getThisEntityColumn() => $this->getPrimaryValue(), + $definition->getThisEntityColumn() => $this->getPrimaryValue(), $definition->getOtherEntityColumn() => $insert_id, ]; } From 246de7f6e00cbbcfa2a545b47c4ba2963bc34dc1 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Fri, 3 Oct 2025 20:35:24 +0300 Subject: [PATCH 39/50] Make relationships more dynamic --- composer.json | 2 +- .../Relationships/ManyToManyWithPosts.php | 2 +- .../Relationships/RelationshipCRUD.php | 56 ++++++ .../RelationshipWithLazyMethods.php | 27 +++ src/Contracts/SchemaModel.php | 23 +-- src/Relationships/ManyToManyWithPosts.php | 107 +++++++++++ src/SchemaModel.php | 170 ++++++++++-------- tests/wpunit/SchemaModelRelationshipsTest.php | 17 +- tests/wpunit/SchemaModelTest.php | 2 +- 9 files changed, 306 insertions(+), 100 deletions(-) create mode 100644 src/Contracts/Relationships/RelationshipCRUD.php create mode 100644 src/Contracts/Relationships/RelationshipWithLazyMethods.php diff --git a/composer.json b/composer.json index 32fae07..4459d3a 100644 --- a/composer.json +++ b/composer.json @@ -34,7 +34,7 @@ "minimum-stability": "stable", "require": { "php": ">=7.4", - "stellarwp/models": "dev-feature/improved-relationships", + "stellarwp/models": "dev-feat/support-post-models-and-lazy-loading", "stellarwp/schema": "^3.1.2" }, "require-dev": { diff --git a/src/Contracts/Relationships/ManyToManyWithPosts.php b/src/Contracts/Relationships/ManyToManyWithPosts.php index 0c27cd0..45a2126 100644 --- a/src/Contracts/Relationships/ManyToManyWithPosts.php +++ b/src/Contracts/Relationships/ManyToManyWithPosts.php @@ -20,7 +20,7 @@ * * @package StellarWP\SchemaModels\Contracts\Relationships; */ -interface ManyToManyWithPosts { +interface ManyToManyWithPosts extends RelationshipWithLazyMethods, RelationshipCRUD { /** * Sets the this entity column. * diff --git a/src/Contracts/Relationships/RelationshipCRUD.php b/src/Contracts/Relationships/RelationshipCRUD.php new file mode 100644 index 0000000..b8d0fa9 --- /dev/null +++ b/src/Contracts/Relationships/RelationshipCRUD.php @@ -0,0 +1,56 @@ +tableInterface; } + + /** + * Deletes the relationship data. + * + * @since 0.1.0 + * + * @param mixed $id The ID of the relationship. + */ + public function deleteAllRelationshipData( $id ): void { + $this->getTableInterface()::delete( $id, $this->getThisEntityColumn() ); + } + + /** + * Fetches the relationship data. + * + * @since 0.1.0 + * + * @param mixed $id The ID of the relationship. + */ + public function fetchRelationshipData( $id ) { + $table = $this->getTableInterface(); + + return array_map( + fn( $id ) => new LazyWPPostModel($id), + wp_list_pluck( + $table::get_all_by( + $this->getThisEntityColumn(), + $id, + '=', + 1000 + ), + $this->getOtherEntityColumn() + ) ); + } + + /** + * Inserts the relationship data. + * + * @since 0.1.0 + * + * @param mixed $id The ID of the relationship. + * @param array $data The data to insert. + */ + public function insertRelationshipData( $id, array $data = [] ): void { + if ( empty( $data ) ) { + return; + } + + $insert_data = []; + foreach ( $data as $insert_id ) { + $insert_data[] = [ + $this->getThisEntityColumn() => $id, + $this->getOtherEntityColumn() => $insert_id, + ]; + } + + // First delete them to avoid duplicates. + $this->getTableInterface()::delete_many( + $data, + $this->getOtherEntityColumn(), + DB::prepare( ' AND %i = %d', $this->getThisEntityColumn(), $id ) + ); + + $this->getTableInterface()::insert_many( $insert_data ); + } + + /** + * Deletes the relationship data. + * + * @since 0.1.0 + * + * @param mixed $id The ID of the relationship. + */ + public function deleteRelationshipData( $id, $data ): void { + $this->getTableInterface()::delete_many( + $data, + $this->getOtherEntityColumn(), + DB::prepare( ' AND %i = %d', $this->getThisEntityColumn(), $id ) + ); + } + + /** + * Converts a value to a lazy model. + * + * @since 0.1.0 + * + * @param mixed $value The value to convert. + * + * @return ?LazyModelInterface + */ + public function toLazy( $value ): ?LazyModelInterface { + if ( $value instanceof LazyModelInterface ) { + return $value; + } + + $value = intval( $value ); + + if ( ! $value ) { + return null; + } + + return new LazyWPPostModel( $value ); + } } diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 5c0cdb5..0084479 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -17,12 +17,16 @@ use StellarWP\Schema\Tables\Contracts\Table_Schema_Interface; use RuntimeException; use StellarWP\Models\Model; +use StellarWP\Models\Contracts\Model as ModelContract; use StellarWP\Models\ModelPropertyDefinition; use StellarWP\Models\ModelRelationshipCollection; -use StellarWP\SchemaModels\Contracts\Relationships\ManyToManyWithPosts as ManyToManyWithPostsContract; +use StellarWP\SchemaModels\Contracts\Relationships\RelationshipWithLazyMethods; +use StellarWP\SchemaModels\Contracts\Relationships\RelationshipCRUD as RelationshipCRUDContract; use StellarWP\Schema\Columns\Contracts\Column; use DateTime; use DateTimeInterface; +use StellarWP\Models\ModelQueryBuilder; +use StellarWP\Models\Contracts\LazyModel as LazyModelInterface; /** * The schema model. @@ -68,10 +72,36 @@ protected static function getTableClass(): string { * * @return ModelRelationshipCollection */ - public function getRelationships(): ModelRelationshipCollection { + public function getRelationshipCollection(): ModelRelationshipCollection { return $this->relationshipCollection; } + /** + * @since 0.1.0 + * + * @param int|string $id + * + * @return ?SchemaModel + */ + public static function find( $id ): ?SchemaModel { + return static::getTableClass()::get_by_id( $id ); + } + + /** + * @since 0.1.0 + * + * @param array $attributes + * + * @return SchemaModel + * + * @throws RuntimeException If the model fails to save. + */ + public static function create( array $attributes ): SchemaModel { + $model = static::fromData( $attributes ); + + return $model->save(); + } + /** * Gets the primary value of the model. * @@ -115,22 +145,22 @@ public function __call( string $name, array $arguments ) { $property = str_replace( [ 'get_', 'set_' ], '', $name ); - if ( ! $this->hasProperty( $property ) && ! $this->getRelationships()->has( $property ) ) { + if ( ! $this->hasProperty( $property ) && ! $this->getRelationshipCollection()->has( $property ) ) { throw new BadMethodCallSchemaModelException( "`{$property}` is not a property or a relationship on the model." ); } $is_getter = str_starts_with( $name, 'get_' ); if ( $is_getter ) { - if ( $this->getRelationships()->has( $property ) ) { - return $this->$property; + if ( $this->getRelationshipCollection()->has( $property ) ) { + return $this->getRelationship( $property ); } return $this->getAttribute( $property ); } $args = $arguments['0'] ?? null; - if ( $this->getRelationships()->has( $property ) ) { + if ( $this->getRelationshipCollection()->has( $property ) ) { $args ? $this->setCachedRelationship( $property, (array) $args ) : $this->deleteRelationshipData( $property ); return; } @@ -148,16 +178,18 @@ public function __call( string $name, array $arguments ) { * @throws InvalidArgumentException If the relationship does not exist. */ public function deleteRelationshipData( string $key ): void { - if ( ! $this->getRelationships()->has( $key ) ) { + if ( ! $this->getRelationshipCollection()->has( $key ) ) { throw new InvalidArgumentException( "Relationship {$key} does not exist." ); } /** @var ModelRelationshipDefinition $relationship */ - $definition = $this->getRelationships()->get( $key )->getDefinition(); + $definition = $this->getRelationshipCollection()->get( $key )->getDefinition(); - if ( $definition instanceof ManyToManyWithPostsContract ) { - $definition->getTableInterface()::delete( $this->getPrimaryValue(), $definition->getThisEntityColumn() ); + if ( ! $definition instanceof RelationshipCRUDContract ) { + throw new InvalidArgumentException( "Relationship {$key} is not a relationship with CRUD." ); } + + $definition->deleteAllRelationshipData( $this->getPrimaryValue() ); } /** @@ -167,27 +199,17 @@ public function deleteRelationshipData( string $key ): void { * * @param string $key Relationship name. * - * @return Model|list|null + * @return Model|Model[]|LazyModelInterface|LazyModelInterface[]|null */ protected function fetchRelationship( string $key ) { - $relationship = $this->getRelationships()->getOrFail( $key ); + $relationship = $this->getRelationshipCollection()->getOrFail( $key ); $definition = $relationship->getDefinition(); - if ( ! $definition instanceof ManyToManyWithPostsContract ) { - throw new InvalidArgumentException( "Relationship {$key} is not a many to many relationship. I don't know how to fetch it." ); + if ( ! $definition instanceof RelationshipCRUDContract ) { + throw new InvalidArgumentException( "Relationship {$key} is not a relationship with CRUD. I don't know how to fetch it." ); } - $table = $definition->getTableInterface(); - - return wp_list_pluck( - $table::get_all_by( - $definition->getThisEntityColumn(), - $this->getPrimaryValue(), - '=', - 1000 - ), - $definition->getOtherEntityColumn() - ); + return $definition->fetchRelationshipData( $this->getPrimaryValue() ); } /** @@ -201,7 +223,7 @@ protected function fetchRelationship( string $key ) { * @throws InvalidArgumentException If the relationship does not exist. */ public function addToRelationship( string $key, $id ): void { - if ( ! $this->getRelationships()->has( $key ) ) { + if ( ! $this->getRelationshipCollection()->has( $key ) ) { throw new InvalidArgumentException( "Relationship {$key} does not exist." ); } @@ -213,10 +235,10 @@ public function addToRelationship( string $key, $id ): void { $this->relationshipData[ $key ]['insert'] = []; } - $this->relationshipData[ $key ]['insert'][] = $id; + $this->relationshipData[ $key ]['insert'][] = $id instanceof LazyModelInterface ? $id->get_id() : $id; if ( ! empty( $this->relationshipData[ $key ]['delete'] ) ) { - $this->relationshipData[ $key ]['delete'] = array_diff( $this->relationshipData[ $key ]['delete'], [ $id ] ); + $this->relationshipData[ $key ]['delete'] = array_diff( $this->relationshipData[ $key ]['delete'], [ $id instanceof LazyModelInterface ? $id->get_id() : $id ] ); } } @@ -231,7 +253,7 @@ public function addToRelationship( string $key, $id ): void { * @throws InvalidArgumentException If the relationship does not exist. */ public function removeFromRelationship( string $key, $id ): void { - if ( ! $this->getRelationships()->has( $key ) ) { + if ( ! $this->getRelationshipCollection()->has( $key ) ) { throw new InvalidArgumentException( "Relationship {$key} does not exist." ); } @@ -243,10 +265,10 @@ public function removeFromRelationship( string $key, $id ): void { $this->relationshipData[ $key ]['delete'] = []; } - $this->relationshipData[ $key ]['delete'][] = $id; + $this->relationshipData[ $key ]['delete'][] = $id instanceof LazyModelInterface ? $id->get_id() : $id; if ( ! empty( $this->relationshipData[ $key ]['insert'] ) ) { - $this->relationshipData[ $key ]['insert'] = array_diff( $this->relationshipData[ $key ]['insert'], [ $id ] ); + $this->relationshipData[ $key ]['insert'] = array_diff( $this->relationshipData[ $key ]['insert'], [ $id instanceof LazyModelInterface ? $id->get_id() : $id ] ); } } @@ -259,7 +281,7 @@ public function removeFromRelationship( string $key, $id ): void { * * @throws RuntimeException On unknown reserved keyword. */ - protected static function generatePropertyDefinitions(): array { + protected static function properties(): array { /** @var Table_Schema_Interface $table_schema */ $table_schema = static::getTableClass()::get_current_schema(); @@ -308,8 +330,6 @@ protected static function generatePropertyDefinitions(): array { $property_definitions[ $column->get_name() ] = $definition; } - static::$properties = $property_definitions; - return $property_definitions; } @@ -318,23 +338,40 @@ protected static function generatePropertyDefinitions(): array { * * @since 0.1.0 * - * @param string $key Relationship name. - * @param Model|list|null $value The relationship value to cache. + * @param string $key Relationship name. + * @param mixed $value The relationship value to cache. * * @throws InvalidArgumentException If the relationship is not an integer. */ protected function setCachedRelationship( string $key, $value ): void { - $relationship = $this->getRelationships()->get( $key ); + $relationship = $this->getRelationshipCollection()->get( $key ); if ( ! $relationship ) { throw new InvalidArgumentException( "Relationship '$key' is not defined on this model." ); } + $definition = $relationship->getDefinition(); + if ( $definition instanceof RelationshipWithLazyMethods ) { + $value = $definition->isSingle() ? $definition->toLazy( $value ) : array_map( fn( $v ) => $definition->toLazy( $v ), $value ); + } + + if ( is_array( $value ) ) { + foreach ( $value as $v ) { + if ( null === $v || $v instanceof LazyModelInterface || $v instanceof ModelContract ) { + continue; + } + + throw new InvalidArgumentException( "Each element of the relationship '$key' value must be a Model instance or LazyModelInterface instance or null." ); + } + } elseif ( null !== $value && ! $value instanceof LazyModelInterface && ! $value instanceof ModelContract ) { + throw new InvalidArgumentException( "Relationship '$key' value must be a Model instance or LazyModelInterface instance or null." ); + } + if ( ! isset( $this->relationshipData[ $key ] ) || ! is_array( $this->relationshipData[ $key ] ) ) { $this->relationshipData[ $key ] = []; } - $old_value = $relationship->isLoaded() && $relationship->getDefinition()->hasCachingEnabled() ? $relationship->getValue( fn() => true ) : null; + $old_value = $relationship->isLoaded() && $definition->hasCachingEnabled() ? $this->getRelationship( $key ) : null; $relationship->setValue( $value ); if ( $old_value ) { @@ -364,37 +401,18 @@ protected function setCachedRelationship( string $key, $value ): void { * @return void */ private function saveRelationshipData(): void { - foreach ( $this->getRelationships()->getAll() as $key => $relationship ) { + foreach ( $this->getRelationshipCollection()->getAll() as $key => $relationship ) { $definition = $relationship->getDefinition(); - if ( ! $definition instanceof ManyToManyWithPostsContract ) { + if ( ! $definition instanceof RelationshipCRUDContract ) { continue; } if ( ! empty( $this->relationshipData[ $key ]['insert'] ) ) { - $insert_data = []; - foreach ( $this->relationshipData[ $key ]['insert'] as $insert_id ) { - $insert_data[] = [ - $definition->getThisEntityColumn() => $this->getPrimaryValue(), - $definition->getOtherEntityColumn() => $insert_id, - ]; - } - - // First delete them to avoid duplicates. - $definition->getTableInterface()::delete_many( - $this->relationshipData[ $key ]['insert'], - $definition->getOtherEntityColumn(), - DB::prepare( ' AND %i = %d', $definition->getThisEntityColumn(), $this->getPrimaryValue() ) - ); - - $definition->getTableInterface()::insert_many( $insert_data ); + $definition->insertRelationshipData( $this->getPrimaryValue(), $this->relationshipData[ $key ]['insert'] ); } if ( ! empty( $this->relationshipData[ $key ]['delete'] ) ) { - $definition->getTableInterface()::delete_many( - $this->relationshipData[ $key ]['delete'], - $definition->getOtherEntityColumn(), - DB::prepare( ' AND %i = %d', $definition->getThisEntityColumn(), $this->getPrimaryValue() ) - ); + $definition->deleteRelationshipData( $this->getPrimaryValue(), $this->relationshipData[ $key ]['delete'] ); } } } @@ -404,14 +422,14 @@ private function saveRelationshipData(): void { * * @since 0.1.0 * - * @return int The id of the saved model. + * @return self The saved model. * * @throws RuntimeException If the model fails to save. */ - public function save(): int { + public function save(): self { if ( ! $this->isDirty() ) { $this->saveRelationshipData(); - return $this->getPrimaryValue(); + return $this; } $result = $this->getTableClass()::upsert( $this->toArray() ); @@ -420,18 +438,26 @@ public function save(): int { throw new RuntimeException( __( 'Failed to save the model.', 'stellarwp-schema-models' ) ); } - $id = $this->getPrimaryValue(); - - if ( ! $id ) { - $id = DB::last_insert_id(); - $this->setAttribute( $this->getPrimaryColumn(), $id ); + if ( ! $this->getPrimaryValue() ) { + $this->setAttribute( $this->getPrimaryColumn(), DB::last_insert_id() ); } $this->commitChanges(); $this->saveRelationshipData(); - return $id; + return $this; + } + + /** + * Returns the query builder for the model. + * + * @since 0.1.0 + * + * @return ModelQueryBuilder + */ + public static function query(): ModelQueryBuilder { + return ( new ModelQueryBuilder( static::class ) )->from( static::getTableClass()::table_name( false ) ); } /** @@ -463,7 +489,7 @@ public function delete(): bool { * @return void */ private function deleteAllRelationshipData(): void { - $relationships = $this->getRelationships()->getAll(); + $relationships = $this->getRelationshipCollection()->getAll(); if ( empty( $relationships ) ) { return; } @@ -513,7 +539,7 @@ public static function fromData( $data, $mode = self::BUILD_MODE_IGNORE_EXTRA ) $model->setAttribute( $key, static::castValueForProperty( static::getPropertyDefinition( $key ), $data[ $key ], $key ) ); } - foreach ( array_keys( $model->getRelationships()->getAll() ) as $key ) { + foreach ( array_keys( $model->getRelationshipCollection()->getAll() ) as $key ) { if ( ! isset( $data[ $key ] ) ) { continue; } diff --git a/tests/wpunit/SchemaModelRelationshipsTest.php b/tests/wpunit/SchemaModelRelationshipsTest.php index d98f8ab..7cd3bee 100644 --- a/tests/wpunit/SchemaModelRelationshipsTest.php +++ b/tests/wpunit/SchemaModelRelationshipsTest.php @@ -6,6 +6,7 @@ use DateTime; use StellarWP\SchemaModels\Tests\Schema\MockModelSchemaWithRelationship; use StellarWP\SchemaModels\Tests\Schema\MockRelationshipTable; +use StellarWP\Models\WPPostModel; use StellarWP\DB\DB; class SchemaModelRelationshipsTest extends WPTestCase { @@ -22,7 +23,7 @@ public function test_save() { $model = MockModelSchemaWithRelationship::fromData( $model_data, 1 ); $this->assertTrue( $model->isDirty() ); - $id = $model->save(); + $id = $model->save()->getPrimaryValue(); $this->assertFalse( $model->isDirty() ); $this->assertIsInt( $id ); @@ -34,7 +35,13 @@ public function test_save() { $this->assertEquals( $model_data['microseconds'], $model->get_microseconds() ); $this->assertEquals( $model_data['int'], $model->get_int() ); $this->assertEquals( $model_data['date'], $model->get_date() ); - $this->assertEquals( $model_data['posts'], $model->get_posts() ); + + $postModels = $model->get_posts(); + $this->assertCount( 2, $postModels ); + $this->assertInstanceOf( WPPostModel::class, $postModels[0] ); + $this->assertInstanceOf( WPPostModel::class, $postModels[1] ); + $this->assertEquals( $post_id_1, $postModels[0]->getAttribute('ID') ); + $this->assertEquals( $post_id_2, $postModels[1]->getAttribute('ID') ); } public function test_queries_returns_models() { @@ -103,9 +110,9 @@ public function test_queries_returns_models() { $this->assertEquals( $models[0]->get_date(), $results[0]->get_date() ); $this->assertEquals( $models[1]->get_date(), $results[1]->get_date() ); $this->assertEquals( $models[2]->get_date(), $results[2]->get_date() ); - $this->assertEquals( $models[0]->get_posts(), $results[0]->get_posts() ); - $this->assertEquals( $models[1]->get_posts(), $results[1]->get_posts() ); - $this->assertEquals( $models[2]->get_posts(), $results[2]->get_posts() ); + $this->assertEquals( array_map(fn($post) => $post->getAttribute('ID'), $models[0]->get_posts()), array_map(fn($post) => $post->getAttribute('ID'), $results[0]->get_posts()) ); + $this->assertEquals( array_map(fn($post) => $post->getAttribute('ID'), $models[1]->get_posts()), array_map(fn($post) => $post->getAttribute('ID'), $results[1]->get_posts()) ); + $this->assertEquals( array_map(fn($post) => $post->getAttribute('ID'), $models[2]->get_posts()), array_map(fn($post) => $post->getAttribute('ID'), $results[2]->get_posts()) ); } public function test_delete() { diff --git a/tests/wpunit/SchemaModelTest.php b/tests/wpunit/SchemaModelTest.php index 6ce74f2..72b5533 100644 --- a/tests/wpunit/SchemaModelTest.php +++ b/tests/wpunit/SchemaModelTest.php @@ -18,7 +18,7 @@ public function test_save() { $model = MockModelSchema::fromData( $model_data, 1 ); $this->assertTrue( $model->isDirty() ); - $id = $model->save(); + $id = $model->save()->getPrimaryValue(); $this->assertFalse( $model->isDirty() ); $this->assertIsInt( $id ); From 5ff0dba3f05b96b02c6b7f1bef2a6ca236fe377e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 3 Oct 2025 17:35:54 +0000 Subject: [PATCH 40/50] chore: autopublish 2025-10-03T17:35:54Z --- src/Relationships/ManyToManyWithPosts.php | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Relationships/ManyToManyWithPosts.php b/src/Relationships/ManyToManyWithPosts.php index 83377a7..d5758e1 100644 --- a/src/Relationships/ManyToManyWithPosts.php +++ b/src/Relationships/ManyToManyWithPosts.php @@ -17,7 +17,6 @@ use StellarWP\Models\LazyWPPostModel; use StellarWP\Models\Contracts\LazyModel as LazyModelInterface; use StellarWP\DB\DB; -use InvalidArgumentException; /** * Many to many relationship with posts. @@ -167,7 +166,7 @@ public function fetchRelationshipData( $id ) { $table = $this->getTableInterface(); return array_map( - fn( $id ) => new LazyWPPostModel($id), + fn( $id ) => new LazyWPPostModel( $id ), wp_list_pluck( $table::get_all_by( $this->getThisEntityColumn(), @@ -175,8 +174,9 @@ public function fetchRelationshipData( $id ) { '=', 1000 ), - $this->getOtherEntityColumn() - ) ); + $this->getOtherEntityColumn() + ) + ); } /** From 4a42541756e363571565a4641d6f5e555f64c302 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Fri, 3 Oct 2025 20:37:43 +0300 Subject: [PATCH 41/50] added docblock --- src/Contracts/SchemaModel.php | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/Contracts/SchemaModel.php b/src/Contracts/SchemaModel.php index 01ab6d4..1efed1f 100644 --- a/src/Contracts/SchemaModel.php +++ b/src/Contracts/SchemaModel.php @@ -16,6 +16,13 @@ use StellarWP\Models\Contracts\ModelPersistable; use StellarWP\Models\ModelRelationshipCollection; +/** + * The schema model contract. + * + * @since 0.1.0 + * + * @package StellarWP\SchemaModels\Contracts; + */ interface SchemaModel extends Model, ModelPersistable { /** * Gets the primary value of the model. From 7605f3416e6642247f06c315a7eace5a72e8b9a4 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Fri, 3 Oct 2025 20:40:39 +0300 Subject: [PATCH 42/50] Fix static analysis --- src/SchemaModel.php | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 0084479..4817074 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -27,6 +27,7 @@ use DateTimeInterface; use StellarWP\Models\ModelQueryBuilder; use StellarWP\Models\Contracts\LazyModel as LazyModelInterface; +use StellarWP\Models\ModelRelationshipDefinition; /** * The schema model. @@ -182,7 +183,7 @@ public function deleteRelationshipData( string $key ): void { throw new InvalidArgumentException( "Relationship {$key} does not exist." ); } - /** @var ModelRelationshipDefinition $relationship */ + /** @var ModelRelationshipDefinition $definition */ $definition = $this->getRelationshipCollection()->get( $key )->getDefinition(); if ( ! $definition instanceof RelationshipCRUDContract ) { From 14914c81ed0b021c88d602c984e02ce61ba46a89 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Fri, 3 Oct 2025 20:44:07 +0300 Subject: [PATCH 43/50] Fix phpcs --- phpcs.xml | 2 ++ src/Contracts/Relationships/ManyToManyWithPosts.php | 4 ++++ src/Contracts/Relationships/RelationshipCRUD.php | 1 + src/Relationships/ManyToManyWithPosts.php | 7 ++++++- src/SchemaModel.php | 6 ++++-- 5 files changed, 17 insertions(+), 3 deletions(-) diff --git a/phpcs.xml b/phpcs.xml index 278ea66..d829218 100644 --- a/phpcs.xml +++ b/phpcs.xml @@ -13,6 +13,8 @@ + + diff --git a/src/Contracts/Relationships/ManyToManyWithPosts.php b/src/Contracts/Relationships/ManyToManyWithPosts.php index 45a2126..dbfded8 100644 --- a/src/Contracts/Relationships/ManyToManyWithPosts.php +++ b/src/Contracts/Relationships/ManyToManyWithPosts.php @@ -48,12 +48,16 @@ public function setOtherEntityColumn( string $otherEntityColumn ): self; * * @since 0.1.0 * + * // phpcs:disable Squiz.Commenting.FunctionComment.IncorrectTypeHint + * * @param class-string $tableInterface The table interface. * * @return self */ public function setTableInterface( string $tableInterface ): self; + // phpcs:enable Squiz.Commenting.FunctionComment.IncorrectTypeHint + /** * Gets the this entity column. * diff --git a/src/Contracts/Relationships/RelationshipCRUD.php b/src/Contracts/Relationships/RelationshipCRUD.php index b8d0fa9..60776e7 100644 --- a/src/Contracts/Relationships/RelationshipCRUD.php +++ b/src/Contracts/Relationships/RelationshipCRUD.php @@ -51,6 +51,7 @@ public function insertRelationshipData( $id, array $data ): void; * @since 0.1.0 * * @param mixed $id The ID of the relationship. + * @param array $data The data to delete. */ public function deleteRelationshipData( $id, $data ): void; } diff --git a/src/Relationships/ManyToManyWithPosts.php b/src/Relationships/ManyToManyWithPosts.php index d5758e1..6187353 100644 --- a/src/Relationships/ManyToManyWithPosts.php +++ b/src/Relationships/ManyToManyWithPosts.php @@ -101,6 +101,8 @@ public function setOtherEntityColumn( string $otherEntityColumn ): self { * * @since 0.1.0 * + * // phpcs:disable Squiz.Commenting.FunctionComment.IncorrectTypeHint + * * @param class-string $tableInterface The table interface. * * @return self @@ -111,6 +113,8 @@ public function setTableInterface( string $tableInterface ): self { return $this; } + // phpcs:enable Squiz.Commenting.FunctionComment.IncorrectTypeHint + /** * Gets the this entity column. * @@ -175,7 +179,7 @@ public function fetchRelationshipData( $id ) { 1000 ), $this->getOtherEntityColumn() - ) + ) ); } @@ -216,6 +220,7 @@ public function insertRelationshipData( $id, array $data = [] ): void { * @since 0.1.0 * * @param mixed $id The ID of the relationship. + * @param array $data The data to delete. */ public function deleteRelationshipData( $id, $data ): void { $this->getTableInterface()::delete_many( diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 4817074..e356264 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -80,7 +80,7 @@ public function getRelationshipCollection(): ModelRelationshipCollection { /** * @since 0.1.0 * - * @param int|string $id + * @param int|string $id The ID of the model. * * @return ?SchemaModel */ @@ -91,7 +91,7 @@ public static function find( $id ): ?SchemaModel { /** * @since 0.1.0 * - * @param array $attributes + * @param array $attributes The attributes of the model. * * @return SchemaModel * @@ -201,6 +201,8 @@ public function deleteRelationshipData( string $key ): void { * @param string $key Relationship name. * * @return Model|Model[]|LazyModelInterface|LazyModelInterface[]|null + * + * @throws InvalidArgumentException If the relationship is not a relationship with CRUD. */ protected function fetchRelationship( string $key ) { $relationship = $this->getRelationshipCollection()->getOrFail( $key ); From 28d05f84e3e67a27566eb246895265043bc4e244 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Tue, 7 Oct 2025 18:44:19 +0300 Subject: [PATCH 44/50] Fix implementation after latest changes in models library --- composer.json | 2 +- .../Relationships/ManyToManyWithPosts.php | 2 +- .../Relationships/RelationshipCRUD.php | 3 +- .../RelationshipWithLazyMethods.php | 27 ---- src/Relationships/ManyToManyWithPosts.php | 29 +---- src/SchemaModel.php | 119 ++++++++---------- .../MockModelSchemaWithRelationship.php | 15 ++- tests/wpunit/SchemaModelRelationshipsTest.php | 18 +-- 8 files changed, 78 insertions(+), 137 deletions(-) delete mode 100644 src/Contracts/Relationships/RelationshipWithLazyMethods.php diff --git a/composer.json b/composer.json index 4459d3a..ea41c66 100644 --- a/composer.json +++ b/composer.json @@ -34,7 +34,7 @@ "minimum-stability": "stable", "require": { "php": ">=7.4", - "stellarwp/models": "dev-feat/support-post-models-and-lazy-loading", + "stellarwp/models": "dev-feat/more-flexibility-on-defining-relationships-and-its-values", "stellarwp/schema": "^3.1.2" }, "require-dev": { diff --git a/src/Contracts/Relationships/ManyToManyWithPosts.php b/src/Contracts/Relationships/ManyToManyWithPosts.php index dbfded8..70abc14 100644 --- a/src/Contracts/Relationships/ManyToManyWithPosts.php +++ b/src/Contracts/Relationships/ManyToManyWithPosts.php @@ -20,7 +20,7 @@ * * @package StellarWP\SchemaModels\Contracts\Relationships; */ -interface ManyToManyWithPosts extends RelationshipWithLazyMethods, RelationshipCRUD { +interface ManyToManyWithPosts extends RelationshipCRUD { /** * Sets the this entity column. * diff --git a/src/Contracts/Relationships/RelationshipCRUD.php b/src/Contracts/Relationships/RelationshipCRUD.php index 60776e7..e208bcd 100644 --- a/src/Contracts/Relationships/RelationshipCRUD.php +++ b/src/Contracts/Relationships/RelationshipCRUD.php @@ -11,7 +11,6 @@ namespace StellarWP\SchemaModels\Contracts\Relationships; -use StellarWP\Models\Contracts\LazyModel as LazyModelInterface; use StellarWP\Models\Contracts\Model as ModelContract; interface RelationshipCRUD { @@ -31,7 +30,7 @@ public function deleteAllRelationshipData( $id ): void; * * @param mixed $id The ID of the relationship. * - * @return ModelContract|ModelContract[]|LazyModelInterface|LazyModelInterface[]|null + * @return ModelContract|ModelContract[]|null */ public function fetchRelationshipData( $id ); diff --git a/src/Contracts/Relationships/RelationshipWithLazyMethods.php b/src/Contracts/Relationships/RelationshipWithLazyMethods.php deleted file mode 100644 index 6c889b0..0000000 --- a/src/Contracts/Relationships/RelationshipWithLazyMethods.php +++ /dev/null @@ -1,27 +0,0 @@ -getTableInterface(); + $sanitizer = $this->getValidateSanitizeRelationshipWith(); + return array_map( - fn( $id ) => new LazyWPPostModel( $id ), + fn( $id ) => $sanitizer( $id ), wp_list_pluck( $table::get_all_by( $this->getThisEntityColumn(), @@ -229,27 +229,4 @@ public function deleteRelationshipData( $id, $data ): void { DB::prepare( ' AND %i = %d', $this->getThisEntityColumn(), $id ) ); } - - /** - * Converts a value to a lazy model. - * - * @since 0.1.0 - * - * @param mixed $value The value to convert. - * - * @return ?LazyModelInterface - */ - public function toLazy( $value ): ?LazyModelInterface { - if ( $value instanceof LazyModelInterface ) { - return $value; - } - - $value = intval( $value ); - - if ( ! $value ) { - return null; - } - - return new LazyWPPostModel( $value ); - } } diff --git a/src/SchemaModel.php b/src/SchemaModel.php index e356264..131dc9d 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -17,16 +17,13 @@ use StellarWP\Schema\Tables\Contracts\Table_Schema_Interface; use RuntimeException; use StellarWP\Models\Model; -use StellarWP\Models\Contracts\Model as ModelContract; use StellarWP\Models\ModelPropertyDefinition; use StellarWP\Models\ModelRelationshipCollection; -use StellarWP\SchemaModels\Contracts\Relationships\RelationshipWithLazyMethods; use StellarWP\SchemaModels\Contracts\Relationships\RelationshipCRUD as RelationshipCRUDContract; use StellarWP\Schema\Columns\Contracts\Column; use DateTime; use DateTimeInterface; use StellarWP\Models\ModelQueryBuilder; -use StellarWP\Models\Contracts\LazyModel as LazyModelInterface; use StellarWP\Models\ModelRelationshipDefinition; /** @@ -200,7 +197,7 @@ public function deleteRelationshipData( string $key ): void { * * @param string $key Relationship name. * - * @return Model|Model[]|LazyModelInterface|LazyModelInterface[]|null + * @return Model|Model[]|null * * @throws InvalidArgumentException If the relationship is not a relationship with CRUD. */ @@ -238,10 +235,10 @@ public function addToRelationship( string $key, $id ): void { $this->relationshipData[ $key ]['insert'] = []; } - $this->relationshipData[ $key ]['insert'][] = $id instanceof LazyModelInterface ? $id->get_id() : $id; + $this->relationshipData[ $key ]['insert'][] = $id; if ( ! empty( $this->relationshipData[ $key ]['delete'] ) ) { - $this->relationshipData[ $key ]['delete'] = array_diff( $this->relationshipData[ $key ]['delete'], [ $id instanceof LazyModelInterface ? $id->get_id() : $id ] ); + $this->relationshipData[ $key ]['delete'] = array_diff( $this->relationshipData[ $key ]['delete'], [ $id ] ); } } @@ -268,10 +265,10 @@ public function removeFromRelationship( string $key, $id ): void { $this->relationshipData[ $key ]['delete'] = []; } - $this->relationshipData[ $key ]['delete'][] = $id instanceof LazyModelInterface ? $id->get_id() : $id; + $this->relationshipData[ $key ]['delete'][] = $id; if ( ! empty( $this->relationshipData[ $key ]['insert'] ) ) { - $this->relationshipData[ $key ]['insert'] = array_diff( $this->relationshipData[ $key ]['insert'], [ $id instanceof LazyModelInterface ? $id->get_id() : $id ] ); + $this->relationshipData[ $key ]['insert'] = array_diff( $this->relationshipData[ $key ]['insert'], [ $id ] ); } } @@ -336,66 +333,6 @@ protected static function properties(): array { return $property_definitions; } - /** - * Updates the cached value for a given relationship. - * - * @since 0.1.0 - * - * @param string $key Relationship name. - * @param mixed $value The relationship value to cache. - * - * @throws InvalidArgumentException If the relationship is not an integer. - */ - protected function setCachedRelationship( string $key, $value ): void { - $relationship = $this->getRelationshipCollection()->get( $key ); - - if ( ! $relationship ) { - throw new InvalidArgumentException( "Relationship '$key' is not defined on this model." ); - } - - $definition = $relationship->getDefinition(); - if ( $definition instanceof RelationshipWithLazyMethods ) { - $value = $definition->isSingle() ? $definition->toLazy( $value ) : array_map( fn( $v ) => $definition->toLazy( $v ), $value ); - } - - if ( is_array( $value ) ) { - foreach ( $value as $v ) { - if ( null === $v || $v instanceof LazyModelInterface || $v instanceof ModelContract ) { - continue; - } - - throw new InvalidArgumentException( "Each element of the relationship '$key' value must be a Model instance or LazyModelInterface instance or null." ); - } - } elseif ( null !== $value && ! $value instanceof LazyModelInterface && ! $value instanceof ModelContract ) { - throw new InvalidArgumentException( "Relationship '$key' value must be a Model instance or LazyModelInterface instance or null." ); - } - - if ( ! isset( $this->relationshipData[ $key ] ) || ! is_array( $this->relationshipData[ $key ] ) ) { - $this->relationshipData[ $key ] = []; - } - - $old_value = $relationship->isLoaded() && $definition->hasCachingEnabled() ? $this->getRelationship( $key ) : null; - $relationship->setValue( $value ); - - if ( $old_value ) { - if ( is_array( $old_value ) ) { - foreach ( $old_value as $i ) { - $this->removeFromRelationship( $key, $i instanceof self ? $i->getPrimaryValue() : $i ); - } - } else { - $this->removeFromRelationship( $key, $old_value instanceof self ? $old_value->getPrimaryValue() : $old_value ); - } - } - - if ( is_array( $value ) ) { - foreach ( $value as $i ) { - $this->addToRelationship( $key, $i instanceof self ? $i->getPrimaryValue() : $i ); - } - } else { - $this->addToRelationship( $key, $value instanceof self ? $value->getPrimaryValue() : $value ); - } - } - /** * Saves the relationship data. * @@ -484,6 +421,52 @@ public function delete(): bool { return $this->getTableClass()::delete( $uid ); } + /** + * Updates the cached value for a given relationship. + * + * @since 0.1.0 + * + * @param string $key Relationship name. + * @param mixed $value The relationship value to cache. + * + * @throws InvalidArgumentException If the relationship is not an integer. + */ + public function setCachedRelationship( string $key, $value ): void { + $relationship = $this->getRelationshipCollection()->get( $key ); + + if ( ! $relationship ) { + throw new InvalidArgumentException( "Relationship '$key' is not defined on this model." ); + } + + $definition = $relationship->getDefinition(); + + if ( ! isset( $this->relationshipData[ $key ] ) || ! is_array( $this->relationshipData[ $key ] ) ) { + $this->relationshipData[ $key ] = []; + } + + $old_value = $relationship->isLoaded() && $definition->hasCachingEnabled() ? $this->getRelationship( $key ) : null; + parent::setCachedRelationship( $key, $value ); + + if ( $old_value ) { + if ( is_array( $old_value ) ) { + foreach ( $old_value as $i ) { + $this->removeFromRelationship( $key, $i instanceof self ? $i->getPrimaryValue() : $i ); + } + } else { + $this->removeFromRelationship( $key, $old_value instanceof self ? $old_value->getPrimaryValue() : $old_value ); + } + } + + if ( is_array( $value ) ) { + foreach ( $value as $i ) { + $this->addToRelationship( $key, $i instanceof self ? $i->getPrimaryValue() : $i ); + } + } else { + $this->addToRelationship( $key, $value instanceof self ? $value->getPrimaryValue() : $value ); + } + } + + /** * Deletes all the relationship data. * diff --git a/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php b/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php index e4b64ab..4020ddb 100644 --- a/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php +++ b/tests/_support/Helper/Schema/MockModelSchemaWithRelationship.php @@ -11,9 +11,18 @@ class MockModelSchemaWithRelationship extends SchemaModel { protected static function relationships(): array { return [ 'posts' => ( new ManyToManyWithPosts( 'posts' ) ) - ->setTableInterface( MockRelationshipTable::class ) - ->setThisEntityColumn( 'mock_model_id' ) - ->setOtherEntityColumn( 'post_id' ), + ->setTableInterface( MockRelationshipTable::class ) + ->setThisEntityColumn( 'mock_model_id' ) + ->setOtherEntityColumn( 'post_id' ) + ->setHydrateWith( fn( int $post_id ) => get_post( $post_id ) ) + ->setValidateSanitizeRelationshipWith( function ( $post_or_post_id ) { + $p = get_post( $post_or_post_id ); + if ( ! $p instanceof \WP_Post ) { + throw new \InvalidArgumentException( 'Post must be a valid WP_Post object.' ); + } + + return $p->ID; + }), ]; } diff --git a/tests/wpunit/SchemaModelRelationshipsTest.php b/tests/wpunit/SchemaModelRelationshipsTest.php index 7cd3bee..2f00460 100644 --- a/tests/wpunit/SchemaModelRelationshipsTest.php +++ b/tests/wpunit/SchemaModelRelationshipsTest.php @@ -36,12 +36,12 @@ public function test_save() { $this->assertEquals( $model_data['int'], $model->get_int() ); $this->assertEquals( $model_data['date'], $model->get_date() ); - $postModels = $model->get_posts(); - $this->assertCount( 2, $postModels ); - $this->assertInstanceOf( WPPostModel::class, $postModels[0] ); - $this->assertInstanceOf( WPPostModel::class, $postModels[1] ); - $this->assertEquals( $post_id_1, $postModels[0]->getAttribute('ID') ); - $this->assertEquals( $post_id_2, $postModels[1]->getAttribute('ID') ); + $posts = $model->get_posts(); + $this->assertCount( 2, $posts ); + $this->assertInstanceOf( \WP_Post::class, $posts[0] ); + $this->assertInstanceOf( \WP_Post::class, $posts[1] ); + $this->assertEquals( $post_id_1, $posts[0]->ID ); + $this->assertEquals( $post_id_2, $posts[1]->ID ); } public function test_queries_returns_models() { @@ -110,9 +110,9 @@ public function test_queries_returns_models() { $this->assertEquals( $models[0]->get_date(), $results[0]->get_date() ); $this->assertEquals( $models[1]->get_date(), $results[1]->get_date() ); $this->assertEquals( $models[2]->get_date(), $results[2]->get_date() ); - $this->assertEquals( array_map(fn($post) => $post->getAttribute('ID'), $models[0]->get_posts()), array_map(fn($post) => $post->getAttribute('ID'), $results[0]->get_posts()) ); - $this->assertEquals( array_map(fn($post) => $post->getAttribute('ID'), $models[1]->get_posts()), array_map(fn($post) => $post->getAttribute('ID'), $results[1]->get_posts()) ); - $this->assertEquals( array_map(fn($post) => $post->getAttribute('ID'), $models[2]->get_posts()), array_map(fn($post) => $post->getAttribute('ID'), $results[2]->get_posts()) ); + $this->assertEquals( array_map(fn($post) => $post->ID, $models[0]->get_posts()), array_map(fn($post) => $post->ID, $results[0]->get_posts()) ); + $this->assertEquals( array_map(fn($post) => $post->ID, $models[1]->get_posts()), array_map(fn($post) => $post->ID, $results[1]->get_posts()) ); + $this->assertEquals( array_map(fn($post) => $post->ID, $models[2]->get_posts()), array_map(fn($post) => $post->ID, $results[2]->get_posts()) ); } public function test_delete() { From e155d35b7e12574ad19928703d1554df510475b5 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Tue, 7 Oct 2025 19:13:12 +0300 Subject: [PATCH 45/50] Update model contact referenced --- src/Contracts/Relationships/RelationshipCRUD.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Contracts/Relationships/RelationshipCRUD.php b/src/Contracts/Relationships/RelationshipCRUD.php index e208bcd..97ab69c 100644 --- a/src/Contracts/Relationships/RelationshipCRUD.php +++ b/src/Contracts/Relationships/RelationshipCRUD.php @@ -11,7 +11,7 @@ namespace StellarWP\SchemaModels\Contracts\Relationships; -use StellarWP\Models\Contracts\Model as ModelContract; +use StellarWP\Models\Model as ModelContract; interface RelationshipCRUD { /** From d881f63292356a3151b2bd4ad538b978a2fafba9 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 8 Oct 2025 13:24:52 +0300 Subject: [PATCH 46/50] Upgrade to models v2 --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index ea41c66..3a5fb02 100644 --- a/composer.json +++ b/composer.json @@ -34,7 +34,7 @@ "minimum-stability": "stable", "require": { "php": ">=7.4", - "stellarwp/models": "dev-feat/more-flexibility-on-defining-relationships-and-its-values", + "stellarwp/models": "^2.0.0", "stellarwp/schema": "^3.1.2" }, "require-dev": { From 3d00890524c538f5a815c0fec7849749b79dac8c Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 15 Oct 2025 18:57:51 +0300 Subject: [PATCH 47/50] Introducing useful actions during delete/save methods of a model --- src/SchemaModel.php | 170 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 169 insertions(+), 1 deletion(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 131dc9d..f86c00c 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -111,6 +111,17 @@ public function getPrimaryValue() { return $this->getAttribute( $this->getPrimaryColumn() ); } + /** + * Returns the object vars. + * + * @since 0.1.0 + * + * @return array + */ + public function jsonSerialize(): array { + return $this->toArray(); + } + /** * Gets the primary column of the model. * @@ -187,7 +198,69 @@ public function deleteRelationshipData( string $key ): void { throw new InvalidArgumentException( "Relationship {$key} is not a relationship with CRUD." ); } + $class = get_class( $this ); + + /** + * Fires before the relationship data is deleted. + * + * @since 0.1.0 + * + * @param SchemaModel $this The model. + * @param string $key The key of the relationship. + */ + do_action( "stellarwp_schema_models_pre_delete_relationship_{$key}_{$class}", $this, $key ); + + /** + * Fires before the relationship data is deleted. + * + * @since 0.1.0 + * + * @param SchemaModel $this The model. + * @param string $key The key of the relationship. + */ + do_action( "stellarwp_schema_models_pre_delete_relationship_{$key}", $this, $key ); + + /** + * Fires before the relationship data is deleted. + * + * @since 0.1.0 + * + * @param SchemaModel $this The model. + * @param string $key The key of the relationship. + */ + do_action( "stellarwp_schema_models_pre_delete_relationship", $this, $key ); + $definition->deleteAllRelationshipData( $this->getPrimaryValue() ); + + /** + * Fires after the relationship data is deleted. + * + * @since 0.1.0 + * + * @param SchemaModel $this The model. + * @param string $key The key of the relationship. + */ + do_action( "stellarwp_schema_models_post_delete_relationship_{$key}_{$class}", $this, $key ); + + /** + * Fires after the relationship data is deleted. + * + * @since 0.1.0 + * + * @param SchemaModel $this The model. + * @param string $key The key of the relationship. + */ + do_action( "stellarwp_schema_models_post_delete_relationship_{$key}", $this, $key ); + + /** + * Fires after the relationship data is deleted. + * + * @since 0.1.0 + * + * @param SchemaModel $this The model. + * @param string $key The key of the relationship. + */ + do_action( "stellarwp_schema_models_post_delete_relationship", $this, $key ); } /** @@ -367,8 +440,45 @@ private function saveRelationshipData(): void { * @throws RuntimeException If the model fails to save. */ public function save(): self { + $class = get_class( $this ); + /** + * Fires before the model is saved. + * + * @since 0.1.0 + * + * @param SchemaModel $this The model. + */ + do_action( "stellarwp_schema_models_pre_save_{$class}", $this ); + + /** + * Fires before the model is saved. + * + * @since 0.1.0 + * + * @param SchemaModel $this The model. + */ + do_action( 'stellarwp_schema_models_pre_save', $this ); + if ( ! $this->isDirty() ) { $this->saveRelationshipData(); + + /** + * Fires after the model is saved. + * + * @since 0.1.0 + * + * @param SchemaModel $this The model. + */ + do_action( "stellarwp_schema_models_post_save_{$class}", $this ); + + /** + * Fires after the model is saved. + * + * @since 0.1.0 + * + * @param SchemaModel $this The model. + */ + do_action( 'stellarwp_schema_models_post_save', $this ); return $this; } @@ -386,6 +496,24 @@ public function save(): self { $this->saveRelationshipData(); + /** + * Fires after the model is saved. + * + * @since 0.1.0 + * + * @param SchemaModel $this The model. + */ + do_action( "stellarwp_schema_models_post_save_{$class}", $this ); + + /** + * Fires after the model is saved. + * + * @since 0.1.0 + * + * @param SchemaModel $this The model. + */ + do_action( 'stellarwp_schema_models_post_save', $this ); + return $this; } @@ -416,9 +544,49 @@ public function delete(): bool { throw new RuntimeException( __( 'Model ID is required to delete the model.', 'stellarwp-schema-models' ) ); } + $class = get_class( $this ); + + /** + * Fires before the model is deleted. + * + * @since 0.1.0 + * + * @param SchemaModel $this The model. + */ + do_action( "stellarwp_schema_models_pre_delete_{$class}", $this ); + + /** + * Fires before the model is deleted. + * + * @since 0.1.0 + * + * @param SchemaModel $this The model. + */ + do_action( 'stellarwp_schema_models_pre_delete', $this ); + $this->deleteAllRelationshipData(); - return $this->getTableClass()::delete( $uid ); + $result = $this->getTableClass()::delete( $uid ); + + /** + * Fires after the model is deleted. + * + * @since 0.1.0 + * + * @param SchemaModel $this The model. + */ + do_action( "stellarwp_schema_models_post_delete_{$class}", $this ); + + /** + * Fires after the model is deleted. + * + * @since 0.1.0 + * + * @param SchemaModel $this The model. + */ + do_action( 'stellarwp_schema_models_post_delete', $this ); + + return $result; } /** From 23b800559130601eb614304e4ce414356fb330cc Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 15 Oct 2025 15:58:54 +0000 Subject: [PATCH 48/50] chore: autopublish 2025-10-15T15:58:54Z --- src/SchemaModel.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index f86c00c..558e852 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -228,7 +228,7 @@ public function deleteRelationshipData( string $key ): void { * @param SchemaModel $this The model. * @param string $key The key of the relationship. */ - do_action( "stellarwp_schema_models_pre_delete_relationship", $this, $key ); + do_action( 'stellarwp_schema_models_pre_delete_relationship', $this, $key ); $definition->deleteAllRelationshipData( $this->getPrimaryValue() ); @@ -260,7 +260,7 @@ public function deleteRelationshipData( string $key ): void { * @param SchemaModel $this The model. * @param string $key The key of the relationship. */ - do_action( "stellarwp_schema_models_post_delete_relationship", $this, $key ); + do_action( 'stellarwp_schema_models_post_delete_relationship', $this, $key ); } /** From 66f2d653dfb7fb31940f68b6df0a76c34583875c Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 15 Oct 2025 19:59:37 +0300 Subject: [PATCH 49/50] change to trigger workflows --- tests/config.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/config.php b/tests/config.php index 7de0183..150fdb7 100644 --- a/tests/config.php +++ b/tests/config.php @@ -1,7 +1,7 @@ getenv( 'WP_ROOT_FOLDER' ) . '/wp-content', 'ABSPATH' => getenv( 'WP_ROOT_FOLDER' ) . '/', From 8333c7af9f0fe1c21329a978b7a0edf3d0d8d721 Mon Sep 17 00:00:00 2001 From: Dimitrios Pantazis Date: Wed, 15 Oct 2025 20:02:44 +0300 Subject: [PATCH 50/50] fix static analysis --- src/SchemaModel.php | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/src/SchemaModel.php b/src/SchemaModel.php index 558e852..5f02d0f 100644 --- a/src/SchemaModel.php +++ b/src/SchemaModel.php @@ -205,8 +205,8 @@ public function deleteRelationshipData( string $key ): void { * * @since 0.1.0 * - * @param SchemaModel $this The model. - * @param string $key The key of the relationship. + * @param SchemaModel $model The model. + * @param string $key The key of the relationship. */ do_action( "stellarwp_schema_models_pre_delete_relationship_{$key}_{$class}", $this, $key ); @@ -215,8 +215,8 @@ public function deleteRelationshipData( string $key ): void { * * @since 0.1.0 * - * @param SchemaModel $this The model. - * @param string $key The key of the relationship. + * @param SchemaModel $model The model. + * @param string $key The key of the relationship. */ do_action( "stellarwp_schema_models_pre_delete_relationship_{$key}", $this, $key ); @@ -225,8 +225,8 @@ public function deleteRelationshipData( string $key ): void { * * @since 0.1.0 * - * @param SchemaModel $this The model. - * @param string $key The key of the relationship. + * @param SchemaModel $model The model. + * @param string $key The key of the relationship. */ do_action( 'stellarwp_schema_models_pre_delete_relationship', $this, $key ); @@ -237,8 +237,8 @@ public function deleteRelationshipData( string $key ): void { * * @since 0.1.0 * - * @param SchemaModel $this The model. - * @param string $key The key of the relationship. + * @param SchemaModel $model The model. + * @param string $key The key of the relationship. */ do_action( "stellarwp_schema_models_post_delete_relationship_{$key}_{$class}", $this, $key ); @@ -247,8 +247,8 @@ public function deleteRelationshipData( string $key ): void { * * @since 0.1.0 * - * @param SchemaModel $this The model. - * @param string $key The key of the relationship. + * @param SchemaModel $model The model. + * @param string $key The key of the relationship. */ do_action( "stellarwp_schema_models_post_delete_relationship_{$key}", $this, $key ); @@ -257,8 +257,8 @@ public function deleteRelationshipData( string $key ): void { * * @since 0.1.0 * - * @param SchemaModel $this The model. - * @param string $key The key of the relationship. + * @param SchemaModel $model The model. + * @param string $key The key of the relationship. */ do_action( 'stellarwp_schema_models_post_delete_relationship', $this, $key ); } @@ -446,7 +446,7 @@ public function save(): self { * * @since 0.1.0 * - * @param SchemaModel $this The model. + * @param SchemaModel $model The model. */ do_action( "stellarwp_schema_models_pre_save_{$class}", $this ); @@ -455,7 +455,7 @@ public function save(): self { * * @since 0.1.0 * - * @param SchemaModel $this The model. + * @param SchemaModel $model The model. */ do_action( 'stellarwp_schema_models_pre_save', $this ); @@ -467,7 +467,7 @@ public function save(): self { * * @since 0.1.0 * - * @param SchemaModel $this The model. + * @param SchemaModel $model The model. */ do_action( "stellarwp_schema_models_post_save_{$class}", $this ); @@ -476,7 +476,7 @@ public function save(): self { * * @since 0.1.0 * - * @param SchemaModel $this The model. + * @param SchemaModel $model The model. */ do_action( 'stellarwp_schema_models_post_save', $this ); return $this; @@ -501,7 +501,7 @@ public function save(): self { * * @since 0.1.0 * - * @param SchemaModel $this The model. + * @param SchemaModel $model The model. */ do_action( "stellarwp_schema_models_post_save_{$class}", $this ); @@ -510,7 +510,7 @@ public function save(): self { * * @since 0.1.0 * - * @param SchemaModel $this The model. + * @param SchemaModel $model The model. */ do_action( 'stellarwp_schema_models_post_save', $this ); @@ -551,7 +551,7 @@ public function delete(): bool { * * @since 0.1.0 * - * @param SchemaModel $this The model. + * @param SchemaModel $model The model. */ do_action( "stellarwp_schema_models_pre_delete_{$class}", $this ); @@ -560,7 +560,7 @@ public function delete(): bool { * * @since 0.1.0 * - * @param SchemaModel $this The model. + * @param SchemaModel $model The model. */ do_action( 'stellarwp_schema_models_pre_delete', $this ); @@ -573,7 +573,7 @@ public function delete(): bool { * * @since 0.1.0 * - * @param SchemaModel $this The model. + * @param SchemaModel $model The model. */ do_action( "stellarwp_schema_models_post_delete_{$class}", $this ); @@ -582,7 +582,7 @@ public function delete(): bool { * * @since 0.1.0 * - * @param SchemaModel $this The model. + * @param SchemaModel $model The model. */ do_action( 'stellarwp_schema_models_post_delete', $this );