Organizations\Entity\Organization

Complexity

Total Complexity

84

Size/Duplication

Total Lines	812
Duplicated Lines	0 %

Test Coverage

Coverage

89.16%

Importance

Changes

0

46 Methods

Rating	Name	Duplication	Size	Complexity
A	getParent()	0	3	3
A	getEmployee()	0	12	4
A	setImage()	0	5	1
B	getPermissionsUserIds()	0	39	11
A	setWorkflowSettings()	0	5	1
A	getContact()	0	7	2
A	setPermissions()	0	9	2
A	getImage()	0	7	4
A	getUser()	0	3	1
A	getPermissions()	0	11	3
A	getProfileSetting()	0	3	1
A	setOrganizationName()	0	10	2
A	setUser()	0	9	2
A	getPermissionsResourceId()	0	3	1
A	getEmployees()	0	12	3
A	getResourceId()	0	3	1
A	setParent()	0	5	1
A	getWorkflowSettings()	0	7	2
A	isHiringOrganization()	0	3	1
A	getDescription()	0	3	1
A	__construct()	0	3	1
A	setContact()	0	8	2
A	getOrganizationName()	0	3	1
A	getName()	0	7	2
A	removeImages()	0	5	1
A	getTemplate()	0	7	2
A	getHydrator()	0	3	1
A	getExternalId()	0	3	1
A	setProfileSetting()	0	5	1
A	getImages()	0	6	2
A	getSearchableProperties()	0	3	1
A	isOwner()	0	3	1
A	isEmployee()	0	3	2
A	getEmployeesByRole()	0	12	3
A	setEmployees()	0	8	2
A	setIsDraft()	0	5	1
A	getJobs()	0	3	1
A	isAssociated()	0	3	2
A	getHiringOrganizations()	0	3	1
A	setExternalId()	0	5	1
A	setTemplate()	0	5	1
A	setHydrator()	0	2	1
A	setDescription()	0	5	1
A	isDraft()	0	3	1
A	setImages()	0	5	1
A	updatePermissions()	0	21	3

<?php
/**
 * YAWIK
 *
 * @copyright https://yawik.org/COPYRIGHT.php
 * @license       MIT
 */

namespace Organizations\Entity;

use Auth\Entity\UserInterface;
use Core\Entity\AbstractIdentifiableModificationDateAwareEntity as BaseEntity;
use Core\Entity\Collection\ArrayCollection;
use Core\Entity\DraftableEntityInterface;
use Core\Entity\EntityInterface;
use Core\Entity\Hydrator\EntityHydrator;
use Core\Entity\ImageInterface;
use Core\Entity\ImageSet;
use Core\Entity\ImageSetInterface;
use Core\Entity\MetaDataProviderTrait;
use Core\Entity\Permissions;
use Core\Entity\PermissionsInterface;
use Doctrine\Common\Collections\Collection;
use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
use Laminas\Hydrator\HydratorInterface;
use Laminas\Permissions\Acl\Resource\ResourceInterface;

/**
 * The organization.
 *
 * @ODM\Document(collection="organizations", repositoryClass="Organizations\Repository\Organization")
 * @ODM\HasLifecycleCallbacks
 * @ODM\Indexes({
 *      @ODM\Index(keys={
 *          "_organizationName"="text"
 *      }, name="fulltext")
 * })
 ** @author Mathias Weitz <weitz@cross-solution.de>
 * @author Mathias Gelhausen <gelhausen@cross-solution.de>
 * @author Anthonius Munthi <me@itstoni.com>
 */
