WordPress.org

Make WordPress Core


Ignore:
Timestamp:
08/14/2008 06:30:38 AM (12 years ago)
Author:
westi
Message:

phpdoc for wp-admin. See #7496 props santosj.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-admin/includes/class-pclzip.php

    r7314 r8645  
    11<?php
    2 // --------------------------------------------------------------------------------
    3 // PhpConcept Library - Zip Module 2.5
    4 // --------------------------------------------------------------------------------
    5 // License GNU/LGPL - Vincent Blavet - March 2006
    6 // http://www.phpconcept.net
    7 // --------------------------------------------------------------------------------
    8 //
    9 // Presentation :
    10 //   PclZip is a PHP library that manage ZIP archives.
    11 //   So far tests show that archives generated by PclZip are readable by
    12 //   WinZip application and other tools.
    13 //
    14 // Description :
    15 //   See readme.txt and http://www.phpconcept.net
    16 //
    17 // Warning :
    18 //   This library and the associated files are non commercial, non professional
    19 //   work.
    20 //   It should not have unexpected results. However if any damage is caused by
    21 //   this software the author can not be responsible.
    22 //   The use of this software is at the risk of the user.
    23 //
    24 // --------------------------------------------------------------------------------
    25 // $Id: pclzip.lib.php,v 1.44 2006/03/08 21:23:59 vblavet Exp $
    26 // --------------------------------------------------------------------------------
    27 
    28   // ----- Constants
    29   define( 'PCLZIP_READ_BLOCK_SIZE', 2048 );
    30 
    31   // ----- File list separator
    32   // In version 1.x of PclZip, the separator for file list is a space
    33   // (which is not a very smart choice, specifically for windows paths !).
    34   // A better separator should be a comma (,). This constant gives you the
    35   // abilty to change that.
    36   // However notice that changing this value, may have impact on existing
    37   // scripts, using space separated filenames.
    38   // Recommanded values for compatibility with older versions :
    39   //define( 'PCLZIP_SEPARATOR', ' ' );
    40   // Recommanded values for smart separation of filenames.
    41   define( 'PCLZIP_SEPARATOR', ',' );
    42 
    43   // ----- Error configuration
    44   // 0 : PclZip Class integrated error handling
    45   // 1 : PclError external library error handling. By enabling this
    46   //     you must ensure that you have included PclError library.
    47   // [2,...] : reserved for futur use
    48   define( 'PCLZIP_ERROR_EXTERNAL', 0 );
     2/**
     3 * PhpConcept Library - Zip Module 2.5
     4 *
     5 * Presentation :
     6 *   PclZip is a PHP library that manage ZIP archives.
     7 *   So far tests show that archives generated by PclZip are readable by
     8 *   WinZip application and other tools.
     9 *
     10 * Warning :
     11 *   This library and the associated files are non commercial, non professional
     12 *   work.
     13 *   It should not have unexpected results. However if any damage is caused by
     14 *   this software the author can not be responsible.
     15 *   The use of this software is at the risk of the user.
     16 *
     17 * @package External
     18 * @subpackage PclZip
     19 *
     20 * @license License GNU/LGPL
     21 * @copyright March 2006 Vincent Blavet
     22 * @author Vincent Blavet
     23 * @link http://www.phpconcept.net
     24 * @version $Id: pclzip.lib.php,v 1.44 2006/03/08 21:23:59 vblavet Exp $
     25 */
     26
     27/**
     28 * The read block size for reading zip files.
     29 *
     30 * @since 2.5
     31 */
     32define( 'PCLZIP_READ_BLOCK_SIZE', 2048 );
     33
     34/**
     35 * File list separator
     36 *
     37 * In version 1.x of PclZip, the separator for file list is a space(which is not
     38 * a very smart choice, specifically for windows paths !). A better separator
     39 * should be a comma (,). This constant gives you the abilty to change that.
     40 *
     41 * However notice that changing this value, may have impact on existing scripts,
     42 * using space separated filenames. Recommanded values for compatibility with
     43 * older versions :
     44 * <code>define( 'PCLZIP_SEPARATOR', ' ' );</code>
     45 * Recommanded values for smart separation of filenames.
     46 */
     47define( 'PCLZIP_SEPARATOR', ',' );
     48
     49/**
     50 * Error configuration
     51 *
     52 * 0 : PclZip Class integrated error handling
     53 * 1 : PclError external library error handling. By enabling this you must
     54 *     ensure that you have included PclError library.
     55 * [2,...] : reserved for future use
     56 */
     57define( 'PCLZIP_ERROR_EXTERNAL', 0 );
    4958
    5059  // ----- Optional static temporary directory
     
    138147  define( 'PCLZIP_CB_PRE_ADD', 78003 );
    139148  define( 'PCLZIP_CB_POST_ADD', 78004 );
    140   /* For futur use
     149  /* For future use
    141150  define( 'PCLZIP_CB_PRE_LIST', 78005 );
    142151  define( 'PCLZIP_CB_POST_LIST', 78006 );
Note: See TracChangeset for help on using the changeset viewer.