From bbd13538f85cfa56f160f46a80f98473219cfe37 Mon Sep 17 00:00:00 2001
From: John Bintz <jcoswell@coswellproductions.org>
Date: Sat, 27 Jun 2009 09:14:33 -0400
Subject: [PATCH] start documentation

---
 classes/PluginWonderful.php | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/classes/PluginWonderful.php b/classes/PluginWonderful.php
index 0fdf99f..4d9ab14 100644
--- a/classes/PluginWonderful.php
+++ b/classes/PluginWonderful.php
@@ -8,10 +8,16 @@ class PluginWonderful {
 
   function PluginWonderful() {}
   
+  /**
+   * Wrapper around file_get_contents for testing purposes.
+   */
   function _retrieve_url($url) {
     return @file_get_contents($url);
   }
   
+  /**
+   * Initialize the object if it isn't already.
+   */
   function init() {
     if (empty($this->adboxes_client)) {
       $this->messages = array();
@@ -24,10 +30,16 @@ class PluginWonderful {
     }
   }
 
+  /**
+   * Wrapper around PublisherInfo generation for testing.
+   */
   function _get_new_publisher_info_object() {
     return new PublisherInfo();
   }
 
+  /**
+   * Check to see if the database schema needs to be updated.
+   */
   function _update_database_version() {
     $result = get_option('plugin-wonderful-database-version');
     if (empty($result) || ($result < PLUGIN_WONDERFUL_DATABASE_VERSION)) {
@@ -39,6 +51,10 @@ class PluginWonderful {
     }	
   }
 
+  /**
+   * Get publisher info (adboxes) from cache or from Project Wonderful.
+   * @return PublisherInfo|boolean The PublisherInfo object with adbox information, or false if there was a problem.
+   */
   function _get_publisher_info() {
     $this->publisher_info = false;
     $member_id = get_option('plugin-wonderful-memberid');
@@ -300,4 +316,4 @@ function the_project_wonderful_ad($adboxid) {
   $w->widget(array(), array('adboxid' => $adboxid));
 }
 
-?>
\ No newline at end of file
+?>