Introduction to Variables

A good understanding of how variables are stored
and manipulated is essential to becoming a Hacker. The engine attempts to cover up the
complexity of the concept of a variable that can be any type by
providing a uniform and intuitive set of macros for accessing the
structures various fields. As the Hacker
works through this chapter, they should become comfortable with the
terminology and concepts involved with Variables in PHP.

Note:

PHP is a dynamic, loosely typed language, that uses
copy-on-write and reference counting.

To clarify what exactly is meant by the statement
above: PHP is a high level language, weak typing is implicit of the
engines preference to convert, or coerce variables into the
required type at execution time. Reference counting is the means by
which the engine can deduce when a variable no longer has any
references in the users code, and so is able to free the structures
associated with the variable.

All variables in PHP are represented by one
structure, the zval:

typedef struct _zval_struct {
    zvalue_value value;        /* variable value */
    zend_uint refcount__gc;    /* reference counter */
    zend_uchar type;           /* value type */
    zend_uchar is_ref__gc;     /* reference flag */
} zval;

The zval_value is a union
which can represent all types a variable may hold:

typedef union _zvalue_value {
    long lval;                 /* long value */
    double dval;               /* double value */
    struct {                   
        char *val;
        int len;               /* this will always be set for strings */
    } str;                     /* string (always has length) */
    HashTable *ht;             /* an array */
    zend_object_value obj;     /* stores an object store handle, and handlers */
} zvalue_value;

It should be clear from the structures above that a
variable can be of one type, the variable data is represented by
the appropriate field in the zval_value
union. The zval itself holds the type,
reference count and a flag to indicate if a variable is a
reference.

Note:

There are additional constants that help to
identify internal types such as constant arrays and callable
objects, their usage is outside the scope of this part of the
documentation.

The following table defines the macros exposed by
the engine for working with zval
values:

Please check the Reference
Counting Basics chapter for details how reference counting and
references work in detail.

Note:

The Z_* macros above all take a zval, they are all
defined again suffixed with _P to take a pointer to a zval, for
example zend_uchar Z_TYPE_P(zval* pzv),
and again suffixed with _PP to take a pointer to a pointer to a
zval, for example zend_uchar Z_TYPE_PP(zval**
ppzv)

Note:

Objects and Resources have a reference count as
part of their respective structures, when zval_ptr_dtor is called
on either, their appropriate del_ref method is executed. See
Working with Objects and Working with Resources for more
information.

If the Hacker only has
room to remember two more functions, they should be zval_copy_ctor and zval_ptr_dtor, these are at the basis of the engines
reference counting mechanisms and it is important to note that
zval_copy_ctor does not actually result
in any copying occuring under normal circumstances, it simply
increases the reference count. By the same token, zval_ptr_dtor only really destroys a variable when
there are no references remaining to it and the refcount is at
0.

PHP is weakly typed, as such the engine provides
API functions for converting variables from one type to
another.

Note:

convert_func_t functions
should have the prototype (void) (zval*
pzval)

By now you should have a good understanding of: the
types that are native to the engine, how to detect types and read
zval values, how to manipulate refcounts, and other zval flags