X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=lib%2Fsettingsaction.php;h=fd4885c830223072a9421435def6fb756b448613;hb=fe6498e7c875f5b386a9c7d2cc1fba5677daae09;hp=0e39a7459763e8e366c8fd2e5ee65c2f3c6ca94e;hpb=038f762bce95323ac929b0635cceb7f9425527ec;p=quix0rs-gnu-social.git

diff --git a/lib/settingsaction.php b/lib/settingsaction.php
index 0e39a74597..fd4885c830 100644
--- a/lib/settingsaction.php
+++ b/lib/settingsaction.php
@@ -1,9 +1,12 @@
 <?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * StatusNet, the distributed open-source microblogging tool
  *
- * This program is free software: you can redistribute it and/or modify
+ * Base class for settings actions
+ *
+ * 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.
@@ -15,105 +18,164 @@
  *
  * 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  Settings
+ * @package   StatusNet
+ * @author    Evan Prodromou <evan@status.net>
+ * @copyright 2008-2009 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://status.net/
+ */
+
+if (!defined('STATUSNET') && !defined('LACONICA')) {
+    exit(1);
+}
+
+/**
+ * Base class for settings group of actions
+ *
+ * @category Settings
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://status.net/
+ *
+ * @see      Widget
  */
 
-if (!defined('LACONICA')) { exit(1); }
+class SettingsAction extends Action
+{
+    /**
+     * A message for the user.
+     */
+
+    var $msg = null;
+
+    /**
+     * Whether the message is a good one or a bad one.
+     */
 
-class SettingsAction extends Action {
+    var $success = false;
 
-	function is_readonly() {
-		return false;
-	}
+    /**
+     * Handle input and output a page
+     *
+     * @param array $args $_REQUEST arguments
+     *
+     * @return void
+     */
 
-    function handle($args) {
+    function handle($args)
+    {
         parent::handle($args);
         if (!common_logged_in()) {
-            common_user_error(_('Not logged in.'));
-            return;
+            // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
+            $this->clientError(_('Not logged in.'));
         } else if (!common_is_real_login()) {
-        	# Cookie theft means that automatic logins can't
-        	# change important settings or see private info, and
-        	# _all_ our settings are important
-            common_set_returnto($this->self_url());
-            common_redirect(common_local_url('login'));
+            // Cookie theft means that automatic logins can't
+            // change important settings or see private info, and
+            // _all_ our settings are important
+            common_set_returnto($this->selfUrl());
+            $user = common_current_user();
+            if (Event::handle('RedirectToLogin', array($this, $user))) {
+                common_redirect(common_local_url('login'), 303);
+            }
         } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-            $this->handle_post();
+            $this->handlePost();
         } else {
-            $this->show_form();
+            $this->showForm();
         }
     }
 
-    # override!
-    function handle_post() {
+    /**
+     * Handle a POST request
+     *
+     * @return boolean success flag
+     */
+
+    function handlePost()
+    {
         return false;
     }
 
-    function show_form($msg=NULL, $success=false) {
-        return false;
+    /**
+     * show the settings form
+     *
+     * @param string $msg     an extra message for the user
+     * @param string $success good message or bad message?
+     *
+     * @return void
+     */
+
+    function showForm($msg=null, $success=false)
+    {
+        $this->msg     = $msg;
+        $this->success = $success;
+
+        $this->showPage();
     }
 
-    function message($msg, $success) {
-        if ($msg) {
-            common_element('div', ($success) ? 'success' : 'error',
-                           $msg);
+    /**
+     * show human-readable instructions for the page
+     *
+     * @return void
+     */
+
+    function showPageNotice()
+    {
+        if ($this->msg) {
+            $this->element('div', ($this->success) ? 'success' : 'error',
+                           $this->msg);
+        } else {
+            $inst   = $this->getInstructions();
+            $output = common_markup_to_html($inst);
+
+            $this->elementStart('div', 'instructions');
+            $this->raw($output);
+            $this->elementEnd('div');
         }
     }
 
-	function form_header($title, $msg=NULL, $success=false) {
-		common_show_header($title,
-		                   NULL,
-		                   array($msg, $success),
-						   array($this, 'show_top'));
-	}
-
-	function show_top($arr) {
-		$msg = $arr[0];
-		$success = $arr[1];
-		if ($msg) {
-			$this->message($msg, $success);
-		} else {
-			$inst = $this->get_instructions();
-			$output = common_markup_to_html($inst);
-			common_element_start('div', 'instructions');
-			common_raw($output);
-			common_element_end('div');
-		}
-		$this->settings_menu();
-	}
-
-    function settings_menu() {
-        # action => array('prompt', 'title')
-        static $menu =
-        array('profilesettings' =>
-              array('Profile',
-              		'Change your profile settings'),
-            'emailsettings' =>
-            array('Email',
-                  'Change email handling'),
-            'avatar' =>
-            array('Avatar',
-                  'Upload a new profile image'),
-            'password' =>
-            array('Password',
-                  'Change your password'),
-            'openidsettings' =>
-            array('OpenID',
-                  'Add or remove OpenIDs'),
-            'smssettings' =>
-            array('SMS',
-                  'Updates by SMS'),
-            'imsettings' =>
-            array('IM',
-                  'Updates by instant messenger (IM)'));
-
-        $action = $this->trimmed('action');
-        common_element_start('ul', array('id' => 'nav_views'));
-        foreach ($menu as $menuaction => $menudesc) {
-            common_menu_item(common_local_url($menuaction),
-                    _($menudesc[0]),
-                    _($menudesc[1]),
-                    $action == $menuaction);
-        }
-        common_element_end('ul');
+    /**
+     * instructions recipe for sub-classes
+     *
+     * Subclasses should override this to return readable instructions. They'll
+     * be processed by common_markup_to_html().
+     *
+     * @return string instructions text
+     */
+
+    function getInstructions()
+    {
+        return '';
+    }
+
+    /**
+     * Show the local navigation menu
+     *
+     * This is the same for all settings, so we show it here.
+     *
+     * @return void
+     */
+
+    function showLocalNav()
+    {
+        $menu = new SettingsNav($this);
+        $menu->show();
+    }
+
+    /**
+     * Show notice form.
+     *
+     * @return nothing
+     */
+
+    function showNoticeForm()
+    {
+        return;
+    }
+
+    function showProfileBlock()
+    {
     }
 }