<?php

namespace Vich\UploaderBundle\Naming;

use Vich\UploaderBundle\Mapping\PropertyMapping;

/**
 * @author Dustin Dobervich <ddobervich@gmail.com>
 *
 * @phpstan-template T of object
 */
interface NamerInterface
{
    /**
     * Creates a name for the file being uploaded.
     * Important: this method will be changed to accept object|array for $object,
     *            please use it like that in your implementation.
     *
     * @param object|array    $object  The object or array the upload is attached to
     * @param PropertyMapping $mapping The mapping to use to manipulate the given object
     *
     * @phpstan-param T $object
     *
     * @return string The file name
     */
    public function name(object $object, PropertyMapping $mapping): string;
}