assert_options
There's a nice advantage to giving assert() some code to execute, as a string, rather than a simple true/false value: commenting.
<?php
assert('is_int($int) /* $int parameter must be an int, not just numeric */');
// and my personal favorite
assert('false /* not yet implemented */');
?>
The comment will show up in the output (or in your assertion handler) and doesn't require someone debugging to go through your code trying to figure out why the assertion happened. That's no excuse to not comment your code, of course.
You need to use a block comment (/*...*/) because a line comment (//...) creates an "unexpected $end" parse error in the evaluated code. Bug? Could be.
(You can get around it with "false // not yet implemented\n" but that screws up the message)
assert
(PHP 4, PHP 5)
assert — Belirtilen savı sınar
Açıklama
assert() işlevi belirtilen
sav'ı sınar ve sonuç FALSE ise uygun eylemi
gerçekleştirir.
sav bir dizge olarak verilmişse işlev tarafından PHP
kodu olarak değerlendirilir. Savın bir dizge olarak belirtilmesinin
getirisi, sav sınama kapalı olduğu zaman daha az yük oluşması ve sav
başarısız olduğunda iletilerin sav ifadesini
içerebilmeleridir. Yani, sav olarak bir mantıksal ifade aktardığınız
takdirde, bu koşul ifadesi assert_options() işlevi ile
tanımladığınız eylemci işleve bir değiştirge olarak gösterilmez, eylemci
işlev çağrılmadan önce koşul ifadesi bir dizgeye, mantıksal FALSE değeri
ise boş bir dizgeye dönüştürülür.
Savlar sadece bir hata ayıklama aracı olarak kullanılmalıdır. Bazı
programlama hatalarının olmadığını belirten veya bir eklenti işlevi gibi
belli özelliklerin veya belli sistem sınırlamalarının ve özelliklerinin
varlığını sınayan koşul ifadelerinin her zaman TRUE dönmesini gerektiren
kararlılık denetimleri için de kullanabilirsiniz.
Savlar, girdi değiştirgelerinin sınanması gibi normal çalışma anı işlemleri için kullanılmamalıdır. Ana kural olarak, bir kararlılık denetimini etkin kılmaksızın kodunuz düzgün olarak çalışabilmelidir.
assert() işlevinin davranışı assert_options() işlevi ile veya bu işlevin kılavuz sayfasında açıklanan INI ayarları ile yapılandırılabilir.
assert_options() işlevi ve/veya ASSERT_CALLBACK yapılandırma yönergesi ile bir savın başarısızlığı halinde çalışacak bir geriçağırım işlevi belirtilebilir.
assert() geriçağırım işlevleri, özellikle özdevinimli deneme ortamları oluşturulurken yararlı olur. Çünkü bunlar, savın oluştuğu yer bilgisi yanında sava aktarılan kodun da yakalanmasını kolaylaştırırlar. Bu bilgi başka yöntemlerle yakalanabilirse de savların kullanımı bu işlemin daha kolay ve çabuk olmasını sağlar.
Geriçağırım işlevinin üç değiştirge kabul etmesi gerekir. İlk değiştirge savın başarısız olduğu dosyayı, ikinci değiştirge savın başarısız olduğu satırı, üçüncü değiştirge ise başarısız olan ifadeyi (1, "iki" gibi herhangi bir değer belirtilebilir) içerir.
Değiştirgeler
-
sav -
İddia.
Dönen Değerler
Sav yanlışsa FALSE değilse TRUE.
Örnekler
Örnek 1 - Başarısız bir savın özel bir işlevle ele alınması
<?php
// Savı etkin ve sessiz kılalım
assert_options(ASSERT_ACTIVE, 1);
assert_options(ASSERT_WARNING, 0);
assert_options(ASSERT_QUIET_EVAL, 1);
// Savın başarısızlığı halinde çalışacak işlevimiz
function savcı($dosya, $satır, $ifade)
{
echo "<hr>Sav geçersiz:
Dosya: '$dosya'<br />
Satır: '$satır'<br />
Kod: '$ifade'<br /><hr />";
}
// Geriçağırım işlevimizi belirtelim
assert_options(ASSERT_CALLBACK, 'savcı');
// Başarısız olmasını umarak bir sav ileri sürelim
assert('mysql_query("")');
?>
add a note
User Contributed Notes
assert - [7 notes]
uramihsayibok, gmail, com ¶
2 years ago
Krzysztof 'ChanibaL' Bociurko ¶
5 years ago
Note that func_get_args() should be used carefully and never in a string! For example:
<?php
function asserted_normal($a, $b) {
assert(var_dump(func_get_args()));
}
function asserted_string($a, $b) {
assert('var_dump(func_get_args())');
}
?>
<?php asserted_normal(1,2) ?> prints
array(2) {
[0]=>
int(1)
[1]=>
int(2)
}
but <?php asserted_string(3,4) ?> prints
array(1) {
[0]=>
string(25) "var_dump(func_get_args())"
}
This is because of that the string passed to assert() is being evaled inside assert, and not your function. Also, note that this works correctly, because of the eval scope:
<?php
function asserted_evaled_string($a, $b) {
assert(eval('var_dump(func_get_args())'));
}
asserted_evaled_string(5,6);
?>
array(2) {
[0]=>
int(5)
[1]=>
int(6)
}
(oh, and for simplicity's sake the evaled code doesn't return true, so don't worry that it fails assertion...)
Sony? ¶
7 months ago
If you would like to compare with === or !== you need to add '(string)' before string numbers. Or wrap them with quotes.
<?php
$stringNumber = "2";
$number = 2;
assert($stringNumber ." === ". $number); //True (!!!) :(
assert("(string)". $stringNumber ." === ". $number); //False, as we wanted. :)
assert("'". $stringNumber ."' === ". $number); //Also false :)
?>
gk at proliberty dot com ¶
7 years ago
If you expect your code to be able to work well with other code, then you should not make any assumptions about the current state of assert_options() flags, prior to calling assert(): other code may disable ASSERT_ACTIVE, without you knowing it - this would render assert() useless!
To avoid this, ALWAYS set assert_options() IMMEDIATELY before calling assert(), per the C++ paradigm for assertion usage:
In one C++ source file, you can define and undefine NDEBUG multiple times, each time followed by #include <cassert>, to enable or disable the assert macro multiple times in the same source file.
Here is how I workaround this issue in my PHP code:
<?php
//////////////////////////////////////////////////////////////////////
/// phpxAssertHandler_f
//////////////////////////////////////////////////////////////////////
/**
* @desc Handler which also sets up assert options if not being called as handler
Always fatal when assertion fails
Always make sure assertion is enabled
Cannot depend on other code not using assert or using its own assert handler!
USAGE:
// customize error level of assertion (php assert_options() only allows E_WARNING or nothing at all):
phpxAssertHandler_f(E_USER_NOTICE);
// control assertion active state: not dependent on anything another piece of code might do with ASSERT_ACTIVE
$GLOBALS['MY_ASSERT_ACTIVE']=false;
phpxAssertHandler_f(E_USER_NOTICE,$GLOBALS['MY_ASSERT_ACTIVE']);
// use alternate assertion callback function:
// NOTE: pass null as custom options parameter to use default options
// NOTE: pass no values for assert options parameter array elements to use default options
$GLOBALS['MY_ASSERT_ACTIVE']=false;
$GLOBALS['MY_ASSERT_CALLBACK']='myAssertCallback';
phpxAssertHandler_f(
null,
array(
0=>$GLOBALS['MY_ASSERT_ACTIVE'],
3=>$GLOBALS['MY_ASSERT_CALLBACK'],
)
);
* @param mixed = file or options
* @param line
* @param code
* @return void
*/
function phpxAssertHandler_f($file_or_custom_options=null, $line_or_assert_options=null, $code=null){
static $custom_options;
$debug = false;
if (is_null($code)){
// set default assert_options
$assert_options[]=1;//ASSERT_ACTIVE
$assert_options[]=0;//ASSERT_WARNING -
$assert_options[]=0;//ASSERT_QUIET_EVAL
$assert_options[]=__FUNCTION__;//ASSERT_CALLBACK
// set default custom_options
$custom_options[]=E_USER_ERROR;// error level
if (!is_null($line_or_assert_options)){
// assert_options are passed in
if (!is_array($line_or_assert_options)){
$line_or_assert_options=array($line_or_assert_options);
}
foreach ($line_or_assert_options as $i=>$assert_option){
if ($assert_option===true) $assert_option=1;
if ($assert_option===false) $assert_option=0;
$assert_options[$i]=$assert_option;
if($debug) echo ("assert_options[$i]=$assert_option\n");
}
}
if (!is_null($file_or_custom_options)){
// custom_options are passed in
if (!is_array($file_or_custom_options)){
$file_or_custom_options=array($file_or_custom_options);
}
foreach ($file_or_custom_options as $i=>$custom_option){
if ($custom_option===true) $custom_option=1;
if ($custom_option===false) $custom_option=0;
$custom_options[$i]=$custom_option;
if($debug) echo ("custom_options[$i]=$custom_option\n");
}
}
// set assert options
@assert_options (ASSERT_ACTIVE, $assert_options[0]);
@assert_options (ASSERT_WARNING, $assert_options[1]);
@assert_options (ASSERT_QUIET_EVAL, $assert_options[2]);
@assert_options (ASSERT_CALLBACK, $assert_options[3]);
} else {
// we are acting as a callback function
$file = $file_or_custom_options;
$line = $line_or_assert_options;
$msg="ASSERTION FAILED: $code";
phpxErrorHandler_f ($custom_options[0],$msg,$file,$line);
}
}//phpxAssertHandler_f()
?>
nyk at forumone dot com ¶
10 years ago
Assertion is a useful debugging feature, but for building unit tests and automated regression tests you should seriously consider using the PHPtest in the PEAR archive (http://pear.php.net/package-info.php?pacid=38) that is based on the JUnit framework for Java. There is also another unit testing framework, also based on JUnit and also called PHPunit on SourceForge (http://sourceforge.net/projects/phpunit/). I believe it is an independent effort from that on PEAR.
hodgman at ali dot com dot au ¶
4 years ago
As noted on Wikipedia - "assertions are primarily a development tool, they are often disabled when a program is released to the public." and "Assertions should be used to document logically impossible situations and discover programming errors— if the 'impossible' occurs, then something fundamental is clearly wrong. This is distinct from error handling: most error conditions are possible, although some may be extremely unlikely to occur in practice. Using assertions as a general-purpose error handling mechanism is usually unwise: assertions do not allow for graceful recovery from errors, and an assertion failure will often halt the program's execution abruptly. Assertions also do not display a user-friendly error message."
This means that the advice given by "gk at proliberty dot com" to force assertions to be enabled, even when they have been disabled manually, goes against best practices of only using them as a development tool.
mail<at>aaron-mueller.de ¶
6 years ago
Here is a simple demonstration of Design By Contract with PHP
<?php
assert_options(ASSERT_ACTIVE, 1);
assert_options(ASSERT_WARNING, 0);
assert_options(ASSERT_BAIL, 1);
assert_options(ASSERT_CALLBACK, 'dcb_callback');
function dcb_callback($script, $line, $message) {
echo "<h1>Condition failed!</h1><br />
Script: <strong>$script</strong><br />
Line: <strong>$line</strong><br />
Condition: <br /><pre>$message</pre>";
}
// Parameters
$a = 5;
$b = 'Simple DCB with PHP';
// Pre-Condition
assert('
is_integer($a) &&
($a > 0) &&
($a < 20) &&
is_string($b) &&
(strlen($b) > 5);
');
// Function
function combine($a, $b) {
return "Kombined: " . $b . $a;
}
$result = combine($a, $b);
// Post-Condition
assert('
is_string($result) &&
(strlen($result) > 0);
');
// All right, the Function works fine
var_dump($result);
?>