hw_Modifyobject

(PHP 3>= 3.0.7, PHP 4)

hw_Modifyobject - модифицирует запись объекта/object record.

Описание

int hw_modifyobject (int connection, int object_to_change, array remove, array add, int mode)

Эта команда позволяет удалять, добавлять или модифицировать отдельные атрибуты записи объекта. Объект специфицируется ID объекта object_to_change. Первый массив remove это список атрибутов для удаления. Второй массив add это список атрибутов для добавления. Чтобы модифицировать атрибут, нужно удалить старый и добавить новый. hw_modifyobject() всегда удаляет атрибуты перед их добавлением, если только значение удаляемого атрибута не является строкой или массивом.

Последний параметр определяет, выполняется ли модификация рекурсивно. 1 обозначает рекурсивную модификацию. Если некоторые объекты не могут быть модифицированы, они игнорируются без уведомления. hw_error() не может указывать на ошибку, хотя некоторые объекты могут не быть модифицированы.

Ключами обоих массивов являются имена атрибутов. Значением каждого элемента массива может быть массив, строка или ещё что-нибудь. Если это массив, значение каждого атрибута конструируется по ключу каждого элемента плюс двоеточие и и значение каждого элемента. Если это строка, она принимается как значение атрибута. Пустая строка даёт полное удаление атрибута. Если значение не является ни массивом, ни строкой, например целым числом, с атрибутом не выполняются никакие операции вообще. Это необходимо, если вы хотите добавить совершенно новый атрибут, а непросто новое значение для существующего атрибута. Если удаляемый массив содержал пустую строку для данного атрибута, будет сделана попытка удаления этого атрибута, которая потерпит неудачу, поскольку он не существует. Последующее добавление нового значения такому атрибуту также потерпит неудачу. Установка значения для этого атрибута в, например, 0 не вызовет попытки удаления, и добавление произойдёт.

Если вы хотите изменить 'Name' атрибута с текущим значением 'books' на 'articles', вы должны будете создать жва массива и вызвать hw_modifyobject().

// $connect это существующее соединение с Hyperwave-сервером
       // $objid это ID модифицируемого объекта
       $remarr = array("Name" => "books");
       $addarr = array("Name" => "articles");
       $hw_modifyobject($connect, $objid, $remarr, $addarr);

Чтобы удалить/добавить пару name=value из/в запись объекта, просто передайте массив удаления/добавления и установите последний/третий параметр как пустой массив. Если имеется только первый атрибут с добавляемым именем, установите целочисленное значение атрибута в удаляемом массиве.

// $connect это существующее соединение с Hyperwave-сервером
       // $objid это ID модифицируемого объекта
       $remarr = array("Name" => 0);
       $addarr = array("Name" => "articles");
       $hw_modifyobject($connect, $objid, $remarr, $addarr);

Примечание: многоязычные атрибуты, например, 'Title', можно модифицировать двояко. Добавляя значение атрибута в исходной форме 'language':'title', либо предоставляя массив с элементами для каждого языка, как описано выше. Вышеприведённый пример станет тогда:

$remarr = array("Title" => "en:Books");
       $addarr = array("Title" => "en:Articles");
       $hw_modifyobject($connect, $objid, $remarr, $addarr);

или

$remarr = array("Title" => array("en" => "Books"));
       $addarr = array("Title" => array("en" => "Articles", "ge"=>"Artikel"));
       $hw_modifyobject($connect, $objid, $remarr, $addarr);

Это удалит английский заголовок 'Books' и добавит английский заголовок 'Articles' и немецкйи заголовок 'Artikel'.

$remarr = array("Title" => "");
       $addarr = array("Title" => "en:Articles");
       $hw_modifyobject($connect, $objid, $remarr, $addarr);

Примечание: это удалит все атрибуты с именем 'Title' и добавит новый атрибут 'Title'. Это удобно, когда вы хотите удалять атрибуты рекурсивно.

Примечание: если вам нужно удалить все атрибуты с определённым именем, вы должны передать в качестве значения атрибута пустую строку.

Примечание: только атрибуты 'Title', 'Description' и 'Keyword' будут правильно описывать префикс языка. Если эти атрибуты не задают префикс языка, назначается префикс 'xx'.

Примечание: атрибут 'Name' это отдельный вопрос. В некоторых случаях он не может быть полностью удалён. Вы получите сообщение 'Change of base attribute' (не совсем ясно, когда это происходит). Следовательно, вы всегда должны сначала добавлять новый Name, а затем удалять старый.

Примечание: вы можете не окружать вызов этой функции вызовами hw_getandlock() и hw_unlock(). hw_modifyobject() выполняет это встроенным способом.

Возвращает TRUE, если ошибка не возникает, иначе FALSE.