Skip to content

performance optimization not cached objects #9

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
dimadimx wants to merge 2 commits into
base: master
Choose a base branch
from
Open

performance optimization not cached objects #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d95fdf
DimX / add chunk size configuration and optimize uncached object fetc…
Mar 22, 2025
1885cf7
DimX / fix: ensure dirty fields are reset for uncached objects /
Mar 24, 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
8 changes: 8 additions & 0 deletions lib/Skeleton/Object/Config.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<?php

Check failure on line 1 in lib/Skeleton/Object/Config.php

View workflow job for this annotation

GitHub Actions / PHP Insights checks 

* [Declare strict types] Missing declare(strict_types=1).
* [Braces] @@ -2,21 +2,20 @@
 /**
  * Config class
  * Configuration for Skeleton\Object
  *
  * @author David Vandemaele <david@tigron.be>
  */
 
 namespace Skeleton\Object;
 
 class Config {
-
 	/**
 	 * Caching backend handler
 	 *
 	 * @access public
 	 * @var string $classname
 	 */
 	public static $cache_handler = false;
 
 	/**
 	 * Caching backend config
@@ -26,12 +25,11 @@
 	 */
 	public static $cache_handler_config = [];
 
 	/**
 	 * Chunk size items per request to database
 	 *
 	 * @access public
 	 * @var int $chunk_size
 	 */
 	public static $chunk_size = 1000;
-
 }
