EntryNotFoundException.php

<?php
/*
 * 2017 Romain CANON <romain.hydrocanon@gmail.com>
 *
 * This file is part of the TYPO3 FormZ project.
 * It is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, either
 * version 3 of the License, or any later version.
 *
 * For the full copyright and license information, see:
 * http://www.gnu.org/licenses/gpl-3.0.html
 */

namespace Romm\Formz\Exceptions;

use Romm\Formz\Configuration\Configuration;
use Romm\Formz\Configuration\View\Classes\ViewClass;
use Romm\Formz\Configuration\View\Layouts\LayoutGroup;
use Romm\Formz\Configuration\View\View;
use Romm\Formz\Form\Definition\Field\Field;
use Romm\Formz\Form\Definition\Field\Validation\Validator;
use Romm\Formz\Form\Definition\FormDefinition;
use Romm\Formz\Form\FormInterface;
use Romm\Formz\Form\FormObject\FormObject;
use Romm\Formz\Form\FormObject\FormObjectFactory;
use Romm\Formz\Validation\Field\AbstractFieldValidator;
use Romm\Formz\ViewHelpers\ClassViewHelper;
use Romm\Formz\ViewHelpers\FieldViewHelper;
use Romm\Formz\ViewHelpers\FormatMessageViewHelper;

class EntryNotFoundException extends FormzException
{
    const FIELD_NOT_FOUND = 'The field "%s" was not found in the form "%s" with class "%s".';

    const CONDITION_NOT_FOUND = 'Trying to access a condition which is not registered: "%s". Here is a list of all currently registered conditions: "%s".';

    const FORM_ADD_CONDITION_NOT_FOUND = 'Trying to add a condition "%s" which is not registered to the form definition. Here is a list of all currently registered conditions: "%s".';

    const ACTIVATION_ADD_CONDITION_NOT_FOUND = 'Trying to add a condition "%s" which is not registered to the activation. Here is a list of all currently registered conditions: "%s".';

    const INSTANTIATE_CONDITION_NOT_FOUND = 'Trying to instantiate a condition which is not registered: "%s". Here is a list of all currently registered conditions: "%s".';

    const ACTIVATION_CONDITION_NOT_FOUND = 'No condition "%s" was found.';

    const CONFIGURATION_FIELD_NOT_FOUND = 'The field "%s" was not found. Please use the function `%s::hasField()` before.';

    const VALIDATOR_NOT_FOUND = 'The validation "%s" was not found. Please use the function `%s::hasValidator()` before.';

    const BEHAVIOUR_NOT_FOUND = 'The behaviour "%s" was not found. Please use the function `%s::hasBehaviour()` before.';

    const MESSAGE_NOT_FOUND = 'The message "%s" was not found. Please use the function `%s::hasMessage()` before.';

    const VIEW_LAYOUT_NOT_FOUND = 'The layout "%s" was not found. Please use the function `%s::hasLayout()` before.';

    const VIEW_LAYOUT_ITEM_NOT_FOUND = 'The layout item "%s" was not found. Please use the function `%s::hasItem()` before.';

    const VIEW_CLASS_NOT_FOUND = 'The class "%s" was not found. Please use the function `%s::hasItem()` before.';

    const VALIDATION_NOT_FOUND_FOR_FIELD = 'The field "%s" does not have a rule "%s".';

    const ERROR_KEY_NOT_FOUND_FOR_VALIDATOR = 'The error key "%s" does not exist for the validator "%s".';

    const VIEW_HELPER_FIELD_NOT_FOUND = 'The field could not be fetched for the view helper "%s": please either use this view helper inside the view helper "%s", or fill the parameter `field` of this view helper with the field name you want.';

    const FIELD_VIEW_HELPER_LAYOUT_NOT_FOUND = 'The layout "%s" could not be found. Please check your TypoScript configuration.';

    const FIELD_VIEW_HELPER_LAYOUT_ITEM_NOT_FOUND = 'The layout "%s" does not have an item "%s".';

    const CONTROLLER_SERVICE_ACTION_FORM_ARGUMENT_MISSING = 'The method `%s::%s()` must have a parameter `$%s`. Note that you can also change the parameter `name` of the form view helper.';

    const SLOT_NOT_FOUND = 'No slot "%s" was found.';

    const FORM_CONFIGURATION_NOT_FOUND = 'The configuration for form of class "%s" was not found. Please use the function `%s::hasForm()` before.';

