Soheilrt\AdobeConnectClient\Client\Entities\Permission

Complexity

Total Complexity

1

Size/Duplication

Total Lines	128
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	instance()	0	3	1

<?php

namespace Soheilrt\AdobeConnectClient\Client\Entities;

use Soheilrt\AdobeConnectClient\Client\Contracts\ArrayableInterface;
use Soheilrt\AdobeConnectClient\Client\Traits\Arrayable;
use Soheilrt\AdobeConnectClient\Client\Traits\Fillable;
use Soheilrt\AdobeConnectClient\Client\Traits\PropertyCaller;

/**
 * Adobe Connect Permission.
 *
 * See {@link https://helpx.adobe.com/adobe-connect/webservices/common-xml-elements-attributes.html#permission_id}
 *
 * @property int|string|mixed|null $acl_id       ACL (Access Control List) ID. Usually a SCO ID or Principal ID.
 * @property int|string|mixed|null $permission_id
 * @property int|string|mixed|null $principal_id Normally is int, but in special cases is string using the MEETING_* constants *
 *
 * @method int|string|mixed|null getAclId()       ACL -Access Control List- ID. Usually a SCO ID or Principal ID.
 * @method int|string|mixed|null getPermissionId()
 * @method int|string|mixed|null getPrincipalId() Normally is int, but in special cases is string using the MEETING_* constants
 *
 * @method Permission setAclId($value)       ACL (Access Control List) ID. Usually a SCO ID or Principal ID.
 * @method Permission setPermissionId($value)
 * @method Permission setPrincipalId($value) Normally is int, but in special cases is string using the MEETING_* constants *
 */
class Permission implements ArrayableInterface
{
    use Arrayable, PropertyCaller,Fillable;

    /**
     * Special permission for Meeting.
     *
     * This Constant is used in the principal-id parameter with the others MEETING_* constants.
     *
     * @var string
     */
    public const MEETING_PRINCIPAL_PUBLIC_ACCESS = 'public-access';

    /**
     * Special permission for Meeting.
     *
     * Need set principal-id parameter with Permission::MEETING_PRINCIPAL_PUBLIC_ACCESS
     *
     * The meeting is public, and anyone who has the URL for the meeting can enter the room.
     *
     * @var string
     */
    public const MEETING_ANYONE_WITH_URL = 'view-hidden';

    /**
     * Special permission for Meeting.
     *
     * Need set principal-id parameter with Permission::MEETING_PRINCIPAL_PUBLIC_ACCESS
     *
     * The meeting is protected and only registered users and accepted guests can enter the room.
     *
     * @var string
     */
    public const MEETING_PROTECTED = 'remove';

    /**
     * Special permission for Meeting.
     *
     * Need set principal-id parameter with Permission::MEETING_PRINCIPAL_PUBLIC_ACCESS
     *
     * The meeting is private and only registered users and participants can enter the room.
     *
     * @var string
     */
    public const MEETING_PRIVATE = 'denied';

    /**
     * Special permission for Recording.
     *
     * The recording is public.
     *
     * @var string
     */
    public const RECORDING_PUBLIC = 'view';

    /**
     * The principal can view, but cannot modify, the SCO.
     * The principal can take a course, attend a meeting as participant, or view a folder’s content.
     *
     * @var string
     */
    public const PRINCIPAL_VIEW = 'view';

    /**
     * Available for meetings only.
     *
     * The principal is host of a meeting and can create the meeting or act as presenter,
     * even without view permission on the meeting’s parent folder.
     *
     * @var string
     */
    public const PRINCIPAL_HOST = 'host';

    /**
     * Available for meetings only.
     *
     * The principal is presenter of a meeting and can present content, share a screen,
     * send text messages, moderate questions, create text notes, broadcast audio and video,
     * and push content from web links.
     *
     * @var string
     */
    public const PRINCIPAL_MINI_HOST = 'mini-host';

    /**
     * Available for meetings only.
     *
     * The principal does not have participant, presenter or host permission to attend the meeting.
     * If a user is already attending a live meeting, the user is not removed from the meeting until
     * the session times out.
     *
     * @var string
     */
    public const PRINCIPAL_REMOVE = 'remove';

    /**
     * Available for SCOs other than meetings.
     *
     * The principal can publish or update the SCO.
     * The publish permission includes view and allows the principal to view reports related to the SCO.
     * On a folder, publish does not allow the principal to create new subfolders or set permissions.
     *
     * @var string
     */
    public const PRINCIPAL_PUBLISH = 'publish';

    /**
     * Available for SCOs other than meetings or courses.
     *
     * The principal can view, delete, move, edit, or set permissions on the SCO.
     * On a folder, the principal can create subfolders or view reports on folder content.
     *
     * @var string
     */
    public const PRINCIPAL_MANAGE = 'manage';

    /**
     * Available for SCOs other than meetings.
     *
     * The principal cannot view, access, or manage the SCO.
     *
     * @var string
     */
    public const PRINCIPAL_DENIED = 'denied';

    public static function instance(): Permission
    {
        return new static();
    }
}