From a6d97f8ba7b800c895fa7136c082cd47a4b735f5 Mon Sep 17 00:00:00 2001
From: Matthias Pfefferle <pfefferle@gmail.com>
Date: Sun, 24 Feb 2019 13:01:28 +0100
Subject: [PATCH] (php)doc

---
 activitypub.php                   |  3 ++-
 includes/class-activity.php       |  2 ++
 includes/class-activitypub.php    |  3 +++
 includes/class-admin.php          |  5 +++++
 includes/class-hashtag.php        |  5 +++++
 includes/class-post.php           |  2 +-
 includes/class-signature.php      |  5 +++++
 includes/db/class-followers.php   |  5 +++++
 includes/rest/class-followers.php | 10 ++++++++++
 includes/rest/class-inbox.php     |  7 ++++++-
 includes/rest/class-nodeinfo.php  | 10 ++++++++++
 includes/rest/class-outbox.php    |  8 ++++----
 includes/rest/class-webfinger.php | 10 ++++++++++
 readme.txt                        |  5 +++++
 14 files changed, 73 insertions(+), 7 deletions(-)

diff --git a/activitypub.php b/activitypub.php
index a6487ab..ffaaa38 100644
--- a/activitypub.php
+++ b/activitypub.php
@@ -8,6 +8,7 @@
  * Author URI: https://notiz.blog/
  * License: MIT
  * License URI: http://opensource.org/licenses/MIT
+ * Requires PHP: 5.6
  * Text Domain: activitypub
  * Domain Path: /languages
  */
