PHP 7.0.6 Released

ncurses_clear

(PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)

ncurses_clearClear screen

Description

bool ncurses_clear ( void )
Warning

This function is EXPERIMENTAL. The behaviour of this function, its name, and surrounding documentation may change without notice in a future release of PHP. This function should be used at your own risk.

Clears the screen completely without setting blanks.

Note: ncurses_clear() clears the screen without setting blanks, which have the current background rendition. To clear screen with blanks, use ncurses_erase().

Return Values

Returns TRUE on success or FALSE on failure.

See Also

User Contributed Notes

areaz at dotgeek org
11 years ago
When your script exits, after ncurses_clear() was called, it could leave your terminal in an inconsistent state.

Therefore, you should call ncurses_savetty() in a constructor and nurses_resetty() in a destructor, to ensure, that your terminal is working fine after your script exits.

Here is an example code snippet, on how to use this function, without falling into trouble ;-)

<? // PHP5 Example

class foo
{
    /* Foo constructor */
    function __construct()
    {
        /* Initialize ncurses first */
        ncurses_init();

        /* Save your tty !!! */
        ncurses_savetty();
    }

    function bar ()
    {
        /* Clear the screen and wait a few seconds */
        ncurses_clear();

        sleep(5);
    }

    /* Foo destructor */
    function __destruct()
    {
        /* Restore your terminal settings */
        ncurses_resetty();

        /* End ncurses and clean up */
        ncurses_end();
    }

}

$test_ncurses = new foo;
$test_ncurses->bar();
?>
To Top