xattr_set
(PECL xattr:0.9-1.0)
xattr_set — Set an extended attribute
Description
bool xattr_set
( string $filename
, string $name
, string $value
[, int $flags
] )
This function sets the value of an extended attribute of a file.
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.
Parameters
- filename
-
The file in which we set the attribute.
- name
-
The name of the extended attribute. This attribute will be created if it doesn't exist or replaced otherwise. You can change this behaviour by using the flags parameter.
- value
-
The value of the attribute.
- flags
-
Supported xattr flags XATTR_CREATE Function will fail if extended attribute already exists. XATTR_REPLACE Function will fail if extended attribute doesn't exist. XATTR_DONTFOLLOW Do not follow the symbolic link but operate on symbolic link itself. XATTR_ROOT Set attribute in root (trusted) namespace. Requires root privileges.
Return Values
Returns TRUE on success or FALSE on failure.
Examples
Example#1 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'));
?>