Documentation TYPO3 par Ameos

Disponible dans d'autres versions de TYPO3 -> 3.7.0  3.8.1  4.0.0  4.0.1  4.1.0   <- Available in other TYPO3 versions

class.t3lib_cli.php

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2006 Kasper Skaarhoj (kasperYYYY@typo3.com)
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
class t3lib_cli {

        var $cli_args = array();                        // Command line arguments, exploded into key => value-array pairs
        var $cli_options = array(
                array('-s','Silent operation, will only output errors and important messages.'),
                array('--silent','Same as -s'),
                array('-ss','Super silent, will not even output errors or important messages.'),
        );
        var $cli_help = array(
                        'name' => 'CLI base class (overwrite this...)',
                        'synopsis' => '###OPTIONS###',
                        'description' => 'Class with basic functionality for CLI scripts (overwrite this...)',
                        'examples' => 'Give examples...',
                        'options' => '',
                        'license' => 'GNU GPL - free software!',
                        'author' => '[Author name]',
                );
        var $stdin = NULL;      


        function t3lib_cli()    {
                        // Loads the cli_args array with command line arguments
                $this->cli_args = $this->cli_getArgIndex();
        }

        function cli_getArgArray($option,$argv) {
                while (count($argv) && strcmp($argv[0],$option))        {
                        array_shift($argv);
                }

                if (!strcmp($argv[0],$option))  {
                        array_shift($argv);
                        return count($argv) ? $argv : array('');
                }
        }

        function cli_isArg($option)     {
                return isset($this->cli_args[$option]);
        }

        function cli_argValue($option,$idx=0)   {
                return is_array($this->cli_args[$option]) ? $this->cli_args[$option][$idx] : '';
        }

        function cli_getArgIndex()      {
                $cli_options = array();
                $index = '_DEFAULT';
                foreach($_SERVER['argv'] as $token)     {
                        if ($token{0}==='-')    {
                                list($index,$opt) = explode('=',$token,2);
                                if (isset($cli_options[$index]))        {
                                        echo 'ERROR: Option '.$index.' was used twice!'.chr(10);
                                        exit;
                                }
                                $cli_options[$index] = array();
                                if (isset($opt))        {
                                        $cli_options[$index][] = $opt;
                                }
                        } else {
                                $cli_options[$index][] = $token;
                        }
                }
                return $cli_options;
        }
        
        function cli_validateArgs() {
                $cli_args_copy = $this->cli_args;
                unset($cli_args_copy['_DEFAULT']);
                $allOptions = array();

                foreach($this->cli_options as $cfg)     {
                        $allOptions[] = $cfg[0];
                        $argSplit = t3lib_div::trimExplode(' ',$cfg[0],1);
                        if (isset($cli_args_copy[$argSplit[0]]))        {

                                foreach($argSplit as $i => $v)  {
                                        $ii=$i;
                                        if ($i>0)       {
                                                if (!isset($cli_args_copy[$argSplit[0]][$i-1])) {
                                                        echo 'ERROR: Option "'.$argSplit[0].'" requires a value ("'.$v.'") on position '.$i.chr(10);
                                                        exit;
                                                }
                                        }
                                }

                                $ii++;
                                if (isset($cli_args_copy[$argSplit[0]][$ii-1])) {
                                        echo 'ERROR: Option "'.$argSplit[0].'" does not support a value on position '.$ii.chr(10);
                                        exit;
                                }
                                
                                unset($cli_args_copy[$argSplit[0]]);
                        }
                }
                
                if (count($cli_args_copy))      {
                        echo wordwrap('ERROR: Option '.implode(',',array_keys($cli_args_copy)).' was unknown to this script!'.chr(10).'(Options are: '.implode(', ',$allOptions).')'.chr(10));
                        exit;
                }
        }

        function cli_keyboardInput()    {
                
                        // Have to open the stdin stream only ONCE! otherwise I cannot read multiple lines from it... :
                if (!$this->stdin)      {
                        $this->stdin = fopen('php://stdin', 'r');
                }
                
                while (FALSE == ($line = fgets($this->stdin,1000)))     {}

                return trim($line);
        }

        function cli_keyboardInput_yes($msg='') {
                echo $msg.' (Yes/No + return): ';       // ONLY makes sense to echo it out since we are awaiting keyboard input - that cannot be silenced...
                return t3lib_div::inList('y,yes',strtolower($this->cli_keyboardInput()));
        }

        function cli_echo($string='',$force=FALSE)      {
                if (isset($this->cli_args['-ss'])) {
                        // Nothing to do...
                } elseif (isset($this->cli_args['-s']) || isset($this->cli_args['--silent'])) {
                        if ($force)     { echo $string; return TRUE; }
                } else { echo $string; return TRUE; }

                return FALSE;
        }

        function cli_help()     {
                foreach($this->cli_help as $key => $value)      {
                        $this->cli_echo(strtoupper($key).":\n");
                        switch($key) {
                                case 'synopsis':
                                        $optStr = '';
                                        foreach ($this->cli_options as $v)      {
                                                $optStr.=' ['.$v[0].']';
                                        }
                                        $this->cli_echo($this->cli_indent(str_replace('###OPTIONS###',trim($optStr),$value),4)."\n\n");
                                break;
                                case 'options':
                                        $this->cli_echo($this->cli_indent($value,4)."\n");

                                        $maxLen = 0;
                                        foreach ($this->cli_options as $v)      {
                                                if (strlen($v[0])>$maxLen)      $maxLen=strlen($v[0]);
                                        }

                                        foreach ($this->cli_options as $v)      {
                                                $this->cli_echo($v[0].substr($this->cli_indent(rtrim($v[1].chr(10).$v[2]),$maxLen+4),strlen($v[0]))."\n");
                                        }
                                        $this->cli_echo("\n");
                                break;
                                default:
                                        $this->cli_echo($this->cli_indent($value,4)."\n\n");
                                break;
                        }
                }
        }

        function cli_indent($str,$indent)       {
                $lines = explode(chr(10),wordwrap($str,75-$indent));
                $indentStr = str_pad('',$indent,' ');
                foreach($lines as $k => $v)     {
                        $lines[$k] = $indentStr.$lines[$k];
                }
                return implode(chr(10),$lines);
        }
}

?>

---