Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add additional bool return type into PHPDoc information #35660

Open
wants to merge 4 commits into
base: 2.4-develop
Choose a base branch
from

Conversation

artskirk
Copy link

@artskirk artskirk commented Jun 22, 2022

Description (*)

Added additional return type into PHPDoc information.

$connection->fetchOne($select, $bind);

  • Function returns a string when the query result is not null.
  • Function returns false(bool) value when the query result is null.

https://github.com/magento/zf1/blob/6a01e1c4e38accb7fc95fffc2c083b83090bf36c/library/Zend/Db/Adapter/Abstract.php#L819-L831
https://www.php.net/manual/en/pdostatement.fetchcolumn.php

Related Pull Requests

Fixed Issues (if relevant)

Fixes #34598

Manual testing scenarios (*)

Steps to reproduce the issue:

  1. Tested the fetchOne() function output by using the following code sample.
$tableName = $connection->getTableName("sales_order");
$select = $connection->select()->from($tableName, 'entity_id')->where('entity_id = :entity_id');
$entity_id = “random_id_which_is_not_exist”;
$bind = [':entity_id' => $entity_id ];
var_dump( $connection->fetchOne($select, $bind) );
  • Function returns a string when the query result is not null.
  • Function returns false(bool) value when the query result is null.

@m2-assistant
Copy link

m2-assistant bot commented Jun 22, 2022

Hi @artskirk. Thank you for your contribution
Here are some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

  • @magento give me test instance - deploy test instance based on PR changes
  • @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE,
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here

ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

Copy link
Contributor

@edenduong edenduong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution!

@artskirk
Copy link
Author

artskirk commented Aug 2, 2022

@magento run Unit Tests

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@engcom-Lima engcom-Lima added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Aug 28, 2023
@engcom-Dash
Copy link
Contributor

Hello @artskirk,

Thanks for the contribution!

✔️ QA Passed
Preconditions:
Install fresh Magento 2.4-develop

Steps to reproduce

  • Use the lib/internal/Magento/Framework/DB/Adapter/AdapterInterface.php::fetchOne() function to retrieve a value from an existing table.
  • If the value is present in the database, it will return the value in string format.
  • If the value is not present (null), it will return false.

Builds are failed. Hence, moving this PR to Extended Testing.

Thanks

@engcom-Dash
Copy link
Contributor

@magento run all tests

@engcom-Dash
Copy link
Contributor

@magento run all tests

@engcom-Dash
Copy link
Contributor

Raised internal approval Jira for the SVC failure. Moving this PR to Pending Approval now. We will proceed ahead on this once will get all the required approvals.
image

@engcom-Dash engcom-Dash self-assigned this Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Framework Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests Priority: P3 May be fixed according to the position in the backlog. Progress: ready for testing Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it Type: Code Cleanup
Projects
Status: Pending Approval
Development

Successfully merging this pull request may close these issues.

Wrong return type in PHPDoc of fetchOne() method in
5 participants