xattr_set

(PECL)

xattr_set --  Set an extended attribute

説明

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

This function sets the value of an extended attribute of a file.

拡張属性には二種類の異なる名前空間、つまり、ユーザとルートがあります。 ユーザ名前空間は、全てのユーザで利用可能ですが、ルート名前空間は、ルート権限を有するユーザのみ利用可能です。 xattrはデフォルトでユーザ名前空間で処理を行いますが、 flags 引数によりこれを変更することができます。

パラメータ

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

表 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.

戻り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

例 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'));
?>

以下も参照ください

xattr_get()
xattr_remove()