Documentation

deleteFromFavorite

public function deleteFromFavorite($parameters = array('AFFECT_CHILDREN' => true))

This method deletes task from Favorites.

Parameters

ParameterDescription
PARAMETERSArray, containing the AFFECT_CHILDREN key. If the key value is true, then subtasks of this task will be added to the Favorites as well. If false, then they will not be included.

Returned value

The method returns true if deletion was successful, otherwise returns false.

Examples of use

   // deleting from favorites
   $task = new CTaskItem(10, $GLOBALS['USER']->GetId()); 
   $task->deleteFromFavorite(); 

© «Bitrix24», 2001-2024