/usr/share/php/ezc/ConsoleTools/interfaces/dialog.php is in php-zeta-console-tools 1.7-2ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 | <?php
/**
* File containing the ezcConsoleDialog interface.
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
* @package ConsoleTools
* @version //autogen//
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
*/
/**
* Interface that every console dialog class must implement.
*
* Console dialogs can either be used on their own or using the
* {@link ezcConsoleDialogViewer} (recommended). In the dialog viewer, a dialog
* is instanciated and displayed in a loop, until it receives a valid result
* value.
*
* @package ConsoleTools
* @version //autogen//
*/
interface ezcConsoleDialog
{
/**
* Create a new dialog object.
* This method retrieves an ezcConsoleOutput object for printing its
* content. Additionally an instance of ezcConsoleDialogOptions or a derived
* class is received to configure the behaviour of the dialog. Dialog
* implementations may extend ezcConsoleDialogOptions and require an
* instance of their extended class as options.
*
* @param ezcConsoleOutput $output Output object.
* @param ezcConsoleDialogOptions $options Options.
* @return void
*/
// public function __construct( ezcConsoleOutput $output, ezcConsoleDialogOptions $options = null );
/**
* Returns if the dialog retrieved a valid result.
* Typically a dialog is displayed in a loop until he received a valid
* result. What a valid result is, is determined by the dialog itself.
*
* @return bool If a valid result was retrieved.
*/
public function hasValidResult();
/**
* Returns the result retrieved.
* If no valid result was retreived, yet, this method should throw an
* {@link ezcDialogNoValidResultException}. Otherwise this method returns
* the result.
*
* @return mixed The retreived result.
*
* @throws ezcDialogNoValidResultException
* if this method is called without a valid result being retrieved
* by the object. Use {@link hasValidResult()} to avoid this
* exception.
*/
public function getResult();
/**
* Displays the dialog.
* Displays the dialog. Dialogs will most propably block the application until
* the user took some interaction.
*
* @return void
*/
public function display();
/**
* Resets the dialog to its initial state.
* Resets the dialog to its orginal state in respect to its internal
* changes. Note: Any changes you made to the options are kept in tact.
*
* @return void
*/
public function reset();
}
?>
|