Changelog Class Reference

A class representing a set of changes. More...

Public Member Functions

 Changelog ($since=null, $for_object=null, $attempt_full=false)
 Create an object for all changes in the specified object since $since.
 get_changes ()
 The function that actually retrieves the changes as specified to the constructor.
 get_summary ()
 Return summary information about the changes contained.
 get_users ()
 Returns a list of the users that made changes included in the changes.
 get_other_users ()
 Returns the names of all other users that has changes included in the changes.
 get_change_ids ()
 Return the id of the changes included.
 get_list ()
 Return array representing changes in semi-formal format.
 get_html_list ()
 Returns a detailed html list of the changes represented in here.
 get_text_list ()
 Returns a detailed plaintext list of the changes represented in here.
 get_host_list ()
 Returns list of names, addresses and changes made for hosts.
 count ()
 Implementation of the count interface: the number of "visually distinct" changes.
 delete_changes ()
 Clear the changelog from changes visible to the current user.
 archive_changes ()
 Save the selected changes into changelog_history to be able to track historical changes.
 undo_others_changes (&$overlay, &$out_changed_files)
 Generate an object overlay that contains all differences between the current database state and the state that the user is allowed to export, as well as a list of affected files.
 is_recache_required ()
 Return true if the contact list needs to be recached, otherwise false.

Static Public Member Functions

static get_changes_count ()
 Performs a query on its own since get_changes() is very much coupled with real world usage and this method is stupid.

Detailed Description

A class representing a set of changes.


Member Function Documentation

Changelog::Changelog ( since = null,
for_object = null,
attempt_full = false 
)

Create an object for all changes in the specified object since $since.

If the object isn't specified and the user isn't an admin, get all changes relevant to the current user. If the user is an admin, get all changes period.

Changelog::count (  ) 

Implementation of the count interface: the number of "visually distinct" changes.

Visually distinct changes are

static Changelog::get_changes_count (  )  [static]

Performs a query on its own since get_changes() is very much coupled with real world usage and this method is stupid.

Returns:
int
Changelog::get_summary (  ) 

Return summary information about the changes contained.

Summary is a one line string about the changes done.

Changelog::undo_others_changes ( &$  overlay,
&$  out_changed_files 
)

Generate an object overlay that contains all differences between the current database state and the state that the user is allowed to export, as well as a list of affected files.

We use this overlay on top of the actual database contents when writing objects to disk.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables

Generated on 7 Apr 2014 for nacoma by  doxygen 1.6.1