Declare keyword in php


 

 

 

 

 

 

 

 

 

declare

(PHP 4, PHP 5)

Usage of declare in php

The declare construct is used to set execution directives for a block of code. The syntax of declare is similar to the syntax of other flow control constructs:

declare (directive)
    statement

The directive section allows the behavior of the declare block to be set. Currently only two directives are recognized: the ticks directive

As directives are handled as the file is being compiled, only literals may be given as directive values. Variables and constants cannot be used. To illustrate:

<?php
// This is valid:
declare(ticks=1);
// This is invalid:

const TICK_VALUE = 1;
declare(ticks=TICK_VALUE);
?>

The statement part of the declare block will be executed – how it is executed and what side effects occur during execution may depend on the directive set in the directive block.

The declare construct can also be used in the global scope, affecting all code following it (however if the file withdeclare was included then it does not affect the parent file).

<?php
// these are the same:
// you can use this:

declare(ticks=1) {
// entire script here
}// or you can use this:
declare(ticks=1);
// entire script here
?>
 

Ticks 

A tick is an event that occurs for every N low-level tickable statements executed by the parser within thedeclare block. The value for N is specified using ticks=N within the declare block’s directive section.

Not all statements are tickable. Typically, condition expressions and argument expressions are not tickable.

The event(s) that occur on each tick are specified using the register_tick_function(). See the example below for more details. Note that more than one event can occur for each tick.

Example #1 Tick usage example

<?php

declare(ticks=1);

// A function called on each tick event
function tick_handler()
{
echo “tick_handler() called\n”;
}

register_tick_function(‘tick_handler’);

$a = 1;

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

?>

Example #2 Ticks usage example

<?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();

?>

See also register_tick_function() and unregister_tick_function().

Encoding 

A script’s encoding can be specified per-script using the encoding directive.

Example #3 Declaring an encoding for the script.

<?php
declare(encoding='ISO-8859-1');
// code here
?>
 

register_tick_function in php

(PHP 4 >= 4.0.3, PHP 5)

register_tick_functionRegister a function for execution on each tick

Description 

bool register_tick_function ( callable $function [, mixed $arg [, mixed $... ]] )

Registers the given function to be executed when a tick is called.

Parameters 

function

The function name as a string, or an array consisting of an object and a method.

arg
...

Return Values 

Returns TRUE on success or FALSE on failure.

Examples 

Example #1 register_tick_function() example

<?php
declare(ticks=1);
// using a function as the callback

register_tick_function(‘my_function’, true);// using an object->method
$object = new my_class();
register_tick_function(array(&$object, ‘my_method’), true);
?>

unregister_tick_function in php

(PHP 4 >= 4.0.3, PHP 5)

unregister_tick_functionDe-register a function for execution on each tick

Description 

void unregister_tick_function ( string $function_name )

De-registers the function named by function_name so it is no longer executed when a tick is called.

Parameters 

function_name

The function name, as a string.

Return Values 

No value is returned.