Class: Theme_Versioning_Revision

Source Location: /theme_revision.php

Class Overview [line 7]


File containing the revision class

Author(s):

  • David Julia

Version:

Copyright:

Variables

Constants

Methods


Inherited Variables

Inherited Constants

Inherited Methods



Class Details

File containing the revision class

Tags:

[ Top ]


Class Variables

$commit_msg = ""

[line 9]

Tags:

  • access - public

Type: mixed

Overrides:

[ Top ]

$files

[line 10]

Tags:

  • access - public

Type: mixed

Overrides:

[ Top ]

$id

[line 11]

Tags:

  • access - public

Type: mixed

Overrides:

[ Top ]

$time_stamp

[line 12]

Tags:

  • access - public

Type: mixed

Overrides:

[ Top ]

$user

[line 13]

Tags:

  • access - public

Type: mixed

Overrides:

[ Top ]


Class Methods

__construct

Theme_Versioning_Revision __construct( $revision_id $revision_id, $commit_message $commit_message, $files_array, $timestamp $user, $timestamp)

[line 22]

Constructor for Theme_Versioning_Revision

Tags:

  • access - public

Parameters:

  • $revision_id $revision_id - the identifier of the revision
  • $commit_message $commit_message - string a string containing the commit message.
  • $file_array $files_array - array A file array in the form file_name => file_contents containing all the files in the revision
  • $timestamp $user - The timestamp of the revision
  • $timestamp -

[ Top ]

get_commit_message

string get_commit_message( )

[line 42]

Tags:

  • return - containing the commit message
  • access - public

Parameters:

[ Top ]

get_files

array get_files( )

[line 51]

Accessor method for the Revision's files

Tags:

  • return - A file array in the form file_name => file_contents containing all the files in the revision
  • access - public

Parameters:

[ Top ]

get_file_contents

a get_file_contents( $file_name)

[line 60]

Get the contents of a specific file within the revision as a string.

Tags:

  • return - string containing the contents of a given file in the revision null if there is no such file in the revision
  • access - public

Parameters:

  • $file_name -

[ Top ]

get_revision_id

a get_revision_id( )

[line 34]

Tags:

  • return - revision identifier. This is not necessarily an int, but could be a string hash or some other arbitrary identifier.
  • access - public

Parameters:

[ Top ]

get_time_stamp

string get_time_stamp( )

[line 80]

Get the timestamp for the revision

Tags:

  • return - a string containing the timestamp for the revision
  • access - public

Parameters:

[ Top ]

get_user

string get_user( )

[line 70]

Get the author of the revision as a string. For the default vcs this is the WordPress user who committed the revision, for other VCS it can be the VCS user who made the revision.

Tags:

  • return - A string containing the author who committed this revision.
  • access - public

Parameters:

[ Top ]


Class Constants


Documentation generated on Fri, 19 Aug 2011 18:08:45 -0600 by phpDocumentor 1.4.3