Skip to content

[6.1] Add getData and supportCheckin methods to Table class #46534

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.

Sign up for GitHub

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

Open
joomdonation wants to merge 2 commits into
base: 6.1-dev
Choose a base branch
from
Open

[6.1] Add getData and supportCheckin methods to Table class #46534

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5421c7e
Add getData and supportCheckin methods to Table classes
joomdonation Dec 4, 2025
4c71726
Remove supportCheckin method
joomdonation Dec 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions libraries/src/Table/Table.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1954,4 +1954,27 @@ public function hasField($key)

return property_exists($this, $key);
}

/**
* Returns the data of the current table record as an associative array.
*
* Each element in the array uses the column name as the key and the
* corresponding value from the record as the value. Fields that are not
* set will be returned as null.
*
* @return array The current record data.
*
* @since __DEPLOY_VERSION__
*/
public function getData(): array
{
$data = [];

foreach ($this->getFields() as $field) {
$fieldName = $field->Field;
$data[$fieldName] = $this->{$fieldName} ?? null;
}

return $data;
}
Comment on lines +1969 to +1979
Copy link
Member

@HLeithner HLeithner Dec 4, 2025

Choose a reason for hiding this comment

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

why is this needed? ArrayHelper::fromObject should do the same? or do I miss something?

Copy link
Contributor Author

@joomdonation joomdonation Dec 4, 2025

Choose a reason for hiding this comment

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

I think if the client code need data from the Table object, the Table class should provide a method to offer that data. We should not have to rely on a helper method from an outside to get necessary data. Having a method like this would be more developer friendly than the other workarounds

Copy link
Member

@HLeithner HLeithner Dec 4, 2025

Choose a reason for hiding this comment

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

I don't think so.

Copy link
Contributor Author

@joomdonation joomdonation Dec 4, 2025

Choose a reason for hiding this comment

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

I feel it is strange that we do not offer this method inside the Table class to expose the data to client code and leave each developer do it in his own way:

  • get_object_vars
  • ArrayHelper::fromObject
  • CMSHelper getRowData
  • CMSHelper getDataObject

Just name a few. Also, please note that the method returns only the actual database columns, in a stable and predictable way while the other methods such as get_object_vars or ArrayHelper::fromObject can return other public properties added to the class. The class itself is the best to provide the data, not from an outsider like this one https://github.com/joomla/joomla-cms/blob/6.1-dev/libraries/src/Helper/CMSHelper.php#L101

}