Skip to content

5.1.0

Compare
Choose a tag to compare
@lcharette lcharette released this 22 Mar 02:14
· 17 commits to 5.1 since this release
3deed7a

What's changed

  • Removed Assets
  • Drop PHP 8.1 support, add PHP 8.3 support
  • Update to Laravel 10
  • Update to PHPUnit 10
  • SprinkleManager is a bit more strict on argument types. Recipe classed must be a class-string. The actual instance of the class will now be rejected (it wasn't a documented feature anyway).

Fortress

Complete refactoring of Fortress. Mostly enforcing strict types, updating PHPDocs, simplifying code logic and making uses of new PHP features and method. Most classes have been deprecated and replaced by new classes with updated implementation. In general, instead of passing the schema in the constructor of Adapters, Transformers and Validators class, you pass it directly to theses class methods. This makes it easier to inject the classes as services and reuse the same instance with different schemas. Checkout the documentation for more information on new class usage.

  • UserFrosting\Fortress\RequestSchema constructor first argument now accept the schema data as an array, as well as a string representing a path to the schema json or yaml file. The argument can still be omitted to create an empty schema. This change makes UserFrosting\Fortress\RequestSchema\RequestSchemaRepository obsolete and and such been deprecated. For example:

    // Before
    $schemaFromFile = new \UserFrosting\Fortress\RequestSchema('path/to/schema.json');
    $schemaFromArray = new \UserFrosting\Fortress\RequestSchema\RequestSchemaRepository([
      // ...
    ]);
    
    // After
    $schemaFromFile = new \UserFrosting\Fortress\RequestSchema('path/to/schema.json');
    $schemaFromArray = new \UserFrosting\Fortress\RequestSchema([
      // ...
    ]);
  • UserFrosting\Fortress\RequestSchema\RequestSchemaInterface now extends \Illuminate\Contracts\Config\Repository. The interface itself is otherwise unchanged.

  • UserFrosting\Fortress\RequestDataTransformer is deprecated and replaced by \UserFrosting\Fortress\Transformer\RequestDataTransformer (notice the difference in the namespace!). \UserFrosting\Fortress\RequestDataTransformerInterface is also deprecated and replaced by \UserFrosting\Fortress\Transformer\RequestDataTransformerInterface. When using the new class, instead of passing the schema in the constructor, you pass it directly to transform() or transformField(). For example :

    // Before
    $transformer = new \UserFrosting\Fortress\RequestDataTransformer($schema);
    $result = $transformer->transform($data, 'skip');
    
    // After
    $transformer = new \UserFrosting\Fortress\Transformer\RequestDataTransformer();
    $result = $transformer->transform($schema, $data, 'skip');
  • \UserFrosting\Fortress\ServerSideValidator is deprecated and replaced by \UserFrosting\Fortress\Validator\ServerSideValidator (notice the difference in the namespace!). \UserFrosting\Fortress\ServerSideValidatorInterface is also deprecated and replaced by \UserFrosting\Fortress\Validator\ServerSideValidatorInterface. When using the new class, instead of passing the schema in the constructor, you pass it directly to validate(). For example :

    // Before
    $validator = new \UserFrosting\Fortress\ServerSideValidator($schema, $this->translator);
    $result = $validator->validate($data);
    
    // After
    $adapter = new \UserFrosting\Fortress\Validator\ServerSideValidator($this->translator);
    $result = $validator->validate($schema, $data);
  • UserFrosting\Fortress\Adapter\FormValidationAdapter is deprecated.
    Instead of defining the format in the rules method, you simply use of the appropriate class for the associated format.

    rules(...) Replacement class
    $format = json & $stringEncode = true UserFrosting\Fortress\Adapter\FormValidationJsonAdapter
    $format = json & $stringEncode = false UserFrosting\Fortress\Adapter\FormValidationArrayAdapter
    $format = html5 UserFrosting\Fortress\Adapter\FormValidationHtml5Adapter

    UserFrosting\Fortress\Adapter\JqueryValidationAdapter is deprecated.
    Instead of defining the format in the rules method, you simply use of the appropriate class for the associated format.

    rules(...) Replacement class
    $format = json & $stringEncode = true UserFrosting\Fortress\Adapter\JqueryValidationJsonAdapter
    $format = json & $stringEncode = false UserFrosting\Fortress\Adapter\JqueryValidationArrayAdapter

    All adapters above now implements UserFrosting\Fortress\Adapter\ValidationAdapterInterface for easier type-hinting.

    Finally, instead of passing the schema in the constructor, you now pass it directly to rules().

    For example :

    // Before
    $adapter = new FormValidationAdapter($schema, $this->translator);
    $result = $adapter->rules('json', false);
    
    // After
    $adapter = new FormValidationArrayAdapter($this->translator);
    $result = $adapter->rules($schema);
  • ClientSideValidationAdapter abstract class replaced with FromSchemaTrait trait + ValidationAdapterInterface interface.

  • FormValidationHtml5Adapter Will now throw an exception on missing field param, instead of returning null.

  • In FormValidationHtml5Adapter, when using identical rule, the validation used to be applied to the "confirmation" field. It will now be applied to the source field, making it consistent with array|json format. For example, if password requires to be identical to passwordc, the validation was added to the passwordc field. Now it's applied to password.

Config

  • Methods getBool, getString, getInt & getArray now return null if key doesn't exist, to make it on par with parent get method.

Alert

  • Messages are now translated at read time (#1156, #811). Messages will be translated when using messages and getAndClearMessages. addMessage now accept the optional placeholders, which will be stored with the alert message. addMessageTranslated is deprecated.
  • Translator is not optional anymore. setTranslator method has been removed.
  • addValidationErrors is deprecated (N.B.: It can't accept the new \UserFrosting\Fortress\Validator\ServerSideValidatorInterface)

UniformResourceLocator

  • Two locations cannot have the same name anymore. An InvalidArgumentException will be thrown otherwise. (Ref userfrosting/UserFrosting#1243).
  • [DEPRECATION] Location's getSlug is deprecated (redundant with the name and not really used).

Full Changelog: 5.0.0...5.1.0