    const CONDITION_NOT_FOUND_IN_DEFINITION = 'The condition "%s" was not found in the form definition. Please use the function `%s::hasCondition()` before.';

    const CONDITION_DOES_NOT_EXIST = 'The condition "%s" does not exist';

    const FORM_OBJECT_INSTANCE_NOT_FOUND = 'The form instance for the object of type "%s" was not found. Please take care of registering it before with "%s::registerFormInstance()".';

    /**
     * @code 1472650209
     *
     * @param string $identifier
     * @param array  $list
     * @return self
     */
    final public static function conditionNotFound($identifier, array $list)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::CONDITION_NOT_FOUND,
            [
                $identifier,
                implode('" ,"', array_keys($list))
            ]
        );

        return $exception;
    }

    /**
     * @code 1493890438
     *
     * @param string $identifier
     * @param array  $list
     * @return self
     */
    final public static function formAddConditionNotFound($identifier, array $list)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::FORM_ADD_CONDITION_NOT_FOUND,
            [
                $identifier,
                implode('" ,"', array_keys($list))
            ]
        );

        return $exception;
    }

    /**
     * @code 1494329341
     *
     * @param string $identifier
     * @param array  $list
     * @return self
     */
    final public static function activationAddConditionNotFound($identifier, array $list)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::ACTIVATION_ADD_CONDITION_NOT_FOUND,
            [
                $identifier,
                implode('" ,"', array_keys($list))
            ]
        );

        return $exception;
    }

    /**
     * @code 1493890825
     *
     * @param string $identifier
     * @param array  $list
     * @return self
     */
    final public static function instantiateConditionNotFound($identifier, array $list)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::INSTANTIATE_CONDITION_NOT_FOUND,
            [
                $identifier,
                implode('" ,"', array_keys($list))
            ]
        );

        return $exception;
    }

    /**
     * @code 1488482191
     *
     * @param string $name
     * @return self
     */
    final public static function activationConditionNotFound($name)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::ACTIVATION_CONDITION_NOT_FOUND,
            [$name]
        );

        return $exception;
    }

    /**
     * @code 1489765133
     *
     * @param string $name
     * @return self
     */
    final public static function configurationFieldNotFound($name)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::CONFIGURATION_FIELD_NOT_FOUND,
            [$name, FormDefinition::class]
        );

        return $exception;
    }

    /**
     * @code 1487672276
     *
     * @param string $name
     * @return self
     */
    final public static function validatorNotFound($name)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::VALIDATOR_NOT_FOUND,
            [$name, Field::class]
        );

        return $exception;
    }

    /**
     * @code 1494685753
     *
     * @param string $name
     * @return self
     */
    final public static function behaviourNotFound($name)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::BEHAVIOUR_NOT_FOUND,
            [$name, Field::class]
        );

        return $exception;
    }

    /**
     * @code 1494694474
     *
     * @param string $name
     * @return self
     */
    final public static function messageNotFound($name)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::MESSAGE_NOT_FOUND,
            [$name, Validator::class]
        );

        return $exception;
    }

    /**
     * @code 1489753952
     *
     * @param string $name
     * @return self
     */
    final public static function viewLayoutNotFound($name)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::VIEW_LAYOUT_NOT_FOUND,
            [$name, View::class]
        );

        return $exception;
    }

    /**
     * @code 1489757511
     *
     * @param string $name
     * @return self
     */
    final public static function viewLayoutItemNotFound($name)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::VIEW_LAYOUT_ITEM_NOT_FOUND,
            [$name, LayoutGroup::class]
        );

        return $exception;
    }

    /**
     * @code 1489754909
     *
     * @param string $name
     * @return self
     */
    final public static function viewClassNotFound($name)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::VIEW_CLASS_NOT_FOUND,
            [$name, ViewClass::class]
        );

        return $exception;
    }

    /**
     * @code 1487672956
     *
     * @param string $validationName
     * @param string $fieldName
     * @return self
     */
    final public static function ajaxControllerValidationNotFoundForField($validationName, $fieldName)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::VALIDATION_NOT_FOUND_FOR_FIELD,
            [$fieldName, $validationName]
        );

        return $exception;
    }

    /**
     * @code 1487671603
     *
     * @param string     $fieldName
     * @param FormObject $formObject
     * @return self
     */
    final public static function ajaxControllerFieldNotFound($fieldName, FormObject $formObject)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::FIELD_NOT_FOUND,
            [$fieldName, $formObject->getName(), $formObject->getClassName()]
        );

        return $exception;
    }

    /**
     * @code 1455272659
     *
     * @param string                 $key
     * @param AbstractFieldValidator $validator
     * @return self
     */
    final public static function errorKeyNotFoundForValidator($key, AbstractFieldValidator $validator)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::ERROR_KEY_NOT_FOUND_FOR_VALIDATOR,
            [$key, get_class($validator)]
        );

        return $exception;
    }

    /**
     * @code 1487947224
     *
     * @param string     $fieldName
     * @param FormObject $formObject
     * @return self
     */
    final public static function equalsToFieldValidatorFieldNotFound($fieldName, FormObject $formObject)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::FIELD_NOT_FOUND,
            [$fieldName, $formObject->getName(), $formObject->getClassName()]
        );

        return $exception;
    }

    /**
     * @code 1467623761
     *
     * @return self
     */
    final public static function classViewHelperFieldNotFound()
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::VIEW_HELPER_FIELD_NOT_FOUND,
            [ClassViewHelper::class, FieldViewHelper::class]
        );

        return $exception;
    }

    /**
     * @code 1467624152
     *
     * @param string $fieldName
     * @return self
     */
    final public static function formatMessageViewHelperFieldNotFound($fieldName)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::VIEW_HELPER_FIELD_NOT_FOUND,
            [$fieldName, FormatMessageViewHelper::class, FieldViewHelper::class]
        );

        return $exception;
    }

    /**
     * @code 1465243586
     *
     * @param string $layoutName
     * @return self
     */
    final public static function fieldViewHelperLayoutNotFound($layoutName)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::FIELD_VIEW_HELPER_LAYOUT_NOT_FOUND,
            [$layoutName]
        );

        return $exception;
    }

    /**
     * @code 1485867803
     *
     * @param string $layoutName
     * @param string $itemName
     * @return self
     */
    final public static function fieldViewHelperLayoutItemNotFound($layoutName, $itemName)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::FIELD_VIEW_HELPER_LAYOUT_ITEM_NOT_FOUND,
            [$layoutName, $itemName]
        );

        return $exception;
    }

    /**
     * @code 1473084335
     *
     * @param string     $fieldName
     * @param FormObject $formObject
     * @return self
     */
    final public static function formatMessageViewHelperFieldNotFoundInForm($fieldName, FormObject $formObject)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::FIELD_NOT_FOUND,
            [$fieldName, $formObject->getName(), $formObject->getClassName()]
        );

        return $exception;
    }

    /**
     * @code 1457441846
     *
     * @param string $controllerObjectName
     * @param string $actionName
     * @param string $formName
     * @return self
     */
    final public static function controllerServiceActionFormArgumentMissing($controllerObjectName, $actionName, $formName)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::CONTROLLER_SERVICE_ACTION_FORM_ARGUMENT_MISSING,
            [$controllerObjectName, $actionName . 'Action', $formName]
        );

        return $exception;
    }

    /**
     * @code 1488988452
     *
     * @param string $name
     * @return self
     */
    final public static function slotClosureSlotNotFound($name)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::SLOT_NOT_FOUND,
            [$name]
        );

        return $exception;
    }

    /**
     * @code 1489497046
     *
     * @param string $name
     * @return self
     */
    final public static function slotArgumentsSlotNotFound($name)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::SLOT_NOT_FOUND,
            [$name]
        );

        return $exception;
    }

    /**
     * @code 1491997168
     *
     * @return self
     */
    final public static function formConfigurationNotFound()
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::FORM_CONFIGURATION_NOT_FOUND,
            [Configuration::class]
        );

        return $exception;
    }

    /**
     * @code 1493881671
     *
     * @param string $name
     * @return self
     */
    final public static function conditionNotFoundInDefinition($name)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::CONDITION_NOT_FOUND_IN_DEFINITION,
            [$name, Configuration::class]
        );

        return $exception;
    }

    /**
     * @code 1494514957
     *
     * @param FormInterface $form
     * @return self
     */
    final public static function formObjectInstanceNotFound(FormInterface $form)
    {
        /** @var self $exception */
        $exception = self::getNewExceptionInstance(
            self::FORM_OBJECT_INSTANCE_NOT_FOUND,
            [get_class($form), FormObjectFactory::class]
        );

        return $exception;
    }
}