class.ilOrgUnitOperationQueries.php

Go to the documentation of this file.

<?php
class ilOrgUnitOperationQueries
{
    public static function registerNewOperation(
        string $operation_name,
        string $description,
        string $context = ilOrgUnitOperationContext::CONTEXT_OBJECT
    ): void {
        $contextList = ilOrgUnitOperationContext::where(array('context' => $context));
        if (!$contextList->hasSets()) {
            throw new ilException('Context does not exist! register context first using ilOrgUnitOperationContext::registerNewContext()');
        }
        $ilOrgUnitOperationContext = $contextList->first();

        if (ilOrgUnitOperation::where(array(
            'context_id' => $ilOrgUnitOperationContext->getId(),
            'operation_string' => $operation_name,
        ))->hasSets()
        ) {
            throw new ilException('This operation in this context has already been registered.');
        }
        $operation = new ilOrgUnitOperation();
        $operation->setOperationString($operation_name);
        $operation->setContextId($ilOrgUnitOperationContext->getId());
        $operation->setDescription($description);
        $operation->create();
    }

    public static function registerNewOperationForMultipleContexts(
        string $operation_name,
        string $description,
        array $contexts
    ): void {
        foreach ($contexts as $context) {
            self::registerNewOperation($operation_name, $description, $context);
        }
    }

    public static function getOperationsForContextName(string $context_name): array
    {
        $context = ilOrgUnitOperationContextQueries::findByName($context_name);
        return ilOrgUnitOperation::where(array('context_id' => $context->getPopulatedContextIds()))
                                 ->get();
    }

    public static function getOperationsForContextId(string $context_id): array
    {
        $context = ilOrgUnitOperationContextQueries::findById($context_id);
        return ilOrgUnitOperation::where(array('context_id' => $context->getPopulatedContextIds()))
                                 ->get();
    }

    public static function findById(int $operation_id): ActiveRecord /* ilOrgUnitOperation|ActiveRecord */
    {
        return ilOrgUnitOperation::findOrFail($operation_id);
    }

    public static function findByOperationString(
        string $operation_string,
        string $context_name
    ): ?ActiveRecord /*ilOrgUnitOperation|ActiveRecord*/ {
        $context = ilOrgUnitOperationContextQueries::findByName($context_name);

        return ilOrgUnitOperation::where(['operation_string' => $operation_string,
                                          'context_id' => $context->getId()
        ])->first();
    }
}