variables.php File Reference

Go to the source code of this file.

Functions
	variable_init ($conf=array())
	Persistent variable table. More...
	variable_init_maybe ()
	Initialize the global $conf array if necessary. More...
	variable_get ($name, $default=null, $createit_comment=null)
	Return a persistent variable. More...
	variable_set ($name, $value, $comment=null)
	Set a persistent variable. More...
	variable_del ($name)
	Unset a persistent variable. More...
	variables_list ()
	List all variables. More...

Function Documentation

variable_del()

variable_del

(

$name

)

Unset a persistent variable.

Parameters

$name

The name of the variable to undefine.

Definition at line 146 of file variables.php.

                             {
    global $conf, $db;
    $db->query("DELETE FROM `variable` WHERE name = ?;", array($name));
    unset($conf[$name]);
}

References $conf, and $db.

variable_get()

variable_get	(		$name,
			$default = null,
			$createit_comment = null
	)

Return a persistent variable.

Parameters

$name	The name of the variable to return.
$default	The default value to use if this variable has never been set.
$createit_comment	If variable doesn't exist, create it with the default value and createit_comment value as comment

Returns

The value of the variable.

Parameters

global

$conf

A cache of the configuration.

Definition at line 85 of file variables.php.

                                                                        {
    global $conf;
 
    variable_init_maybe();
 
    if (isset($conf[$name])) {
        return $conf[$name];
    } elseif (!is_null($createit_comment)) {
        variable_set($name, $default, $createit_comment);
    }
    return $default;
}

References $conf, elseif, variable_init_maybe(), and variable_set().

Referenced by m_admin\__construct(), m_mysql\__construct(), m_mem\_get_reset_url(), m_mysql\add_db(), m_admin\add_shared_domain(), m_mysql\add_user(), m_action\archive(), m_admin\checkalldom(), m_messages\debug(), m_admin\dom_list(), m_ssl\get_fqdn_specials(), m_admin\hook_admin_add_member(), m_mail\hook_dom_add_mx_domain(), m_dom\m_dom(), m_ftp\m_ftp(), m_lxc\m_lxc(), m_mail\m_mail(), m_piwik\m_piwik(), m_quota\m_quota(), m_ssl\m_ssl(), m_mysql\put_mysql_backup(), m_mysql\put_mysql_details(), m_mem\requires_old_password_for_change(), m_mem\send_reset_url(), m_mem\temporary_login(), m_ssl\update_specials_match(), and m_mem\validate_reset_url().

variable_init()

variable_init

(

$conf = array()

)

Persistent variable table.

Author

Drupal Developpement Team &view=auto Load the persistent variable table. The variable table is composed of values that have been saved in the table with variable_set() as well as those explicitly specified in the configuration file.

Definition at line 36 of file variables.php.

                                        {
    global $db;
    $result = $db->query('SELECT * FROM `variable`');
    $variables=array();
    while ($db->next_record($result)) {
        /* maybe the data is *not* serialized, in that case, take it verbatim */
        $variable = $db->Record;
        if (($variables[$variable['name']] = @unserialize($variable['value'])) === FALSE) {
            $variables[$variable['name']] = $variable['value'];
        }
    }
 
    foreach ($conf as $name => $value) {
        $variables[$name] = $value;
    }
 
    return $variables;
}

References $conf, $db, and $value.

Referenced by variable_init_maybe().

variable_init_maybe()

variable_init_maybe

(

)

Initialize the global $conf array if necessary.

Parameters

global

$conf

the global conf array @uses variable_init()

Definition at line 62 of file variables.php.

                               {
    global $conf;
    if (!isset($conf)) {
        $conf = variable_init();
    }
}

References $conf, and variable_init().

Referenced by variable_get(), and variable_set().

variable_set()

variable_set	(		$name,
			$value,
			$comment = null
	)

Set a persistent variable.

Parameters

$name	The name of the variable to set.
$value	The value to set. This can be any PHP data type; these functions take care of serialization as necessary.

Definition at line 108 of file variables.php.

                                                      {
    global $conf, $db, $msg, $hooks;
    $msg->log('variable', 'variable_set', '+' . serialize($value) . '+' . $comment . '+');
 
    variable_init_maybe();
    
    if (is_object($value) || is_array($value)) {
        $value2 = serialize($value);
    } else {
        $value2 = $value;
    }
    if (array_key_exists($name, $conf)) {
        $previous = $conf[$name];
    } else {
        $previous = null;
    }
    if (!array_key_exists($name, $conf) || $value != $conf[$name]) {
        $conf[$name] = $value;
        if (empty($comment)) {
            $query = "INSERT INTO variable (name, value) values ( ?, ?) on duplicate key update name=  ?, value= ? ;"; 
            $query_args = array($name, $value2, $name, $value2);
 
        } else {
            $query = "INSERT INTO variable (name, value, comment) values ( ?, ?, ?) on duplicate key update name=  ?, value= ?, comment= ? ;"; 
            $query_args = array($name, $value2, $comment, $name, $value2, $comment);
        }
        $db->query($query, $query_args);
        $hooks->invoke("hook_variable_set", array("name" => $name, "old" => $previous, "new" => $value));
    }
}

References $conf, $db, $hooks, $msg, $query, $value, and variable_init_maybe().

Referenced by m_ssl\cron_new_certs(), and variable_get().

variables_list()

variables_list

(

)

List all variables.

Definition at line 156 of file variables.php.

                          {
    global $db;
    $t = array();
    $db->query("SELECT * FROM `variable` WHERE `comment` IS NOT NULL ORDER BY `name`");
    while ($db->next_record()) {
        $t[] = $db->Record;
    }
    return $t;
}

References $db, and $t.