function createUser(string $username, string $password, array $properties = []): bool;
/**
* Delete an existing user
*
* @param string $username
* @return bool
*/
public function deleteUser(string $username): bool;
/**
* Update user properties
*
* @param string $username
* @param array $properties
* @return bool
*/
public function updateUser(string $username, array $properties): bool;
/**
* Change user password
*
* @param string $username
* @param string $newPassword
* @return bool
*/
public function changePassword(string $username, string $newPassword): bool;
/**
* Get user information
*
* @param string $username
* @return array|null
*/
public function getUser(string $username): ?array;
/**
* List all users
*
* @param int $offset
* @param int $limit
* @return array
*/
public function listUsers(int $offset = 0, int $limit = 100): array;
/**
* Check if user exists
*
* @param string $username
* @return bool
*/
public function userExists(string $username): bool;
/**
* Get user's principal URL
*
* @param string $username
* @return string|null
*/
public function getUserPrincipalUrl(string $username): ?string;
/**
* Create a calendar for a user and generate an ICS feed link
*
* @param string $username
* @param string $calendarName
* @param array $options Calendar options (color, description, etc.)
* @return array{calendar_url: string, ics_url: string}|null
*/
public function createUserCalendarWithFeed(string $username, string $calendarName, array $options = []): ?array;
}
âī¸ Parameters
$username(string)
$password(string)
$properties(array) Additional user properties (email, display name, etc.)
âŠī¸ Returns
(bool)
đ§ deleteUser
Delete an existing user
function deleteUser(string $username): bool;
/**
* Update user properties
*
* @param string $username
* @param array $properties
* @return bool
*/
public function updateUser(string $username, array $properties): bool;
/**
* Change user password
*
* @param string $username
* @param string $newPassword
* @return bool
*/
public function changePassword(string $username, string $newPassword): bool;
/**
* Get user information
*
* @param string $username
* @return array|null
*/
public function getUser(string $username): ?array;
/**
* List all users
*
* @param int $offset
* @param int $limit
* @return array
*/
public function listUsers(int $offset = 0, int $limit = 100): array;
/**
* Check if user exists
*
* @param string $username
* @return bool
*/
public function userExists(string $username): bool;
/**
* Get user's principal URL
*
* @param string $username
* @return string|null
*/
public function getUserPrincipalUrl(string $username): ?string;
/**
* Create a calendar for a user and generate an ICS feed link
*
* @param string $username
* @param string $calendarName
* @param array $options Calendar options (color, description, etc.)
* @return array{calendar_url: string, ics_url: string}|null
*/
public function createUserCalendarWithFeed(string $username, string $calendarName, array $options = []): ?array;
}
âī¸ Parameters
$username(string)
âŠī¸ Returns
(bool)
đ§ updateUser
Update user properties
function updateUser(string $username, array $properties): bool;
/**
* Change user password
*
* @param string $username
* @param string $newPassword
* @return bool
*/
public function changePassword(string $username, string $newPassword): bool;
/**
* Get user information
*
* @param string $username
* @return array|null
*/
public function getUser(string $username): ?array;
/**
* List all users
*
* @param int $offset
* @param int $limit
* @return array
*/
public function listUsers(int $offset = 0, int $limit = 100): array;
/**
* Check if user exists
*
* @param string $username
* @return bool
*/
public function userExists(string $username): bool;
/**
* Get user's principal URL
*
* @param string $username
* @return string|null
*/
public function getUserPrincipalUrl(string $username): ?string;
/**
* Create a calendar for a user and generate an ICS feed link
*
* @param string $username
* @param string $calendarName
* @param array $options Calendar options (color, description, etc.)
* @return array{calendar_url: string, ics_url: string}|null
*/
public function createUserCalendarWithFeed(string $username, string $calendarName, array $options = []): ?array;
}
âī¸ Parameters
$username(string)
$properties(array)
âŠī¸ Returns
(bool)
đ§ changePassword
Change user password
function changePassword(string $username, string $newPassword): bool;
/**
* Get user information
*
* @param string $username
* @return array|null
*/
public function getUser(string $username): ?array;
/**
* List all users
*
* @param int $offset
* @param int $limit
* @return array
*/
public function listUsers(int $offset = 0, int $limit = 100): array;
/**
* Check if user exists
*
* @param string $username
* @return bool
*/
public function userExists(string $username): bool;
/**
* Get user's principal URL
*
* @param string $username
* @return string|null
*/
public function getUserPrincipalUrl(string $username): ?string;
/**
* Create a calendar for a user and generate an ICS feed link
*
* @param string $username
* @param string $calendarName
* @param array $options Calendar options (color, description, etc.)
* @return array{calendar_url: string, ics_url: string}|null
*/
public function createUserCalendarWithFeed(string $username, string $calendarName, array $options = []): ?array;
}
âī¸ Parameters
$username(string)
$newPassword(string)
âŠī¸ Returns
(bool)
đ§ getUser
Get user information
function getUser(string $username): ?array;
/**
* List all users
*
* @param int $offset
* @param int $limit
* @return array
*/
public function listUsers(int $offset = 0, int $limit = 100): array;
/**
* Check if user exists
*
* @param string $username
* @return bool
*/
public function userExists(string $username): bool;
/**
* Get user's principal URL
*
* @param string $username
* @return string|null
*/
public function getUserPrincipalUrl(string $username): ?string;
/**
* Create a calendar for a user and generate an ICS feed link
*
* @param string $username
* @param string $calendarName
* @param array $options Calendar options (color, description, etc.)
* @return array{calendar_url: string, ics_url: string}|null
*/
public function createUserCalendarWithFeed(string $username, string $calendarName, array $options = []): ?array;
}
âī¸ Parameters
$username(string)
âŠī¸ Returns
(array|null)
đ§ listUsers
List all users
function listUsers(int $offset = 0, int $limit = 100): array;
/**
* Check if user exists
*
* @param string $username
* @return bool
*/
public function userExists(string $username): bool;
/**
* Get user's principal URL
*
* @param string $username
* @return string|null
*/
public function getUserPrincipalUrl(string $username): ?string;
/**
* Create a calendar for a user and generate an ICS feed link
*
* @param string $username
* @param string $calendarName
* @param array $options Calendar options (color, description, etc.)
* @return array{calendar_url: string, ics_url: string}|null
*/
public function createUserCalendarWithFeed(string $username, string $calendarName, array $options = []): ?array;
}
âī¸ Parameters
$offset(int)
$limit(int)
âŠī¸ Returns
(array)
đ§ userExists
Check if user exists
function userExists(string $username): bool;
/**
* Get user's principal URL
*
* @param string $username
* @return string|null
*/
public function getUserPrincipalUrl(string $username): ?string;
/**
* Create a calendar for a user and generate an ICS feed link
*
* @param string $username
* @param string $calendarName
* @param array $options Calendar options (color, description, etc.)
* @return array{calendar_url: string, ics_url: string}|null
*/
public function createUserCalendarWithFeed(string $username, string $calendarName, array $options = []): ?array;
}
âī¸ Parameters
$username(string)
âŠī¸ Returns
(bool)
đ§ getUserPrincipalUrl
Get user's principal URL
function getUserPrincipalUrl(string $username): ?string;
/**
* Create a calendar for a user and generate an ICS feed link
*
* @param string $username
* @param string $calendarName
* @param array $options Calendar options (color, description, etc.)
* @return array{calendar_url: string, ics_url: string}|null
*/
public function createUserCalendarWithFeed(string $username, string $calendarName, array $options = []): ?array;
}
âī¸ Parameters
$username(string)
âŠī¸ Returns
(string|null)
đ§ createUserCalendarWithFeed
Create a calendar for a user and generate an ICS feed link