Changeset 1122 in subversion


Ignore:
Timestamp:
Feb 20, 2008 10:51:09 AM (5 years ago)
Author:
till
Message:
  • added references to used functions
  • moved comments from the function in the docblock
File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/roundcubemail/bin/quotaimg.php

    r850 r1122  
    11<?php 
    2  
    32/* 
    43 +-----------------------------------------------------------------------+ 
    … …  
    1615 +-----------------------------------------------------------------------+ 
    1716 
    18  $Id:  $ 
     17 $Id: $ 
    1918 
    2019*/ 
    … …  
    2524$height = empty($_GET['h']) ? 14 : (int)$_GET['h']; 
    2625 
     26/** 
     27 * Quota display 
     28 *  
     29 *      Modify the following few elements to change the display of the image. 
     30 *      Modifiable attributes are: 
     31 *      bool    border  ::      Defines whether you want to show a border around it? 
     32 *      bool    unknown ::      Leave default; Defines whether quota is "unknown" 
     33 * 
     34 *      int             height  ::      Defines height of the image 
     35 *      int             width   ::      Defines width of the image 
     36 *      int             font    ::      Changes the font size & font used in the GD library. 
     37 *                                              Available values are from 1 to 5. 
     38 *      int             padding ::      Changes the offset (in pixels) from the top of the image 
     39 *                      to where the top of the text will be aligned. User 
     40 *                      greater than 0 to ensure text is off the border. 
     41 *      array   limit   ::      Holds the integer values of in an associative array as 
     42 *                      to what defines the upper and lower levels for quota 
     43 *                      display. 
     44 *                                              High - Quota is nearing capacity. 
     45 *                                              Mid  - Quota is around the middle 
     46 *                                              Low  - Currently not used. 
     47 *      array   color   ::      An associative array of strings of comma separated 
     48 *                      values (R,G,B) for use in color creation.  Define the 
     49 *                      RGB values you'd like to use. A list of colors (and 
     50 *                      their RGB values) can be found here: 
     51 *                                              http://www.december.com/html/spec/colorcodes.html 
     52 *  
     53 * @return void 
     54 *  
     55 * @param mixed $used   The amount used, or ?? if unknown. 
     56 * @param mixed $total  The total available, or ?? if unknown. 
     57 * @param int   $width  Width of the image. 
     58 * @param int   $height Height of the image. 
     59 *  
     60 * @see rcube_imap::get_quota() 
     61 * @see iil_C_GetQuota() 
     62 */ 
    2763function genQuota($used, $total, $width, $height) 
    2864{ 
    29         /** 
    30          *      Quota Display 
    31          * 
    32          *      Modify the following few elements to change the display of the image. 
    33          *      Modifiable attributes are: 
    34          *      bool    border  ::      Defines whether you want to show a border around it or not. 
    35          *      bool    unknown ::      Leave default; Defines whether quota is "unknown" 
    36          * 
    37          *      int             height  ::      Defines height of the image 
    38          *      int             width   ::      Defines width of the image 
    39          *      int             font    ::      Changes the font size & font used in the GD library. 
    40          *                                              Available values are from 1 to 5. 
    41          *      int             padding ::      Changes the offset (in pixels) from the top of the image to 
    42          *                                              where the top of the text will be aligned.  User greater than 
    43          *                                              0 to ensure text is off the border. 
    44          *      array   limit   ::      Holds the integer values of in an associative array as to what 
    45          *                                              defines the upper and lower levels for quota display. 
    46          *                                              High - Quota is nearing capacity. 
    47          *                                              Mid  - Quota is around the middle 
    48          *                                              Low  - Currently not used. 
    49          *      array   color   ::      An associative array of strings of comma separated values (R,G,B) 
    50          *                                              for use in color creation.  Define the RGB values you'd like to  
    51          *                                              use.  A list of colors (and their RGB values) can be found here: 
    52          *                                              http://www.december.com/html/spec/colorcodes.html 
    53          **/ 
    54  
    5565        $unknown = false; 
    5666        $border = 0; 
    … …  
    7888 
    7989 
    80         /**************************** 
     90        /************************************ 
    8191         *****  DO NOT EDIT BELOW HERE  ***** 
    82          ****************************/ 
     92         ***********************************/ 
    8393 
    8494        if (ereg("^[^0-9?]*$", $used) || ereg("^[^0-9?]*$", $total)) 
Note: See TracChangeset for help on using the changeset viewer.