declare

(PHP 4, PHP 5)

Конструкция declare используется для установки директив исполнения для блока кода. Синтаксис declare схож с синтаксисом других конструкций управления исполнением:

declare (directive)
    statement

Секция directive позволяет установить поведение блока declare. В настоящее время распознаются только две директивы: директива ticks (Дополнительная информация о директиве ticks доступна ниже) и директива encoding (Дополнительная информация о директиве encoding доступна ниже).

Замечание: Директива encoding была добавлена в PHP 5.3.0

Часть statement блока declare будет исполнена - как исполняется и какие сторониие эффекты возникают в процессе исполнения может зависеть от набора директив в блоке directive.

Конструкция declare может так же быть использована в глобальной области видимости, влияя на весь следующий за ней код (однако если файл с declare был включен, тогда он не имеет воздействия на родительский файл).

<?php
// выполняется одинаково:

// можно так:
declare(ticks=1) {
    
// прочие действия
}

// или так:
declare(ticks=1);
// прочие действия
?>

Тики

Тик - это событие, которое случается каждые N низкоуровневых операций, выполненных парсером внутри блока declare. Значение N задается, используя ticks=N внутри секции directive блока declare.

Не все выражения подсчитываются. Обычно, условные выражения и выражения аргументов не подсчитываются.

Событие (или несколько событий), которое возникает на каждом тике определяется, используя register_tick_function(). Смотрите пример ниже для дополнительноый иформации. Имейте в виду, что для одного тика может возникать несколько событий.

Пример #1 Пример использования тика

<?php

declare(ticks=1);

// Функция, исполняемая при каждом тике
function tick_handler()
{
    echo 
"tick_handler() выполнено\n";
}

register_tick_function('tick_handler');

$a 1;

if (
$a 0) {
    
$a += 2;
    print(
$a);
}

?>

Пример #2 Пример использования тиков

<?php

function tick_handler()
{
  echo 
"tick_handler() called\n";
}

$a 1;
tick_handler();

if (
$a 0) {
    
$a += 2;
    
tick_handler();
    print(
$a);
    
tick_handler();
}
tick_handler();

?>

См. также register_tick_function() и unregister_tick_function().

Кодировка

Кодировка скрипта может быть указана для каждого скрипта используя директиву encoding.

Пример #3 Определение кодировки для скрипта.

<?php
declare(encoding='ISO-8859-1');
// прочий код
?>

Предостережение

Скомбинированный с пространством имен, единственно допустимый синтаксис для declare является declare(encoding='...'); где ... это значение кодировки. declare(encoding='...') {} приведет к ошибке парсера, если используется вместе с пространством имен.

Значение кодировки в declare игнорируется в PHP 5.3 если php скомпилирован с --enable-zend-multibyte.

Имейте в виду, что PHP не может показать был ли он скомпилирован с --enable-zend-multibyte иначе как с помощью phpinfo().

Смотрите также zend.script_encoding.

Коментарии

Correction to above note:

Apparently, the end brace '}' at the end of the statement causes a tick.

So using

------------
declare (ticks=1) echo "1 tick after this prints";
------------

gives the expected behavior of causing 1 tick.

Note: the tick is issued after the statement executes.

Also, after playing around with this, I found that it is not really the multi-tasking I had expected. It behaves the same as simply calling the functions. I.e. each function must finish before passing the baton to the next function. They do not run in parallel.

It also seems that they always run in the order in which they were registered.

So,

<?php
------------
# register tick functions
register_tick_function ("a");
register_tick_function ("b");

# make the tick functions run
declare (ticks=1);
?>
------------

is equivalent to

------------
a();
b();
------------

It is simply a convenient way to have functions called periodically while some other code is being executed. I.e. you could use it to periodically check the status of something and then exit the script or do something else based on the status.
2002-03-19 04:45:14
http://php5.kiev.ua/manual/ru/control-structures.declare.html
Автор:
<?php
ob_end_clean
();
ob_implicit_flush(1);

function 
a() {
 for(
$i=0;$i<=100000;$i++) { }
 echo 
"function a() ";
}
function 
b() {
 for(
$i=0;$i<=100000;$i++) { }
 echo 
"function b() ";
}

register_tick_function ("a");
register_tick_function ("b");

declare (
ticks=4)
{
    while(
true)
    {
       
sleep(1);
        echo 
"\n<br><b>".time()."</b><br>\n";;
    }
}
?>
You will see that a() and b() are slowing down this process. They are in fact not executed every second as expected. So this function is not a real alternative for multithreading using some slow functions..there is no difference to this way: while (true) { a(); b(); sleep(1); }
2003-02-01 13:56:13
http://php5.kiev.ua/manual/ru/control-structures.declare.html
This is a very simple example using ticks to execute a external script to show rx/tx data from the server

