Apache Zeta Components Manual :: File Source for input_validator.php

Source for file input_validator.php

Documentation is available at input_validator.php

  1. <?php
  2. /**
  3.  * File containing the ezcConsoleInputValidator interface.
  4.  *
  5.  * Licensed to the Apache Software Foundation (ASF) under one
  6.  * or more contributor license agreements.  See the NOTICE file
  7.  * distributed with this work for additional information
  8.  * regarding copyright ownership.  The ASF licenses this file
  9.  * to you under the Apache License, Version 2.0 (the
  10.  * "License"); you may not use this file except in compliance
  11.  * with the License.  You may obtain a copy of the License at
  12.  * 
  13.  *   http://www.apache.org/licenses/LICENSE-2.0
  14.  * 
  15.  * Unless required by applicable law or agreed to in writing,
  16.  * software distributed under the License is distributed on an
  17.  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  18.  * KIND, either express or implied.  See the License for the
  19.  * specific language governing permissions and limitations
  20.  * under the License.
  21.  *
  22.  * @package ConsoleTools
  23.  * @version //autogentag//
  24.  * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
  25.  * @filesource
  26.  */
  27. /**
  28.  * Interface for input validators used in ezcConsoleInput.
  29.  *
  30.  * An instance of this interface is used in {@link ezcConsoleInput} to validate
  31.  * options and arguments.
  32.  * 
  33.  * @package ConsoleTools
  34.  * @version //autogen//
  35.  *
  36.  * @access private
  37.  * @TODO Verify interface and make it public to replace the validation in
  38.  *        {@link ezcConsoleInput}.
  39.  */
  40. interface ezcConsoleInputValidator
  41. {
  42.     /**
  43.      * Validates the given options.
  44.      *
  45.      * May throw an exception that derives from {@link ezcConsoleException}.
  46.      * Receives the array of $options defined for validation and $hasArguments
  47.      * to indicates if arguments have been submitted in addition.
  48.      *
  49.      * @param array(ezcConsoleOption) $options 
  50.      * @param bool $hasArguments 
  51.      */
  52.     public function validateOptionsarray $options$hasArguments );
  53.  
  54.     // @TODO: validateArguments();
  55. }
  56.  
  57. ?>
Documentation generated by phpDocumentor 1.4.3