Document the usage of the new permission tool "role_exists"

[3D-I]

Working example

namespace phpbbstudio\mnote\migrations;

class install_permissions extends \phpbb\db\migration\migration
{
	public function effectively_installed()
	{
		$sql = 'SELECT * FROM ' . $this->table_prefix . "acl_options
			WHERE auth_option = '" . $this->db->sql_escape('a_phpbbstudio_mnote') . "'";
		$result = $this->db->sql_query_limit($sql, 1);
		$row = $this->db->sql_fetchrow($result);
		$this->db->sql_freeresult($result);

		return $row !== false;
	}

	public static function depends_on()
	{
		return ['\phpbb\db\migration\data\v33x\v334'];
	}

	public function update_data()
	{
		return [
			// Add permissions not set
			['permission.add', ['a_phpbbstudio_mnote']],
			['permission.add', ['m_phpbbstudio_mnote']],

			// Set permission on role if it exists
			['if', [
				['permission.role_exists', ['ROLE_ADMIN_FULL']],
				['permission.permission_set', ['ROLE_ADMIN_FULL', 'a_phpbbstudio_mnote']],
			]],

			['if', [
				['permission.role_exists', ['ROLE_MOD_FULL']],
				['permission.permission_set', ['ROLE_MOD_FULL', 'm_phpbbstudio_mnote']],
			]],
		];
	}
}

[3D-I]

The effectively_installed() method here uses its own query instead of the native tool, just do not care, it works. 😉

[iMattPro]

I was like, when did we get that? 🧐

Oh. I added it. Like a year ago. 🤪

[3D-I]

Yes, you did it. 😜