<?php

function traf(){
 
passthru'./traf.sh' );
  echo 
"<br />\n";
 
flush(); // keeps it flowing to the browser...
 
sleep);
}

register_tick_function"traf" );

declare( 
ticks=){
  while( 
true ){}   // to keep it running...
}

?>

contents of traf.sh:
# Shows TX/RX for eth0 over 1sec
#!/bin/bash

TX1=`cat /proc/net/dev | grep "eth0" | cut -d: -f2 | awk '{print $9}'`
RX1=`cat /proc/net/dev | grep "eth0" | cut -d: -f2 | awk '{print $1}'`
sleep 1
TX2=`cat /proc/net/dev | grep "eth0" | cut -d: -f2 | awk '{print $9}'`
RX2=`cat /proc/net/dev | grep "eth0" | cut -d: -f2 | awk '{print $1}'`

echo -e "TX: $[ $TX2 - $TX1 ] bytes/s \t RX: $[ $RX2 - $RX1 ] bytes/s"
#--= the end. =--
2003-07-07 21:45:59
http://php5.kiev.ua/manual/ru/control-structures.declare.html
Also note that PHP is run in a single thread and so everything it does will be one line of code at a time.  I'm not aware of any true threading support in PHP, the closest you can get is to fork.

so, declare tick doens't "multi-thread" at all, it is simply is a way to automaticaly call a function every n-lines of code.
2005-02-28 14:16:34
http://php5.kiev.ua/manual/ru/control-structures.declare.html
The scope of the declare() call if used without a block is a little unpredictable, in my experience. It appears that if placed in a method or function, it may not apply to the calls that ensue, like the following:

<?php
function a()
{
   declare(
ticks=2);
   
b();
}

function 
b()
{
   
// The declare may not apply here, sometimes.
}
?>

So, if all of a sudden the signals are getting ignored, check this. At the risk of losing the ability to make a mathematical science out of placing a number of activities at varying durations of ticks like many people have chosen to do, I've found it simple to just put this at the top of the code, and just make it global.
2006-05-30 03:06:16
http://php5.kiev.ua/manual/ru/control-structures.declare.html
If you misspell the directive, you won't get any error or warning.  The declare block will simply act as a nest for statements:

<?php
declare(tocks="four hundred")
{
   
// Has no affect on code and produces
    // no error or warning.
}
?>

Tested in php 5.2.5 on XPsp2
2008-01-08 03:49:59
http://php5.kiev.ua/manual/ru/control-structures.declare.html
Code evaluation script which uses debug_backtrace() to get execution time in ns, relative current line number, function, file, and calling function info on each tick, and shove it all in $script_stats array.  See debug_backtrace manual to customize what info is collected.

Warning: this will exhaust allowed memory very easily, so adjust tick counter according to the size of your code.  Also, array_key_exists checking on debug_backtrace arrays is removed here only to keep this example simple, but should be added to avoid a large number of resulting PHP Notice errors.

<?php

$script_stats 
= array();
$time microtime(true);

function 
track_stats(){
    global 
$script_stats,$time;
   
$trace debug_backtrace();
   
$exe_time = (microtime(true) - $time) * 1000;
   
$func_args implode(", ",$trace[1]["args"]);
   
$script_stats[] = array(
       
"current_time" => microtime(true),
       
"memory" => memory_get_usage(true),
       
"file" => $trace[1]["file"].': '.$trace[1]["line"],
       
"function" => $trace[1]["function"].'('.$func_args.')',
       
"called_by" => $trace[2]["function"].' in '.$trace[2]["file"].': '.$trace[2]["line"],
       
"ns" => $exe_time
       
);
   
$time microtime(true);
    }

declare(
ticks 1);
register_tick_function("track_stats");

// the rest of your project code

// output $script_stats into a html table or something

?>
2008-08-23 19:50:11
http://php5.kiev.ua/manual/ru/control-structures.declare.html
Note that the two methods for calling declare are not identical.

Method 1:

<?php
// Print "tick" with a timestamp and optional suffix.
function do_tick($str '') {
    list(
$sec$usec) = explode(' 'microtime());
   
printf("[%.4f] Tick.%s\n"$sec $usec$str);
}
register_tick_function('do_tick');

// Tick once before declaring so we have a point of reference.
do_tick('--start--');

