K2hash::cleanCommonAttribute

Initializes the common attributes

Description

public bool K2hash::cleanCommonAttribute ( void )

Initializes the common attributes. Common attributes are:

• mtime
  true when keeping the last timestamp to modify values.
• encrypt
  true to encrypt values.
• history
  true to track values changes.
• expire
  true to expire values.

Parameters

This function has no parameters.

Return Values

Returns true on success or false on failure.

Examples

• Example 1 - Initializes the common attribute

<?php
$k2hash = new K2hash();
$k2hash->openMem();
var_dump($k2hash->cleanCommonAttribute());
$k2hash->close();
?>

The above example will output:

bool(true)

See Also

• K2hash::addAttr - Adds the attribute to the key
• K2hash::addAttrCryptPass - Adds the password to encrypt values
• K2hash::addAttrPluginLib - Adds the user-defined library to handle attributes
• K2hash::getAttrInfos - Prints the attribute information
• K2hash::getAttrs - Gets attributes of the key
• K2hash::getAttrValue - Gets an attribute value of the attribute key of the key
• K2hash::getAttrVersionInfos - Prints the attribute library version