PHP Manual
PrevNext

xattr_set

(no version information, might be only in CVS)

xattr_set --  Set an extended attribute

Description

bool xattr_set ( string path, string name, string value [, int flags])

This function sets value of an extended attribute named name to value of a file path. Extended attribute will be created if it doesn't exist or replaced otherwise. You can change this behaviour by using flags parameter.

Extended attributes have two different namespaces: user and root namespace. User namespace is available for all users while root namespace is available only for user with root privileges. xattr operates on user namespace by default, but you can change that using flags argument.

Table 1. Supported xattr flags

XATTR_CREATEFunction will fail if extended attribute already exists.
XATTR_REPLACEFunction will fail if extended attribute doesn't exist.
XATTR_DONTFOLLOWDo not follow the symbolic link but operate on symbolic link itself.
XATTR_ROOTSet attribute in root (trusted) namespace. Requires root privileges.

Returns TRUE on success or FALSE on failure.

Example 1. xattr_set() example

The following code sets extended attributes on .wav file.

<?php
$file = 'my_favourite_song.wav';
xattr_set($file, 'Artist', 'Someone');
xattr_set($file, 'My ranking', 'Good');
xattr_set($file, 'Listen count', '34');

/* ... other code ... */

printf("You've played this song %d times", xattr_get($file, 'Listen count'));
?>

See also xattr_get(), xattr_remove(), xattr_list(), xattr_supported().

PrevHomeNext
xattr_removeUpxattr_supported