// Method 1
declare(ticks=1);
while(
1sleep(1);

/* Output:
[1234544435.7160] Tick.--start--
[1234544435.7161] Tick.
[1234544435.7162] Tick.
[1234544436.7163] Tick.
[1234544437.7166] Tick.
*/

?>

Method 2:
<?php
// Print "tick" with a timestamp and optional suffix.
function do_tick($str '') {
    list(
$sec$usec) = explode(' 'microtime());
   
printf("[%.4f] Tick.%s\n"$sec $usec$str);
}
register_tick_function('do_tick');

// Tick once before declaring so we have a point of reference.
do_tick('--start--');

// Method 2
declare(ticks=1) {
    while(
1sleep(1);
}

/* Output: 
[1234544471.6486] Tick.--start--
[1234544472.6489] Tick.
[1234544473.6490] Tick.
[1234544474.6492] Tick.
[1234544475.6493] Tick.
*/
?>

Notice that when using {} after declare, do_tick wasn't auto-called until about 1 second after we entered the declare {} block.  However when not using the {}, do_tick was auto-called not once but twice immediately after calling declare();.

I'm assuming this is due to how PHP handles ticking internally.  That is, declare() without the {} seems to trigger more low-level instructions which in turn fires tick a few times (if ticks=1) in the act of declaring.
2009-02-13 11:06:02
http://php5.kiev.ua/manual/ru/control-structures.declare.html
Автор:
It's amazing how many people didn't grasp the concept here. Note the wording in the documentation. It states that the tick handler is called every n native execution cycles. That means native instructions, not including system calls (i'm guessing). This can give you a very good idea if you need to optimize a particular part of your script, since you can measure quite effectively how many native instructions are in your actual code.

A good profiler would take that into account, and force you, the developer, to include calls to the profiler as you're entering and leaving every function. That way you'd be able to keep an eye on how many cycles it took each function to complete. Independent of time.

That is extremely powerful, and not to be underestimated. A good solution would allow aggregate stats, so the total time in a function would be counted, including inside called functions.
2010-09-27 17:10:48
http://php5.kiev.ua/manual/ru/control-structures.declare.html
In the following example:

<?php
function handler(){
    print 
"hello <br />";
}

register_tick_function("handler");

declare(
ticks 1){
   
$b 2;
//closing curly bracket tickable
?>

"Hello" will be displayed twice because the closing curly bracket is also tickable. 

One may wonder why the opening curly bracket is not tickable if the closing is tickable. This is because the instruction for PHP to start ticking is given by the opening curly bracket so the ticking starts immediately after it.
2013-08-09 09:31:37
http://php5.kiev.ua/manual/ru/control-structures.declare.html
you can register multiple tick functions:

<?PHP
function a() { echo "a\n"; }
function 
b() { echo "b\n"; }

register_tick_function('a');
register_tick_function('b');
register_tick_function('b');
register_tick_function('b');

?>

will output on every tick:
a
b
b
b
2013-10-17 09:34:42
http://php5.kiev.ua/manual/ru/control-structures.declare.html
Basically 'declare( encoding = .... );' overrides the zend.script_encoding configuration option (as set in php.ini). However, keep in mind that:

* the file encoding must be compatible (at least in the ASCII range of characters) to the zend.script_encoding setting. If you set 'zend.script_encoding' to UTF-8 and save the file in UTF-16, PHP will not be able to interpret the file, let alone the declare statement. As long as you use ASCII compatible encodings (i.e. ISO-8859-1(5), UTF-8 etc) for both the file encoding as the zend.script_encoding, you should be fine. (However, I have not experimented with adding non-ascii characters in comments above the declare statement).

* PHP string literals are converted from your source code encoding (either set with the declare statement or else according to zend.script_encoding) to the mbstring.internal_encoding as set in your php.ini (even if you change the setting using mb_internal_encoding). As an example:

php.ini:
mbstring.internal_encoding = UTF-8

test.php:
<?php
declare(encoding 'ISO-8859-15');
mb_internal_encoding'ISO-8859-15' );
echo 
'aäaß' "\n";
?>

This will still output the string UTF-8 encoded; in a terminal/browser with encoding 'ISO-8859-15' the string will look (something) like this: aÀaß
2014-02-18 18:17:54
http://php5.kiev.ua/manual/ru/control-structures.declare.html
Автор:
Note that in PHP 7 <?php declare(encoding='...'); ?> throws an E_WARNING if Zend Multibyte is turned off.
2015-04-06 20:13:56
http://php5.kiev.ua/manual/ru/control-structures.declare.html
We can specify different encoding to different blocks:

declare(encoding=ENCODING_VALUE) {
    //for a block
}

found this here:
http://code2care.org/tutorials/php/PHP-Declare-ticks-and-tick-functions-Statements-Tutorial.php
2015-05-02 19:13:30
http://php5.kiev.ua/manual/ru/control-structures.declare.html
Автор:
This helper class traces executed statements. Calls it like so:

       CStatementTracer::getInstance()->enableTrace( 'START' );

Source Code

<?php 

 
declare(ticks=1);

class 
CStatementTracer {
   
    static private
       
$_instance;
       
    static 
$lastMessage;
   
    static 
$skipFunctionNames;
   
    protected function 
__construct( ) {

       
self::$skipFunctionNames = array(
        );
           
    } 
// CStatData

        /**
     * Liefert die Instanz zurück
     *
     * @return unknown
     */
   
static public function getInstance() {
       
       if ( 
self::$_instance === null ) {
           
self::$_instance = new CStatementTracer();
        }
        return 
self::$_instance;
       
    }
   
    public function 
addToSkipFunctionNames$aName ) {
       
       
self::$skipFunctionNames[] = $aName;
       
    }
   
    public function 
enableTrace() {
       
       
$this->writeMessage'*************** START  ********************' );
       
       
register_tick_function( array( $this'traceCallback' ) );

    }
   
    public function 
disableTrace() {

       
$this->writeMessage'STOP - ' );
       
       
unregister_tick_function( array( $this'traceCallback' ) );
       
       
    }

    public function 
traceCallback( ) {
       
       
$trace debug_backtrace();
       
       
$latestCall $trace];
       
       
$shortenedArgs = array();
        foreach( 
$latestCall['args'] as $noUseKey => $someArg ) {
           
            if ( 
is_object$someArg ) ) {
               
$someArg get_class$someArg ) . '{}';
            } elseif ( 
is_array$someArg ) ) {
               
$someArg print_r$someArgTRUE );
            } elseif ( 
is_string$someArg )) {
               
$someArg '"' $someArg '"';
            }
           
           
