Move subscribe and unsubscribe forms to their own classes

3 files changed, 234 insertions, 34 deletions

diff --git a/lib/subscribeform.php b/lib/subscribeform.php
new file mode 100644
index 000000000..fccc3d301
--- /dev/null
+++ b/lib/subscribeform.php
@@ -0,0 +1,117 @@
+<?php
+/**
+ * Laconica, the distributed open-source microblogging tool
+ *
+ * Form for subscribing to a user
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  Form
+ * @package   Laconica
+ * @author    Evan Prodromou <evan@controlyourself.ca>
+ * @author    Sarven Capadisli <csarven@controlyourself.ca>
+ * @copyright 2009 Control Yourself, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://laconi.ca/
+ */
+
+if (!defined('LACONICA')) {
+    exit(1);
+}
+
+require_once INSTALLDIR.'/lib/form.php';
+
+/**
+ * Form for subscribing to a user
+ *
+ * @category Form
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @author   Sarven Capadisli <csarven@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://laconi.ca/
+ *
+ * @see      UnsubscribeForm
+ */
+
+class SubscribeForm extends Form
+{
+    /**
+     * Profile of user to nudge
+     */
+
+    var $profile = null;
+
+    /**
+     * Constructor
+     *
+     * @param HTMLOutputter $out     output channel
+     * @param Profile       $profile profile of user to nudge
+     */
+
+    function __construct($out=null, $profile=null)
+    {
+        parent::__construct($out);
+
+        $this->profile = $profile;
+    }
+
+    /**
+     * ID of the form
+     *
+     * @return int ID of the form
+     */
+
+    function id()
+    {
+        return 'subscribe-' . $this->profile->id;
+    }
+
+    /**
+     * Action of the form
+     *
+     * @return string URL of the action
+     */
+
+    function action()
+    {
+        return common_local_url('subscribe');
+    }
+
+    /**
+     * Data elements of the form
+     *
+     * @return void
+     */
+
+    function formData()
+    {
+        $this->out->hidden('subscribeto-' . $this->profile->id,
+                           $this->profile->id,
+                           'subscribeto');
+    }
+
+    /**
+     * Action elements
+     *
+     * @return void
+     */
+
+    function formActions()
+    {
+        $this->out->submit('submit', _('Subscribe'));
+    }
+}
\ No newline at end of file
diff --git a/lib/unsubscribeform.php b/lib/unsubscribeform.php
new file mode 100644
index 000000000..1d4c08a71
--- /dev/null
+++ b/lib/unsubscribeform.php
@@ -0,0 +1,117 @@
+<?php
+/**
+ * Laconica, the distributed open-source microblogging tool
+ *
+ * Form for unsubscribing from a user
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  Form
+ * @package   Laconica
+ * @author    Evan Prodromou <evan@controlyourself.ca>
+ * @author    Sarven Capadisli <csarven@controlyourself.ca>
+ * @copyright 2009 Control Yourself, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://laconi.ca/
+ */
+
+if (!defined('LACONICA')) {
+    exit(1);
+}
+
+require_once INSTALLDIR.'/lib/form.php';
+
+/**
+ * Form for unsubscribing from a user
+ *
+ * @category Form
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @author   Sarven Capadisli <csarven@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://laconi.ca/
+ *
+ * @see      SubscribeForm
+ */
+
+class UnsubscribeForm extends Form
+{
+    /**
+     * Profile of user to nudge
+     */
+
+    var $profile = null;
+
+    /**
+     * Constructor
+     *
+     * @param HTMLOutputter $out     output channel
+     * @param Profile       $profile profile of user to nudge
+     */
+
+    function __construct($out=null, $profile=null)
+    {
+        parent::__construct($out);
+
+        $this->profile = $profile;
+    }
+
+    /**
+     * ID of the form
+     *
+     * @return int ID of the form
+     */
+
+    function id()
+    {
+        return 'unsubscribe-' . $this->profile->id;
+    }
+
+    /**
+     * Action of the form
+     *
+     * @return string URL of the action
+     */
+
+    function action()
+    {
+        return common_local_url('unsubscribe');
+    }
+
+    /**
+     * Data elements of the form
+     *
+     * @return void
+     */
+
+    function formData()
+    {
+        $this->out->hidden('unsubscribeto-' . $this->profile->id,
+                           $this->profile->id,
+                           'unsubscribeto');
+    }
+
+    /**
+     * Action elements
+     *
+     * @return void
+     */
+
+    function formActions()
+    {
+        $this->out->submit('submit', _('Unsubscribe'));
+    }
+}
\ No newline at end of file
diff --git a/lib/util.php b/lib/util.php
index 9dd0ba84d..811c7cdb0 100644
--- a/lib/util.php
+++ b/lib/util.php
@@ -1643,40 +1643,6 @@ function common_nudge_response()
     common_element('p', array('id' => 'nudge_response'), _('Nudge sent!'));
 }
 
-function common_subscribe_form($profile)
-{
-    common_element_start('form', array('id' => 'subscribe-' . $profile->id,
-                                       'method' => 'post',
-                                       'class' => 'subscribe',
-                                       'action' => common_local_url('subscribe')));
-    common_hidden('token', common_session_token());
-    common_element('input', array('id' => 'subscribeto-' . $profile->id,
-                                  'name' => 'subscribeto',
-                                  'type' => 'hidden',
-                                  'value' => $profile->id));
-    common_element('input', array('type' => 'submit',
-                                  'class' => 'submit',
-                                  'value' => _('Subscribe')));
-    common_element_end('form');
-}
-
-function common_unsubscribe_form($profile)
-{
-    common_element_start('form', array('id' => 'unsubscribe-' . $profile->id,
-                                       'method' => 'post',
-                                       'class' => 'unsubscribe',
-                                       'action' => common_local_url('unsubscribe')));
-    common_hidden('token', common_session_token());
-    common_element('input', array('id' => 'unsubscribeto-' . $profile->id,
-                                  'name' => 'unsubscribeto',
-                                  'type' => 'hidden',
-                                  'value' => $profile->id));
-    common_element('input', array('type' => 'submit',
-                                  'class' => 'submit',
-                                  'value' => _('Unsubscribe')));
-    common_element_end('form');
-}
-
 // XXX: Refactor this code
 function common_profile_new_message_nudge ($cur, $profile)
 {