@@ -15,7 +16,7 @@
 namespace Activitypub;
 
 /**
- * Initialize pluginut
+ * Initialize plugin
  */
 function init() {
 	defined( 'ACTIVITYPUB_HASHTAGS_REGEXP' ) || define( 'ACTIVITYPUB_HASHTAGS_REGEXP', '(^|\s|>)#([^\s<>]+)\b' );
diff --git a/includes/class-activity.php b/includes/class-activity.php
index 190dd96..354159d 100644
--- a/includes/class-activity.php
+++ b/includes/class-activity.php
@@ -5,6 +5,8 @@ namespace Activitypub;
  * ActivityPub Post Class
  *
  * @author Matthias Pfefferle
+ *
+ * @see https://www.w3.org/TR/activitypub/
  */
 class Activity {
 	private $context = array( 'https://www.w3.org/ns/activitystreams' );
diff --git a/includes/class-activitypub.php b/includes/class-activitypub.php
index 5812aec..7bf9fab 100644
--- a/includes/class-activitypub.php
+++ b/includes/class-activitypub.php
@@ -7,6 +7,9 @@ namespace Activitypub;
  * @author Matthias Pfefferle
  */
 class Activitypub {
+	/**
+	 * Initialize the class, registering WordPress hooks
+	 */
 	public static function init() {
 		add_filter( 'template_include', array( '\Activitypub\Activitypub', 'render_json_template' ), 99 );
 		add_filter( 'query_vars', array( '\Activitypub\Activitypub', 'add_query_vars' ) );
diff --git a/includes/class-admin.php b/includes/class-admin.php
index 8c39061..ba3b55b 100644
--- a/includes/class-admin.php
+++ b/includes/class-admin.php
@@ -3,8 +3,13 @@ namespace Activitypub;
 
 /**
  * ActivityPub Admin Class
+ *
+ * @author Matthias Pfefferle
  */
 class Admin {
+	/**
+	 * Initialize the class, registering WordPress hooks
+	 */
 	public static function init() {
 		add_action( 'admin_menu', array( '\Activitypub\Admin', 'admin_menu' ) );
 		add_action( 'admin_init', array( '\Activitypub\Admin', 'register_settings' ) );
diff --git a/includes/class-hashtag.php b/includes/class-hashtag.php
index 042f478..dc7db0d 100644
--- a/includes/class-hashtag.php
+++ b/includes/class-hashtag.php
@@ -3,8 +3,13 @@ namespace Activitypub;
 
 /**
  * ActivityPub Hashtag Class
+ *
+ * @author Matthias Pfefferle
  */
 class Hashtag {
+	/**
+	 * Initialize the class, registering WordPress hooks
+	 */
 	public static function init() {
 		add_filter( 'wp_insert_post', array( '\Activitypub\Hashtag', 'insert_post' ), 99, 2 );
 		add_filter( 'the_content', array( '\Activitypub\Hashtag', 'the_content' ), 99, 2 );
diff --git a/includes/class-post.php b/includes/class-post.php
index 2431c5e..51f3958 100644
--- a/includes/class-post.php
+++ b/includes/class-post.php
@@ -10,7 +10,7 @@ class Post {
 	private $post;
 
 	/**
-	 *
+	 * Initialize the class, registering WordPress hooks
 	 */
 	public static function init() {
 		add_filter( 'activitypub_the_summary', array( '\Activitypub\Post', 'add_backlink' ), 10, 2 );
diff --git a/includes/class-signature.php b/includes/class-signature.php
index 68ae556..867d765 100644
--- a/includes/class-signature.php
+++ b/includes/class-signature.php
@@ -1,6 +1,11 @@
 <?php
 namespace Activitypub;
 
+/**
+ * ActivityPub Signature Class
+ *
+ * @author Matthias Pfefferle
+ */
 class Signature {
 
 	/**
diff --git a/includes/db/class-followers.php b/includes/db/class-followers.php
index f3bbc4e..5c9545c 100644
--- a/includes/db/class-followers.php
+++ b/includes/db/class-followers.php
@@ -1,6 +1,11 @@
 <?php
 namespace Activitypub\Db;
 
+/**
+ * ActivityPub Followers DB-Class
+ *
+ * @author Matthias Pfefferle
+ */
 class Followers {
 
 	public static function get_followers( $author_id ) {
diff --git a/includes/rest/class-followers.php b/includes/rest/class-followers.php
index b7fdb97..8826285 100644
--- a/includes/rest/class-followers.php
+++ b/includes/rest/class-followers.php
@@ -1,7 +1,17 @@
 <?php
 namespace Activitypub\Rest;
 
+/**
+ * ActivityPub Followers REST-Class
+ *
+ * @author Matthias Pfefferle
+ *
+ * @see https://www.w3.org/TR/activitypub/#followers
+ */
 class Followers {
+	/**
+	 * Initialize the class, registering WordPress hooks
+	 */
 	public static function init() {
 		add_action( 'rest_api_init', array( '\Activitypub\Rest\Followers', 'register_routes' ) );
 	}
diff --git a/includes/rest/class-inbox.php b/includes/rest/class-inbox.php
index 89cf6b8..1083ff1 100644
--- a/includes/rest/class-inbox.php
+++ b/includes/rest/class-inbox.php
@@ -2,11 +2,16 @@
 namespace Activitypub\Rest;
 
 /**
- * ActivityPub Inbox Class
+ * ActivityPub Inbox REST-Class
  *
  * @author Matthias Pfefferle
+ *
+ * @see https://www.w3.org/TR/activitypub/#inbox
  */
 class Inbox {
+	/**
+	 * Initialize the class, registering WordPress hooks
+	 */
 	public static function init() {
 		add_action( 'rest_api_init', array( '\Activitypub\Rest\Inbox', 'register_routes' ) );
 		//add_filter( 'rest_pre_serve_request', array( '\Activitypub\Rest\Inbox', 'serve_request' ), 11, 4 );
diff --git a/includes/rest/class-nodeinfo.php b/includes/rest/class-nodeinfo.php
index e63aace..179d1f3 100644
--- a/includes/rest/class-nodeinfo.php
+++ b/includes/rest/class-nodeinfo.php
@@ -1,7 +1,17 @@
 <?php
 namespace Activitypub\Rest;
 
+/**
+ * ActivityPub NodeInfo REST-Class
+ *
+ * @author Matthias Pfefferle
+ *
+ * @see http://nodeinfo.diaspora.software/
+ */
 class Nodeinfo {
+	/**
+	 * Initialize the class, registering WordPress hooks
+	 */
 	public static function init() {
 		add_action( 'rest_api_init', array( '\Activitypub\Rest\Nodeinfo', 'register_routes' ) );
 		add_filter( 'nodeinfo_data', array( '\Activitypub\Rest\Nodeinfo', 'add_nodeinfo_discovery' ), 10, 2 );
diff --git a/includes/rest/class-outbox.php b/includes/rest/class-outbox.php
index 42c18ed..06f4d56 100644
--- a/includes/rest/class-outbox.php
+++ b/includes/rest/class-outbox.php
@@ -2,15 +2,15 @@
 namespace Activitypub\Rest;
 
 /**
- * ActivityPub Outbox Class
+ * ActivityPub Outbox REST-Class
  *
  * @author Matthias Pfefferle
+ *
+ * @see https://www.w3.org/TR/activitypub/#outbox
  */
 class Outbox {
 	/**
-	 * Undocumented function
-	 *
-	 * @return void
+	 * Initialize the class, registering WordPress hooks
 	 */
 	public static function init() {
 		add_action( 'rest_api_init', array( '\Activitypub\Rest\Outbox', 'register_routes' ) );
diff --git a/includes/rest/class-webfinger.php b/includes/rest/class-webfinger.php
index a3d13b0..e78b3eb 100644
--- a/includes/rest/class-webfinger.php
+++ b/includes/rest/class-webfinger.php
@@ -1,7 +1,17 @@
 <?php
 namespace Activitypub\Rest;
 
+/**
+ * ActivityPub WebFinger REST-Class
+ *
+ * @author Matthias Pfefferle
+ *
+ * @see https://webfinger.net/
+ */
 class Webfinger {
+	/**
+	 * Initialize the class, registering WordPress hooks
+	 */
 	public static function init() {
 		add_action( 'rest_api_init', array( '\Activitypub\Rest\Webfinger', 'register_routes' ) );
 		add_action( 'webfinger_user_data', array( '\Activitypub\Rest\Webfinger', 'add_webfinger_discovery' ), 10, 3 );
diff --git a/readme.txt b/readme.txt
index 11ed2b3..ea2a4b1 100644
--- a/readme.txt
+++ b/readme.txt
@@ -55,6 +55,11 @@ To implement:
 
 Project maintained on github at [pfefferle/wordpress-activitypub](https://github.com/pfefferle/wordpress-activitypub).
 
+= 0.5.0 =
+
+* complete refactoring
+* fixed bug #30: Password-protected posts are federated.
+
 = 0.4.4 =
 
 * show avatars