class Organization extends BaseEntity implements
    OrganizationInterface,
    DraftableEntityInterface,
    ResourceInterface
{
    use MetaDataProviderTrait;

    /**
     * Always enabled even if there are no active jobs
     */
    const PROFILE_ALWAYS_ENABLE     = 'always';

    /**
     * Hide if there are no jobs available
     */
    const PROFILE_ACTIVE_JOBS       = 'active-jobs';

    /**
     * Always disabled profile
     */
    const PROFILE_DISABLED          = 'disabled';

    /**
     * Event name of post construct event.
     *
     * @var string
     */
    const postConstruct = 'postRepositoryConstruct';

    /**
     * externalId. Allows external applications to reference their primary key.
     *
     * @var string
     * @ODM\Field(type="string")
     * @ODM\Index
     */
    protected $externalId;

    /**
     * The actual name of the organization.
     *
     * @var \Organizations\Entity\OrganizationName
     * @ODM\ReferenceOne(targetDocument="\Organizations\Entity\OrganizationName", storeAs="id", cascade="persist")
     */
    protected $organizationName;

    /**
     * Only for sorting/searching purposes
     *
     * @var string
     * @ODM\Field(type="string")
     */
    protected $_organizationName;

    /**
     * Assigned permissions.
     *
     * @var PermissionsInterface
     * @ODM\EmbedOne(targetDocument="\Core\Entity\Permissions")
     */
    protected $permissions;

    /**
     * primary logo of an organization
     *
     * @var \Organizations\Entity\OrganizationImage
     * @ODM\ReferenceOne(targetDocument="\Organizations\Entity\OrganizationImage", inversedBy="organization", storeAs="id", nullable="true", cascade={"all"})
     */
    protected ?OrganizationImage $image = null;

    /**
     * @ODM\EmbedOne(targetDocument="Core\Entity\ImageSet")
     */
    protected ?ImageSetInterface $images = null;

    /**
     * Flag indicating draft state of this job.
     *
     * @var bool
     * @ODM\Field(type="bool")
     */
    protected $isDraft = false;

    /**
     * Organization contact data.
     *
     * @ODM\EmbedOne(targetDocument="\Organizations\Entity\OrganizationContact")
     */
    protected $contact;

    /**
     * The organizations' description.
     *
     * @var string
     * @ODM\Field(type="string")
     */
    protected $description;

    /**
     * The parent of this organization.
     *
     * @see   setParent()
     * @var OrganizationInterface | null
     * @ODM\ReferenceOne(targetDocument="\Organizations\Entity\Organization", storeAs="id", nullable=true)
     * @since 0.18
     */
    protected $parent;

    /**
     * The hiring organizations of this organization.
     *
     * @var Collection
     * @ODM\ReferenceMany(
     *      targetDocument="Organizations\Entity\Organization",
     *      repositoryMethod="getHiringOrganizationsCursor"
     * )
     * @since 0.18
     */
    protected $hiringOrganizations;

    /**
     * The associated employees (users)
     *
     * @ODM\EmbedMany(targetDocument="\Organizations\Entity\Employee")
     * @var Collection
     */
    protected $employees;

    /**
     * Jobs of this organization.
     *
     * @var Collection
     * @ODM\ReferenceMany(targetDocument="\Jobs\Entity\Job", storeAs="id", mappedBy="organization")
     * @since 0.18
     */
    protected $jobs;

    /**
     * the owner of a Organization
     *
     * @var UserInterface $user
     * @ODM\ReferenceOne(targetDocument="\Auth\Entity\User", storeAs="id", cascade={"all"})
     * @ODM\Index
     */
    protected $user;

    /**
     * Default values of an organizations job template
     *
     * @var TemplateInterface;
     * @ODM\EmbedOne(targetDocument="\Organizations\Entity\Template")
     */
    protected $template;

    /**
     * Default values Workflow
     *
     * @var WorkflowSettingsInterface $workflowSettings ;
     * @ODM\EmbedOne(targetDocument="\Organizations\Entity\WorkflowSettings")
     */
    protected $workflowSettings;

    /**
     * Profile Setting
     * @var string
     * @ODM\Field(type="string", nullable=true)
     */
    protected $profileSetting;

    public function __construct()
    {
        $this->images = new ImageSet();
    }

    /**
     * Sets the logo of an organization
     *
     * @param OrganizationImage $image
     *
     * @return self
     * @deprecated since 0.29; use $this->getImages()->set()
     */
    public function setImage(OrganizationImage $image = null)
    {
        $this->image = $image;

        return $this;
    }

    /**
     * @param string|bool $key
     * @return OrganizationImage|ImageInterface|null
     */
    public function getImage($key = ImageSet::ORIGINAL): ?OrganizationImage
    {
        if (is_bool($key)) {
            $key = $key ? ImageSet::THUMBNAIL : ImageSet::ORIGINAL;
        }

        return $this->getImages()->get($key, false) ?: $this->image;

The expression return $this->getImages()->get($key, false) ?: $this->image could return the type Core\Entity\ImageInterface which includes types incompatible with the type-hinted return Organizations\Entity\OrganizationImage|null. Consider adding an additional type-check to rule them out.

    }

    /**
     * @return string
     */
    public function getProfileSetting()
    {
        return $this->profileSetting;
    }

    /**
     * @param string $profileSetting
     *
     * @return $this
     */
    public function setProfileSetting($profileSetting)
    {
        $this->profileSetting = $profileSetting;

        return $this;
    }

    /**
     * Returns the string identifier of the Resource
     *
     * @return string
     */
    public function getResourceId()
    {
        return 'Entity/Organization';
    }

    /**
     * Gets the organization name
     *
     * @return string
     */
    public function getName()
    {
        if (empty($this->organizationName)) {
            return '';
        }

        return $this->organizationName->getName();
    }

    /**
     * Sets the parent of an organization
     *
     * @param OrganizationInterface $parent
     *
     * @return $this
     */
    public function setParent(OrganizationInterface $parent)
    {
        $this->parent = $parent;

        return $this;
    }

    /**
     * @deprecated
     * @return array
     */
    public function getSearchableProperties()
    {
        return array();
    }

    /**
     * Gets the parent of an organization
     *
     * @param bool $returnSelf returns itself, if this organization does not have a parent?
     *
     * @return null|OrganizationInterface
     */
    public function getParent($returnSelf = false)
    {
        return $this->parent ? : ($returnSelf ? $this : null);
    }

    /**
     * Gets the Draft flag
     *
     * @return bool
     */
    public function isDraft()
    {
        return $this->isDraft;
    }

    /**
     * Gets linked organizations
     *
     * @return Collection
     */
    public function getHiringOrganizations()
    {
        return $this->hiringOrganizations;
    }

    /**
     * Sets the draft flag
     *
     * @param bool $flag
     *
     * @return $this
     */
    public function setIsDraft($flag)
    {
        $this->isDraft = (bool) $flag;

        return $this;
    }

    /**
     * @return bool
     */
    public function isHiringOrganization()
    {
        return null !== $this->parent;
    }

    /**
     * Returns true, if the user belongs to the organization.
     *
     * @param UserInterface $user
     *
     * @return bool
     */
    public function isAssociated(UserInterface $user)
    {
        return $this->isOwner($user) || $this->isEmployee($user);
    }

    /**
     * Sets the external id.
     *
     * @param $externalId
     *
     * @return self
     */
    public function setExternalId($externalId)
    {
        $this->externalId = $externalId;

        return $this;
    }

    /**
     * Checks, if a User is the owner of an organization
     *
     * @param UserInterface $user
     *
     * @return bool
     */
    public function isOwner(UserInterface $user)
    {
        return $this->getUser()->getId() == $user->getId();
    }

    /**
     * Gets the internal id.
     *
     * @return string
     */
    public function getExternalId()
    {
        return $this->externalId;
    }

    /**
     * Returns true, if a User is an employee of the organization
     *
     * @param UserInterface $user
     *
     * @return bool
     */
    public function isEmployee(UserInterface $user)
    {
        return $this->refs && in_array($user->getId(), $this->refs->getEmployeeIds());

The property refs does not exist on Organizations\Entity\Organization. Since you implemented __get, consider adding a @property annotation.

    }

    /**
     * @todo review this
     *
     * @param HydratorInterface $hydrator
     *
     * @return $this
     */
    public function setHydrator(HydratorInterface $hydrator): void
    {

    }

    /**
     * Updates the organizationsPermissions to allow all employees to view this organization.
     *
     * In case of a HiringOrganization Permissions are granted to all employees of the parent
     * organization.
     *
     * @ODM\PreUpdate
     * @ODM\PrePersist
     * @since 0.18
     */
    public function updatePermissions()
    {
        if ($this->isHiringOrganization()) {
            $organization = $this->getParent();
            $owner        = $organization->getUser();

            $this->setUser($owner);
        } else {
            $organization = $this;
        }

        /* @var $employees null | ArrayCollection | \Doctrine\ODM\MongoDB\PersistentCollection */
        $employees = $organization->getEmployees();

        $perms = $this->getPermissions();

        foreach ($employees as $emp) {
            /* @var $emp \Organizations\Entity\Employee */
            $perms->grant($emp->getUser(), PermissionsInterface::PERMISSION_CHANGE, false);

The call to Core\Entity\PermissionsInterface::grant() has too many arguments starting with false.

        }
        $perms->build();

The method build() does not exist on Core\Entity\PermissionsInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Core\Entity\PermissionsInterface.

    }

    /**
     * * @todo review this
     * @return EntityHydrator
     */
    public function getHydrator(): ?HydratorInterface
    {
        return new EntityHydrator();
    }

    /**
     * Sets the name of an organization
     *
     * @param OrganizationName $organizationName
     *
     * @return $this
     */
    public function setOrganizationName(OrganizationName $organizationName)
    {
        if (isset($this->organizationName)) {
            $this->organizationName->refCounterDec()->refCompanyCounterDec();
        }
        $this->organizationName = $organizationName;
        $this->organizationName->refCounterInc()->refCompanyCounterInc();
        $this->_organizationName = $organizationName->getName();

        return $this;
    }

    /**
     * Gets the organization name entity of an organisation
     *
     * @return OrganizationName
     */
    public function getOrganizationName()
    {
        return $this->organizationName;
    }

    /**
     * Gets the Permissions of an organization
     *
     * @return PermissionsInterface
     */
    public function getPermissions()
    {
        if (!$this->permissions) {
            $permissions = new Permissions();
            if ($this->user) {
                $permissions->grant($this->user, Permissions::PERMISSION_ALL);
            }
            $this->setPermissions($permissions);
        }

        return $this->permissions;
    }

    /**
     * Sets the Permissions of an Organization
     *
     * @param PermissionsInterface $permissions
     *
     * @return $this
     */
    public function setPermissions(PermissionsInterface $permissions)
    {
        // Assure the user has always all rights.
        if ($this->user) {
            $permissions->grant($this->user, Permissions::PERMISSION_ALL);
        }
        $this->permissions = $permissions;

        return $this;
    }

    /**
     * Gets the Permissions Resource ID
     *
     * @return string
     */
    public function getPermissionsResourceId()
    {
        return 'organization:' . $this->getId();
    }

    /**
     * @param null $type

Are you sure the doc-type for parameter $type is correct as it would always require null to be passed?

     *
     * @return array
     */
    public function getPermissionsUserIds($type = null)
    {
        // if we have a user, grant him full access to all associated permissions.
        $user = $this->getUser();
        $spec = $user

$user is of type Auth\Entity\UserInterface, thus it always evaluated to true.

            ? $spec = array(PermissionsInterface::PERMISSION_ALL => array($this->getUser()->getId()))

The assignment to $spec is dead and can be removed.

            : array();

        if (null === $type || ('Job/Permissions' != $type && 'Application' != $type)) {

The condition null === $type is always true.

            return $spec;
        }

        if ('Job/Permissions' == $type) {
            $change = EmployeePermissionsInterface::JOBS_CHANGE;
            $view   = EmployeePermissionsInterface::JOBS_VIEW;
        } else {
            $change = EmployeePermissionsInterface::APPLICATIONS_CHANGE;
            $view   = EmployeePermissionsInterface::APPLICATIONS_VIEW;
        }

        $employees = $this->isHiringOrganization()
            ? $this->getParent()->getEmployees()
            : $this->getEmployees();

        foreach ($employees as $emp) {
            /* @var $emp EmployeeInterface */
            if ($emp->isUnassigned()) {
                continue;
            }

            $perm = $emp->getPermissions();
            if ($perm->isAllowed($change)) {
                $spec[PermissionsInterface::PERMISSION_CHANGE][] = $emp->getUser()->getId();
            } elseif ($perm->isAllowed($view)) {
                $spec[PermissionsInterface::PERMISSION_VIEW][] = $emp->getUser()->getId();
            }
        }

        return $spec;
    }

    /**
     * @param ImageSetInterface $images
     *
     * @return self
     */
    public function setImages(ImageSetInterface $images)
    {
        $this->images = $images;

        return $this;
    }

    /**
     * @return ImageSetInterface
     */
    public function getImages(): ?ImageSetInterface
    {
        if(is_null($this->images)){
            $this->images = new ImageSet();
        }
        return $this->images;

The expression return $this->images also could return the type Core\Entity\ImageSetInterface which includes types incompatible with the return type mandated by Organizations\Entity\OrganizationInterface::getImages() of Core\Entity\ImageSet. Consider adding a type-check to rule them out.

    }

    /**
     *
     *
     * @return self
     */
    public function removeImages()
    {
        $this->images = null;

        return $this;
    }

    /**
     * Sets the Contact Data of an organization
     *
     * @param EntityInterface $contact
     *
     * @return $this
     */
    public function setContact(EntityInterface $contact = null)
    {
        if (!$contact instanceof OrganizationContact) {
            $contact = new OrganizationContact($contact);

The call to Organizations\Entity\OrganizationContact::__construct() has too many arguments starting with $contact.

        }
        $this->contact = $contact;

        return $this;
    }

    /**
     * Gets the contact Data of an organization
     *
     * @return OrganizationContact
     */
    public function getContact()
    {
        if (!$this->contact instanceof OrganizationContact) {
            $this->contact = new OrganizationContact();
        }

        return $this->contact;
    }

    /**
     * Gets the default description of an organization.
     *
     * This description is used as the default of the company_description
     * used in a job template
     *
     * @return string
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * Set the default description af an organization
     *
     * @param string $description
     *
     * @return $this
     */
    public function setDescription($description)
    {
        $this->description = $description;

        return $this;
    }

    /**
     * Sets the the list of employees
     *
     * @param Collection $employees
     *
     * @return $this
     */
    public function setEmployees(Collection $employees)
    {
        /* todo: Throw exception or at least log incidents, where employees are added to "hiring orgs" */
        if (!$this->isHiringOrganization()) {
            $this->employees = $employees;
        }

        return $this;
    }

    /**
     * Gets the list of employees
     *
     * @return ArrayCollection|Collection
     */
    public function getEmployees()
    {
        if ($this->isHiringOrganization()) {
            // Always return empty list, as we never have employees in this case.
            return new ArrayCollection();
        }

        if (!$this->employees) {
            $this->setEmployees(new ArrayCollection());
        }

        return $this->employees;
    }

    /**
     * Gets an employee by User or ID.
     *
     * @param UserInterface|string $userOrId
     *
     * @return mixed|null
     */
    public function getEmployee($userOrId)
    {
        $employees = $this->getEmployees();
        $userId    = $userOrId instanceof \Auth\Entity\UserInterface ? $userOrId->getId() : $userOrId;

        foreach ($employees as $employee) {
            if ($employee->getUser()->getId() == $userId) {
                return $employee;
            }
        }

        return null;
    }

    /**
     * Gets a list of Employees by a user role
     *
     * @param string $role
     *
     * @return ArrayCollection
     */
    public function getEmployeesByRole($role)
    {
        $employees = new ArrayCollection();

        /* @var \Organizations\Entity\Employee $employee */
        foreach ($this->getEmployees() as $employee) {
            if ($role === $employee->getRole()) {
                $employees->add($employee);
            }
        }

        return $employees;
    }

    public function setUser(UserInterface $user)
    {
        if ($this->user) {
            $this->getPermissions()->revoke($this->user, Permissions::PERMISSION_ALL, false);
        }
        $this->user = $user;
        $this->getPermissions()->grant($user, Permissions::PERMISSION_ALL);

        return $this;
    }

    /**
     * Gets the owner of the organization
     *
     * @return UserInterface
     */
    public function getUser()
    {
        return $this->user;
    }

    /**
     * Gets the Jobs of an organization
     *
     * @return Collection
     */
    public function getJobs()
    {
        return $this->jobs;
    }

    /**
     * Gets default values of an organizations job template
     *
     * @return TemplateInterface
     */
    public function getTemplate()
    {
        if (null === $this->template) {
            $this->template = new Template();
        }

        return $this->template;
    }

    /**
     * Sets default values of an organizations job template
     *
     * @return self
     */
    public function setTemplate(TemplateInterface $template)
    {
        $this->template = $template;

        return $this;
    }

    /**
     * Gets Workflow Settings
     *
     * @return WorkflowSettings|WorkflowSettingsInterface
     */
    public function getWorkflowSettings()
    {
        if (null == $this->workflowSettings) {
            $this->workflowSettings = new WorkflowSettings();
        }

        return $this->workflowSettings;
    }

    /**
     * Sets Workflow Settings
     *
     * @param $workflowSettings
     *
     * @return self
     */
    public function setWorkflowSettings($workflowSettings)
    {
        $this->workflowSettings = $workflowSettings;

        return $this;
    }
}