html
[ class tree: html ] [ index: html ] [ all elements ]
Packages:
core
communication
databases
data_structures
filesystem
forms
GilliGan
html
Services_JSON

Source for file AlphabetFilter.class.php

Documentation is available at AlphabetFilter.class.php

  1. <?php
  2. /**
  3.  * For including this file you have to define the constant "CLASSPATH".
  4.  * Because every include in the framework depends on the CLASSPATH definition.
  5.  * The CLASSPATH means the relative path to the folder that contains the
  6.  * framework GilliGan.
  7.  *
  8.  * @package    html
  9.  * @subpackage components
  10.  */
  11. if( !defined( "CLASSPATH" ) )
  12. {
  13.   echo "<h3>You have to define the constant CLASSPATH!</h3>\n";
  14.   echo "Example: define( 'CLASSPATH', '../path/to/classes/' );\n";
  15.   exit();
  16. }
  17.  
  18. /**
  19.  *
  20.  */
  21. require_once( CLASSPATH."html/components/WebsiteNavigation.class.php" );
  22.  
  23. /**
  24.  * A class to generate a albabethical list to use as Filter for several data.
  25.  *
  26.  * @package    html
  27.  * @subpackage components
  28.  * @version    0.1.1
  29.  * @author     Daniel Plücken <daniel@debakel.net>
  30.  * @license    http://www.gnu.org/copyleft/lesser.html
  31.  *              GNU Lesser General Public License
  32.  * @copyright  Copyright (c) 2005 Daniel Plücken <daniel@debakel.net>
  33.  *
  34.  *  This library is free software; you can redistribute it and/or
  35.  *  modify it under the terms of the GNU Lesser General Public
  36.  *  License as published by the Free Software Foundation; either
  37.  *  version 2.1 of the License.
  38.  *
  39.  *  This library is distributed in the hope that it will be useful,
  40.  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  41.  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  42.  *  GNU Lesser General Public License for more details.
  43.  *
  44.  *  You should have received a copy of the GNU Lesser General
  45.  *  Public License along with this library; if not, write to the
  46.  *  Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  47.  *  Boston, MA 02111-1307 USA
  48.  */
  49.  
  50. class AlphabetFilter extends WebsiteNavigation
  51. {
  52.    /**
  53.     * @access public
  54.     * @var    string $str_alphabet 
  55.     */
  56.    var $str_alphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
  57.    /**
  58.     * @access public
  59.     * @var    string $str_href 
  60.     */
  61.    var $str_href = "";
  62.    /**
  63.     * @access public
  64.     * @var    string $str_before_each_Label 
  65.     */
  66.    var $str_before_each_Label = "";
  67.    /**
  68.     * @access public
  69.     * @var    string $str_behind_each_Label 
  70.     */
  71.    var $str_behind_each_Label = "";
  72.    
  73.    /**
  74.     * Constructor.
  75.     * 
  76.     * @version 1.0
  77.     * @since   0.1.0
  78.     * @author  Daniel Plücken <daniel@debakel.net>
  79.     * @access  public
  80.     * @param   $str_href     The hyper reference that should use on click on the
  81.     *                         list item. Place the string "[value]" where you
  82.     *                         want that the alphabetical char from the label of
  83.     *                         the list item should appear.
  84.     * @param   $str_alphabet 
  85.     */
  86.     function AlphabetFilter(
  87.                  $str_href,
  88.                  $str_selected_value,
  89.                  $str_alphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"
  90.                            )
  91.     {
  92.       $this->str_href = $str_href;
  93.       $this->str_alphabet = $str_alphabet;
  94.     }
  95.  
  96.  
  97.  
  98.    /**
  99.     * Sets the string that should concate in front of the label string.
  100.     *
  101.     * @version 1.0
  102.     * @since   0.1.1
  103.     * @author  Daniel Plücken <daniel@debakel.net>
  104.     * @access  public
  105.     * @param   string $str_before 
  106.     * @return  void 
  107.     */
  108.    function setStringBeforeLabel( $str_before )
  109.    { $this->str_before_each_Label = $str_before; }
  110.  
  111.  
  112.  
  113.    /**
  114.     * Sets the string that should concate behind  the label string.
  115.     *
  116.     * @version 1.0
  117.     * @since   0.1.1
  118.     * @author  Daniel Plücken <daniel@debakel.net>
  119.     * @access  public
  120.     * @param   string $str_before 
  121.     * @return  void 
  122.     */
  123.    function setStringBehindLabel( $str_behind )
  124.    { $this->str_behind_each_Label = $str_behind; }
  125.  
  126.  
  127.  
  128.    /**
  129.     * Sets the style of the a list item identified by his given value.
  130.     *
  131.     * @version 1.0
  132.     * @since   0.1.1
  133.     * @author  Daniel Plücken <daniel@debakel.net>
  134.     * @access  public
  135.     * @param   string $str_value 
  136.     * @param   string $str_style_class 
  137.     * @param   string $str_link_style_class 
  138.     * @param   string $str_freestyle 
  139.     * @param   string $str_link_freestyle 
  140.     * @return  void 
  141.     */
  142.    function setMarkedValue(
  143.                             $str_value,
  144.                             $str_style_class = "",
  145.                             $str_link_style_class = "",
  146.                             $str_freestyle = "",
  147.                             $str_link_freestyle = ""
  148.                           )
  149.    {
  150.       $this->build();
  151.       parent::setMarkedValue(
  152.                               $str_value,
  153.                               $str_style_class,
  154.                               $str_link_style_class,
  155.                               $str_freestyle,
  156.                               $str_link_freestyle
  157.                             );
  158.    }
  159.    
  160.  
  161.  
  162.    /**
  163.     * Builds the alphabetic list.
  164.     *
  165.     * @version 1.0
  166.     * @since   0.1.1
  167.     * @author  Daniel Plücken <daniel@debakel.net>
  168.     * @access  public
  169.     * @param   string $str_before 
  170.     * @return  void 
  171.     */
  172.    function build()
  173.    {
  174.        static $already_build = false;
  175.        
  176.        if ( $already_build )
  177.           return;
  178.        
  179.        for ( $i = 0; $i < strlen( $this->str_alphabet ); $i++ )
  180.        {
  181.            if ( $this->str_alphabet[$i] == " " )
  182.               $str_label = "&nbsp;";
  183.            else
  184.               $str_label = htmlentities( $this->str_alphabet[$i] );
  185.            
  186.            $this->addElement(
  187.                        $this->str_before_each_Label
  188.                       .$str_label
  189.                       .$this->str_behind_each_Label,
  190.                        $this->str_href,
  191.                        $this->str_alphabet[$i]
  192.                             );
  193.        }
  194.        
  195.        $already_build = true;
  196.    }
  197.    
  198.  
  199.  
  200.  
  201.    /**
  202.     * Returns a generated string based on the attributes of this HTML-Object.
  203.     *
  204.     * @version 1.1
  205.     * @since   0.1.0
  206.     * @author  Daniel Plücken <daniel@debakel.net>
  207.     * @access  public
  208.     * @return  string 
  209.     */
  210.     function get()
  211.     {
  212.        $this->build();
  213.        
  214.        return parent::get();
  215.     }
  216. } // End of class AlphabetFilter
  217. ?>
Documentation generated on Thu, 05 Jun 2008 19:10:05 +0200 by phpDocumentor 1.4.1