// Group conversation messaging.
if (\core_message\api::can_create_group_conversation($USER->id, $context)) {
if (!empty($data->enablemessaging)) {
- \core_message\api::create_conversation_area('core_group', 'groups', $group->id, $context->id, $group->name, 1);
+ \core_message\api::create_conversation_area('core_group', 'groups', $group->id, $group->name, $context->id,
+ \core_message\api::MESSAGE_CONVERSATION_AREA_ENABLED);
}
}
\core_message\api::update_conversation_name($conversationarea->conversationid, $group->name);
} else {
if (!empty($data->enablemessaging)) {
- \core_message\api::create_conversation_area('core_group', 'groups', $group->id, $context->id, $group->name, 1);
+ \core_message\api::create_conversation_area('core_group', 'groups', $group->id, $group->name,
+ \core_message\api::MESSAGE_CONVERSATION_AREA_ENABLED);
}
}
}
'contextid' => $coursecontext1->id,
'component' => 'core_group',
'itemtype' => 'groups',
- 'enabled' => 1
+ 'enabled' => \core_message\api::MESSAGE_CONVERSATION_AREA_ENABLED
]
);
$this->assertCount(1, $conversationareas);
'contextid' => $coursecontext1->id,
'component' => 'core_group',
'itemtype' => 'groups',
- 'enabled' => 1
+ 'enabled' => \core_message\api::MESSAGE_CONVERSATION_AREA_ENABLED
]
);
$this->assertCount(1, $conversationareas);
'contextid' => $coursecontext1->id,
'component' => 'core_group',
'itemtype' => 'groups',
- 'enabled' => 1
+ 'enabled' => \core_message\api::MESSAGE_CONVERSATION_AREA_ENABLED
],
'id ASC');
$this->assertCount(2, $conversationareas);
*/
const MESSAGE_CONVERSATION_TYPE_GROUP = 2;
+ /**
+ * The state for an enabled conversation area.
+ */
+ const MESSAGE_CONVERSATION_AREA_ENABLED = 1;
+
+ /**
+ * The state for a disabled conversation area.
+ */
+ const MESSAGE_CONVERSATION_AREA_DISABLED = 0;
+
/**
* Handles searching for messages in the message area.
*
* @return \stdClass
*/
public static function create_conversation_area(string $component, string $itemtype, int $itemid, int $contextid, string $name,
- int $enabled = 0) {
+ int $enabled = self::MESSAGE_CONVERSATION_AREA_DISABLED) {
global $DB;
// Create a conversation.
'contextid' => $contextid,
'component' => $component,
'itemtype' => $itemtype,
- 'enabled' => 1
+ 'enabled' => self::MESSAGE_CONVERSATION_AREA_ENABLED
]
);
}
$conversationarea = new \stdClass();
$conversationarea->id = $conversationareaid;
- $conversationarea->enabled = 1;
+ $conversationarea->enabled = self::MESSAGE_CONVERSATION_AREA_ENABLED;
$conversationarea->timemodified = time();
$DB->update_record('message_conversation_area', $conversationarea);
}
$conversationarea = new \stdClass();
$conversationarea->id = $conversationareaid;
- $conversationarea->enabled = 0;
+ $conversationarea->enabled = self::MESSAGE_CONVERSATION_AREA_DISABLED;
$conversationarea->timemodified = time();
$DB->update_record('message_conversation_area', $conversationarea);
}
$contextid = 111;
$itemid = 222;
$name = 'Name of conversation';
- $conversationarea = \core_message\api::create_conversation_area('core_group', 'groups', $itemid, $contextid, $name, 0);
+ $conversationarea = \core_message\api::create_conversation_area('core_group', 'groups', $itemid, $contextid, $name);
$this->assertEquals($itemid, $conversationarea->itemid);
$this->assertEquals($contextid, $conversationarea->contextid);
$this->assertEquals('core_group', $conversationarea->component);
$this->assertEquals('groups', $conversationarea->itemtype);
- $this->assertEquals(0, $conversationarea->enabled);
+ $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_AREA_DISABLED, $conversationarea->enabled);
}
/**
$contextid = 111;
$itemid = 222;
$name = 'Name of conversation';
- \core_message\api::create_conversation_area('core_group', 'groups', $itemid, $contextid, $name, 1);
+ \core_message\api::create_conversation_area('core_group', 'groups', $itemid, $contextid, $name,
+ \core_message\api::MESSAGE_CONVERSATION_AREA_ENABLED);
$conversationarea = \core_message\api::get_conversation_area('core_group', 'groups', $itemid, $contextid);
$this->assertEquals($itemid, $conversationarea->itemid);
$this->assertEquals($contextid, $conversationarea->contextid);
$this->assertEquals('core_group', $conversationarea->component);
$this->assertEquals('groups', $conversationarea->itemtype);
- $this->assertEquals(1, $conversationarea->enabled);
+ $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_AREA_ENABLED, $conversationarea->enabled);
}
/**
$contextid = 111;
$itemid = 222;
$name = 'Name of conversation';
- $conversationarea = \core_message\api::create_conversation_area('core_group', 'groups', $itemid, $contextid, $name, 0);
+
+ $conversationarea = \core_message\api::create_conversation_area('core_group', 'groups', $itemid, $contextid, $name);
\core_message\api::enable_conversation_area($conversationarea->id);
$conversationareaenabled = $DB->get_field('message_conversation_area', 'enabled', ['id' => $conversationarea->id]);
- $this->assertEquals(1, $conversationareaenabled);
+ $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_AREA_ENABLED, $conversationareaenabled);
}
/**
$contextid = 111;
$itemid = 222;
$name = 'Name of conversation';
- $conversationarea = \core_message\api::create_conversation_area('core_group', 'groups', $itemid, $contextid, $name, 1);
- $this->assertEquals(1, $conversationarea->enabled);
+
+ $conversationarea = \core_message\api::create_conversation_area('core_group', 'groups', $itemid, $contextid, $name,
+ \core_message\api::MESSAGE_CONVERSATION_AREA_ENABLED);
+ $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_AREA_ENABLED, $conversationarea->enabled);
\core_message\api::disable_conversation_area($conversationarea->id);
$conversationareaenabled = $DB->get_field('message_conversation_area', 'enabled', ['id' => $conversationarea->id]);
- $this->assertEquals(0, $conversationareaenabled);
+ $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_AREA_DISABLED, $conversationareaenabled);
}
/**
* Test update_conversation_name.
$contextid = 111;
$itemid = 222;
$name = 'Name of conversation';
- $conversationarea = \core_message\api::create_conversation_area('core_group', 'groups', $itemid, $contextid, $name, 1);
+
+ $conversationarea = \core_message\api::create_conversation_area('core_group', 'groups', $itemid, $contextid, $name);
$newname = 'New name of conversation';
\core_message\api::update_conversation_name($conversationarea->conversationid, $newname);