[COMPONENTS] Documenting methods with high cognitive complexity, specifically in Group and Posting components

[PLUGINS][Directory] Updating docs, @params weren't set correctly
This commit is contained in:
2022-01-26 20:01:37 +00:00
parent 6a5312aca9
commit 16e7d6cff7
5 changed files with 53 additions and 8 deletions

View File

@@ -31,6 +31,14 @@ use Component\Collection\Util\Controller\CircleController;
class Circle extends CircleController
{
/**
* Render an existing ActorCircle with the given id as a Collection of Actors
*
* @param ActorCircle|int $circle_id the desired ActorCircle id
*
* @throws \App\Util\Exception\ServerException
* @throws ClientException
*/
public function circleById(int|ActorCircle $circle_id): array
{
$circle = \is_int($circle_id) ? ActorCircle::getByPK(['id' => $circle_id]) : $circle_id;