Skip to content

Web site API reference lacks extended class and implemented interfaces... #338

Open

Description

@endersaka

Description

I feel strange because I can't believe I can't find it...

I pick up just an example. I was trying to understand what Cake\ORM\ResultSet actually is. Easy to guess by the scope and the name (and the methods). But, apart from that, commonly I am used to find reference to extended class and implemented interfaces in API reference documentations. For CakePHP I have to open the source code link.

Example: Cake\ORM\ResultSet.

CakePHP Version

5.2

Activity

  1. dereuromark commented on Nov 15, 2025

    @dereuromark
    Member

    If you search on the book, you find several resources, depending on the scope/topic, e.g.
    https://book.cakephp.org/5/en/orm/query-builder.html#resultset-is-a-collection-object
    Not sure what else would be needed.

  2. ADmad commented on Nov 15, 2025

    @ADmad
    Member

    But, apart from that, commonly I am used to find reference to extended class and implemented interfaces in API reference documentations.

    Can you provided some examples?

  3. endersaka commented on Nov 17, 2025

    @endersaka
    Author

    But, apart from that, commonly I am used to find reference to extended class and implemented interfaces in API reference documentations.

    Can you provided some examples?

    I just picked randomly some:

    1. PHP SPL official documentation https://www.php.net/manual/en/class.appenditerator.php
    2. MDN JavaScript Web APIs documentation https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest (presented its own way but yet, ... I immediately see were XMLHttpRequest come from)
    3. Java Official API reference https://docs.oracle.com/javase/8/docs/api/java/time/chrono/MinguoDate.html I just picked up a random class and it list all the implemented interfaces and the ancestor class tree.
    4. And Laravel, the Application class https://api.laravel.com/docs/12.x/Illuminate/Console/Application.html

    And I could go on for days with similar examples.

  4. transferred this issue fromcakephp/cakephpon Nov 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      ⌂ Proxy