* [No blank lines after class opening] @@ -2,21 +2,20 @@
 /**
  * Config class
  * Configuration for Skeleton\Object
  *
  * @author David Vandemaele <david@tigron.be>
  */
 
 namespace Skeleton\Object;
 
 class Config {
-
 	/**
 	 * Caching backend handler
 	 *
 	 * @access public
 	 * @var string $classname
 	 */
 	public static $cache_handler = false;
 
 	/**
 	 * Caching backend config
/**
* Config class
* Configuration for Skeleton\Object
Expand All @@ -16,7 +16,7 @@
* @access public
* @var string $classname
*/
public static $cache_handler = false;

Check failure on line 19 in lib/Skeleton/Object/Config.php

View workflow job for this annotation

GitHub Actions / PHP Insights checks 

* [Forbidden public property] Do not use public properties. Use method access instead.
* [Property type hint] Property \Skeleton\Object\Config::$cache_handler does not have native type hint for its value but it should be possible to add it based on @var annotation "string".

/**
* Caching backend config
Expand All @@ -24,6 +24,14 @@
* @access public
* @var string $classname
*/
public static $cache_handler_config = [];

Check failure on line 27 in lib/Skeleton/Object/Config.php

View workflow job for this annotation

GitHub Actions / PHP Insights checks 

* [Forbidden public property] Do not use public properties. Use method access instead.
* [Property type hint] Property \Skeleton\Object\Config::$cache_handler_config does not have native type hint for its value but it should be possible to add it based on @var annotation "string".

/**
* Chunk size items per request to database
*
* @access public
* @var int $chunk_size
*/
public static $chunk_size = 1000;

Check failure on line 35 in lib/Skeleton/Object/Config.php

View workflow job for this annotation

GitHub Actions / PHP Insights checks 

* [Forbidden public property] Do not use public properties. Use method access instead.
* [Property type hint] Property \Skeleton\Object\Config::$chunk_size does not have native type hint for its value but it should be possible to add it based on @var annotation "int".

}
124 changes: 123 additions & 1 deletion lib/Skeleton/Object/Get.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ public static function get_by_ids($ids) {
// Preserve the order of the ids
$result = array_fill_keys($ids, null);

$uncached_object_ids = [];
if (get_called_class()::trait_cache_enabled()) {
$prefix = get_called_class()::trait_get_cache_prefix();
$cache_keys = [];
Expand All @@ -70,18 +71,139 @@ public static function get_by_ids($ids) {

foreach ($ids as $id) {
if (isset($cached_objects_map[$id]) === false) {
$uncached_object_ids[] = $id;
continue;
}
$result[$id] = $cached_objects_map[$id];
}
} else {
$uncached_object_ids = $ids;
}

// check if we have any uncached objects
if (count($uncached_object_ids) === 0) {
// we should reset indexes in case if someone tries to get first element via 0 index
return array_values($result);
}

/**
* If in class_configuration a child_classname field is specified,
* use this
*/
if (property_exists(get_class(), 'class_configuration') === true
&& isset(get_called_class()::$class_configuration['child_classname_field']) === true
) {
$classname_field = get_called_class()::$class_configuration['child_classname_field'];
}

$db = get_called_class()::trait_get_database();

$table = get_called_class()::trait_get_database_table();
$table_field_id = get_called_class()::trait_get_table_field_id();

$grouped_child_ids = [];
$uncached_objects = [];
// fetch uncached objects
foreach (array_chunk($uncached_object_ids, Config::$chunk_size) as $ids) {
$rows = $db->get_all(
'SELECT * FROM ' . $db->quote_identifier($table) . ' WHERE ' . $table_field_id . ' IN ('
. implode(',', array_fill(0, count($ids), '?')) .
') ',
$ids
);

foreach ($rows as $row) {
// get object classname
$classname = get_called_class();
if (isset($classname_field) === true && class_exists($row[$classname_field]) === true) {
$classname = $row[$classname_field];
}

// if class is abstract we skip current iteration, we update it later via get_by_id
if ((new \ReflectionClass($classname))->isAbstract() === true) {
continue;
}

// set object details
$object = new $classname();
$object->id = $row[get_called_class()::trait_get_table_field_id()];
$object->details = $row;

// update uncached objects
$uncached_objects[$object->id] = $object;

// check if child details are available
if (isset($classname_field) === false
|| method_exists($object, 'trait_get_child_details') === false
|| is_callable([ $object, 'trait_get_child_details' ]) === false
) {
continue;
}

$child_classname = $row[$classname_field];
if ($child_classname::trait_get_child_database_table() === null) {
continue;
}

if (isset($grouped_child_ids[$child_classname]) === false) {
$grouped_child_ids[$child_classname] = [];
}

$grouped_child_ids[$child_classname][] = $object->id;
}
}

// fetch child details
foreach ($grouped_child_ids as $child_classname => $parent_ids) {
$table = $child_classname::trait_get_child_database_table();
$table_field_id = $child_classname::trait_get_parent_table_field_id();

foreach (array_chunk($parent_ids, Config::$chunk_size) as $ids) {
$rows = $db->get_all(
'SELECT * FROM ' . $db->quote_identifier($table) . ' WHERE ' . $table_field_id . ' IN ('
. implode(',', array_fill(0, count($ids), '?')) .
') ',
$ids
);

foreach ($rows as $row) {
// get parent id
$id = $row[$child_classname::trait_get_parent_table_field_id()];
if (isset($uncached_objects[$id]) === false) {
throw new \Exception('Could not fetch ' . $table . ' data: none found with id ' . $id);
}

// set child details
$object = $uncached_objects[$id];
$object->child_details = $row;

// update uncached objects with child details
$uncached_objects[$id] = $object;
}
}
}

// Fill in the result with values that could not be obtained from cache
foreach ($result as $id => $value) {
if ($value !== null) {
continue;
}
$result[$id] = self::get_by_id($id);

// if object not in static cache, fetch it
if (isset($uncached_objects[$id]) === false) {
$result[$id] = self::get_by_id($id);
continue;
}

$object = $uncached_objects[$id];
$object->reset_dirty_fields();

$result[$id] = $object;

// cache object if enabled
if (get_called_class()::trait_cache_enabled()) {
get_called_class()::cache_set(get_called_class()::trait_get_cache_key($object), $object);
}
}

// we should reset indexes in case if someone tries to get first element via 0 index
Expand Down
Loading