Trait Hm_Modules_Queue

Trait that manages queued modules

Direct Known Users

Package: framework\modules
Located at modules.php

Methods summary
`public static`	# `queue_module_for_all_pages( string $module, boolean $logged_in, string $marker, string $placement, string $source )` Queue a module to be added to all defined pages Queue a module to be added to all defined pages Parameters `$module` the module to add `$logged_in` true if the module requires the user to be logged in `$marker` the module to insert before or after `$placement` "before" or "after" the $marker module `$source` the module set containing this module return void
`public static`	# `process_all_page_queue( )` Process queued modules and add them to all pages Process queued modules and add them to all pages
`private static boolean`	# `queue_module( boolean $queue, string $page, string $module, boolean $logged_in, string\|false $marker, string $placement, string $source )` Parameters `$queue` true to attempt to re-insert the module later on failure `$page` the page to assign the module to `$module` the module to add `$logged_in` true if the module requires the user to be logged in `$marker` the module to insert before or after `$placement` "before" or "after" the $marker module `$source` the module set containing this module Returns boolean
`private static`	# `queue_replacement_module( string $target, string $replacement, string $page )` Queue a module replacement for retry Queue a module replacement for retry Parameters `$target` the module to replace `$replacement` the module to replace the target with `$page` the page to do the replacement for
`public static`	# `process_replace_queue( )` Process the replacement queue and try to replace modules Process the replacement queue and try to replace modules
`public static`	# `try_queued_modules( )` Attempt to insert modules that initially failed Attempt to insert modules that initially failed

Properties summary
`private static integer`	`$queue_limit`	# `2`
`private static integer`	`$queue_attempts`	# `0`
`private static array`	`$module_list`	# `array()`
`private static string`	`$source`	# `''`
`private static array`	`$module_queue`	# `array()`
`private static array`	`$all_page_queue`	# `array()`
`private static array`	`$replace_queue`	# `array()`