lib/searchform.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Form for searching a StatusNet site
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Widget
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Form for searching a StatusNet site
  39  *
  40  * @category  General
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2011 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47
  48 class SearchForm extends Form
  49 {
  50     /**
  51      * Visible or invisible data elements
  52      *
  53      * Display the form fields that make up the data of the form.
  54      * Sub-classes should overload this to show their data.
  55      *
  56      * @return void
  57      */
  58
  59     function formData()
  60     {
  61         $this->out->element('input', array('name' => 'q',
  62                                            'size' => 20,
  63                                            'id' => 'search-q'));
  64     }
  65
  66     /**
  67      * Buttons for form actions
  68      *
  69      * Submit and cancel buttons (or whatever)
  70      * Sub-classes should overload this to show their own buttons.
  71      *
  72      * @return void
  73      */
  74
  75     function formActions()
  76     {
  77         $this->out->element('input', array('type' => 'submit',
  78                                            'value' => _('Search')));
  79     }
  80
  81     /**
  82      * ID of the form
  83      *
  84      * Should be unique on the page. Sub-classes should overload this
  85      * to show their own IDs.
  86      *
  87      * @return int ID of the form
  88      */
  89
  90     function id()
  91     {
  92         return 'search';
  93     }
  94
  95     /**
  96      * Action of the form.
  97      *
  98      * URL to post to. Should be overloaded by subclasses to give
  99      * somewhere to post to.
 100      *
 101      * @return string URL to post to
 102      */
 103
 104     function action()
 105     {
 106         return common_local_url('noticesearch');
 107     }
 108
 109     function method()
 110     {
 111         return 'get';
 112     }
 113
 114     function sessionToken()
 115     {
 116         return;
 117     }
 118 }