$someArg str_replace"\n"' '$someArg );
           
$someArg str_replace"\r"' '$someArg );
           
$someArg str_replace"    "' '$someArg );
           
$someArg str_replace"   "' '$someArg );
           
$someArg str_replace"  "' '$someArg );
           
            if ( 
80 strlen$someArg ) ) {
               
$someArg substr$someArg015 ) . '...' substr$someArg, -15 );
            } 
           
           
$shortenedArgs[] = $someArg;
           
        } 

        if ( isset( 
$latestCall['file'] )) {

           
$file explode'\\'$latestCall'file' ] );
           
$file $filecount$file ) - ];
            if ( 
'' == $file ) {
               
$file '{}';
            }
           
$file .= '/' $latestCall'line' ];

        } else {

           
$file '[NpFile]';

        }
       
        if (  ( 
True === in_array$latestCall['function'], self::$skipFunctionNames ) )
           ) {
            return;
        }
       
       
$args implode', '$shortenedArgs );
       
$newInfo $file ': ' $latestCall['function'] . '( ' $args ' )';
       
       
$newInfo str_pad''count$trace ) ) . $newInfo;
       
       
$this->writeMessage$newInfo );
    }

   
    public function 
writeMessage$someData ) {
       
        if ( 
self::$lastMessage == $someData ) {
            return;
        }
       
       
self::$lastMessage $someData;
       
       
$logfilePath dirname__FILE__ ) . '/../statementTracer.log';
       
       
$fp fopen$logfilePath'a+' );
       
        if ( 
is_array$someData ) ) {
           
fwrite$fpprint_r$someDataTRUE )  . "\n" );
        } else {
           
fwrite$fp$someData  "\n" );
        }
       
       
fclose$fp );
    }   
     
   
// CStatementTracer
2016-04-05 12:19:10
http://php5.kiev.ua/manual/ru/control-structures.declare.html
Автор:
I haven't found this written in the doc: when using declare in the global context, it has to be the first statement in the script, before any other output.

This works:

<?php
declare(strict_types=1);
function 
sum(int $aint $b): int {
    return 
5.78;
}
# ... but fails when calling the function
?>

This doesn't work:

<html>
<body>
<?php
declare(strict_types=1);
function 
sum(int $aint $b): int {
    return 
5.78;
}
# PHP Fatal error:  strict_types declaration must be the very first statement in the script [...]
?>
2017-02-10 08:36:53
http://php5.kiev.ua/manual/ru/control-structures.declare.html
If you fork'ed (with pcntl_fork) after you've used `declare`, you need to do it again in child thread.

declare(ticks=1);
$pid = pcntl_fork();
if ($pid === 0) {
    declare(ticks=1);
} else {
    // code ..
}
2017-08-01 11:49:11
http://php5.kiev.ua/manual/ru/control-structures.declare.html

    Поддержать сайт на родительском проекте КГБ