[ Index ]

PHP Cross Reference of Drupal 6 (yi-drupal)

title

Body

[close]

/modules/update/ -> update.module (summary)

(no description)

File Size: 626 lines (25 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 includes/install.inc

Defines 18 functions

  update_help()
  update_menu()
  update_theme()
  update_requirements()
  _update_requirement_check()
  update_cron()
  update_form_alter()
  _update_no_data()
  update_get_available()
  update_refresh()
  update_mail()
  _update_message_text()
  _update_project_status_sort()
  _update_cache_set()
  _update_cache_get()
  _update_cache_clear()
  update_flush_caches()
  update_invalidate_cache()

Functions
Functions that are not part of a class:

update_help($path, $arg)   X-Ref
Implementation of hook_help().


update_menu()   X-Ref
Implementation of hook_menu().


update_theme()   X-Ref
Implementation of the hook_theme() registry.


update_requirements($phase)   X-Ref
Implementation of hook_requirements().

return:

_update_requirement_check($project, $type)   X-Ref
Private helper method to fill in the requirements array.

This is shared for both core and contrib to generate the right elements in
the array for hook_requirements().

param: $project
param: $type
return:

update_cron()   X-Ref
Implementation of hook_cron().


update_form_alter(&$form, $form_state, $form_id)   X-Ref
Implementation of hook_form_alter().

Adds a submit handler to the system modules and themes forms, so that if a
site admin saves either form, we invalidate the cache of available updates.


_update_no_data()   X-Ref
Prints a warning message when there is no data about available updates.


update_get_available($refresh = FALSE)   X-Ref
Internal helper to try to get the update information from the cache
if possible, and to refresh the cache when necessary.

In addition to checking the cache lifetime, this function also ensures that
there are no .info files for enabled modules or themes that have a newer
modification timestamp than the last time we checked for available update
data. If any .info file was modified, it almost certainly means a new
version of something was installed. Without fresh available update data,
the logic in update_calculate_project_data() will be wrong and produce
confusing, bogus results.

param: $refresh

update_refresh()   X-Ref
Wrapper to load the include file and then refresh the release data.


update_mail($key, &$message, $params)   X-Ref
Implementation of hook_mail().

Constructs the email notification message when the site is out of date.

param: $key
param: $message
param: $params

_update_message_text($msg_type, $msg_reason, $report_link = FALSE, $language = NULL)   X-Ref
Helper function to return the appropriate message text when the site is out
of date or missing a security update.

These error messages are shared by both update_requirements() for the
site-wide status report at admin/reports/status and in the body of the
notification emails generated by update_cron().

param: $msg_type
param: $msg_reason
param: $report_link
param: $language
return:

_update_project_status_sort($a, $b)   X-Ref
Private sort function to order projects based on their status.


_update_cache_set($cid, $data, $expire)   X-Ref
Store data in the private update status cache table.

Note: this function completely ignores the {cache_update}.headers field
since that is meaningless for the kinds of data we're caching.

param: $cid
param: $data
param: $expire

_update_cache_get($cid)   X-Ref
Retrieve data from the private update status cache table.

param: $cid
return:

_update_cache_clear($cid = NULL)   X-Ref
Invalidates specific cached data relating to update status.

param: $cid

update_flush_caches()   X-Ref
Implementation of hook_flush_caches().

Called from update.php (among others) to flush the caches.
Since we're running update.php, we are likely to install a new version of
something, in which case, we want to check for available update data again.
However, because we have our own caching system, we need to directly clear
the database table ourselves at this point and return nothing, for example,
on sites that use memcache where cache_clear_all() won't know how to purge
this data.

However, we only want to do this from update.php, since otherwise, we'd
lose all the available update data on every cron run. So, we specifically
check if the site is in MAINTENANCE_MODE == 'update' (which indicates
update.php is running, not update module... alas for overloaded names).

update_invalidate_cache()   X-Ref
Invalidates all cached data relating to update status.




Generated: Mon Jul 9 18:01:44 2012 Cross-referenced by PHPXref 0.7