sprintf - PHP code example

The php Function Sprintf

The php function sprintf allows you to format strings with placeholders that will be replaced with actual values at runtime. It can be used to do everything from formatting dates to displaying prices with the correct currency symbol and decimal places. Mastering the syntax and format specifiers of sprintf is essential for a well-rounded PHP developer. This article will introduce you to the basics of this powerful string formatting function, and give you the tools to tackle any formatting challenge that comes your way.

The sprintf function is similar to printf(), except that it formats its arguments and saves them into a variable rather than printing them on the screen like printf() does. It is supported by PHP versions 4 and above. The syntax of sprintf is as follows:

Format specification:

%:
:
The format specification is a special character that indicates how the argument should be formatted, and how many decimal places to leave at the end of the number. It can also specify to insert spaces at the end of the number if it is short.

:

The argument is inserted at the position of the first conversion specification in the format specification. If there are more than one conversion specifications, each is applied to the argument in turn. For example, %d:

sprintf example

    public function downloadFile($sourceUri, $destinationUri, $totalSize, $hash)
    {
        if (!\is_string($sourceUri) || $sourceUri === '') {
            throw new RuntimeException('Invalid sourceUri given');
        }

        $destination = fopen($destinationUri, 'a+');
        if (!\is_resource($destination)) {
            throw new Exception(sprintf('Destination "%s" is invalid.', $destinationUri));
        }

        if (filesize($destinationUri) > 0) {
            throw new Exception(sprintf('File on destination %s does already exist.', $destinationUri));
        }

        $partFile = $destinationUri . '.part';
        $partFile = new SplFileObject($partFile, 'a+');

        $size = $partFile->getSize();
        if ($size >= $totalSize) {

    protected function writeCacheFile(string $file, $content)
    {
        $tmpFile = @tempnam(\dirname($file), basename($file));
        if (false !== @file_put_contents($tmpFile, $content) && @rename($tmpFile, $file)) {
            @chmod($file, 0666 & ~umask());

            return;
        }

        throw new \RuntimeException(sprintf('Failed to write cache file "%s".', $file));
    }
}

    public function __construct(array $statusCodes = self::DEFAULT_RETRY_STATUS_CODES, int $delayMs = 1000, float $multiplier = 2.0, int $maxDelayMs = 0, float $jitter = 0.1)
    {
        $this->statusCodes = $statusCodes;

        if ($delayMs < 0) {
            throw new InvalidArgumentException(sprintf('Delay must be greater than or equal to zero: "%s" given.', $delayMs));
        }
        $this->delayMs = $delayMs;

        if ($multiplier < 1) {
            throw new InvalidArgumentException(sprintf('Multiplier must be greater than or equal to one: "%s" given.', $multiplier));
        }
        $this->multiplier = $multiplier;

        if ($maxDelayMs < 0) {
            throw new InvalidArgumentException(sprintf('Max delay must be greater than or equal to zero: "%s" given.', $maxDelayMs));
        }

private const KEY = 'promotion-not-found';

    /** * @var string */
    protected $promotionCode;

    public function __construct(string $promotionCode)
    {
        $this->promotionCode = $promotionCode;

        $this->message = sprintf('Promotion with code %s not found!', $this->promotionCode);

        parent::__construct($this->message);
    }

    public function getId(): string
    {
        return self::KEY;
    }

    public function getLevel(): int
    {

'Scope'                                => _x( 'Scope', 'table cell scope attribute' ),

                'Insert template'                      => _x( 'Insert template', 'TinyMCE' ),
                'Templates'                            => _x( 'Templates', 'TinyMCE' ),

                'Background color'                     => __( 'Background color' ),
                'Text color'                           => __( 'Text color' ),
                'Show blocks'                          => _x( 'Show blocks', 'editor button' ),
                'Show invisible characters'            => __( 'Show invisible characters' ),

                /* translators: Word count. */
                'Words: {0}'                           => sprintf( __( 'Words: %s' ), '{0}' ),
                'Paste is now in plain text mode. Contents will now be pasted as plain text until you toggle this option off.' =>
                    __( 'Paste is now in plain text mode. Contents will now be pasted as plain text until you toggle this option off.' ) . "\n\n" .
                    __( 'If you are looking to paste rich content from Microsoft Word, try turning this option off. The editor will clean up text pasted from Word automatically.' ),
                'Rich Text Area. Press ALT-F9 for menu. Press ALT-F10 for toolbar. Press ALT-0 for help' =>
                    __( 'Rich Text Area. Press Alt-Shift-H for help.' ),
                'Rich Text Area. Press Control-Option-H for help.' => __( 'Rich Text Area. Press Control-Option-H for help.' ),
                'You have unsaved changes are you sure you want to navigate away?' =>
                    __( 'The changes you made will be lost if you navigate away from this page.' ),
                'Your browser doesn\'t support direct access to the clipboard. Please use the Ctrl+X/C/V keyboard shortcuts instead.' =>
                    __( 'Your browser does not support direct access to the clipboard. Please use keyboard shortcuts or your browser’s edit menu instead.' ),

    public function after() {
        echo '</div>';
    }

    /** */
    public function bulk_footer() {
        $this->decrement_update_count( 'translation' );

        $update_actions = array(
            'updates_page' => sprintf(
                '<a href="%s" target="_parent">%s</a>',
                self_admin_url( 'update-core.php' ),
                __( 'Go to WordPress Updates page' )
            ),
        );

        /** * Filters the list of action links available following a translations update. * * @since 3.7.0 * * @param string[] $update_actions Array of translations update links. */

Search $search,
        ShopContextInterface $context
    ) {
        $search->addPostFilter($this->getQuery());
    }

    private function getQuery(): RangeQuery
    {
        $dayLimit = (int) $this->config->get('markAsNew');
        $timestamp = strtotime('-' . $dayLimit . ' days');
        if ($timestamp === false) {
            throw new RuntimeException(sprintf('Could not convert "-%s days" into a timestamp', $dayLimit));
        }

        return new RangeQuery('formattedCreatedAt', [
            'gte' => date('Y-m-d', $timestamp),
            'lte' => date('Y-m-d'),
        ]);
    }
}

        if (!$container->hasDefinition('console.command.cache_pool_prune')) {
            return;
        }

        $services = [];

        foreach ($container->findTaggedServiceIds('cache.pool') as $id => $tags) {
            $class = $container->getParameterBag()->resolveValue($container->getDefinition($id)->getClass());

            if (!$reflection = $container->getReflectionClass($class)) {
                throw new InvalidArgumentException(sprintf('Class "%s" used for service "%s" cannot be found.', $class, $id));
            }

            if ($reflection->implementsInterface(PruneableInterface::class)) {
                $services[$id] = new Reference($id);
            }
        }

        $container->getDefinition('console.command.cache_pool_prune')->replaceArgument(0, new IteratorArgument($services));
    }
}

$migration->update($this->connection);

        $customer = $this->fetchCustomer();

        static::assertIsArray($customer);
        static::assertEquals(CustomerEntity::ACCOUNT_TYPE_BUSINESS, $customer['account_type']);
        static::assertNotNull($customer['vat_ids']);
    }

    private function hasColumn(string $table, string $columnName): bool
    {
        return \in_array($columnName, array_column($this->connection->fetchAllAssociative(\sprintf('SHOW COLUMNS FROM `%s`', $table)), 'Field'), true);
    }

    /** * @param array<string, string|bool|null> $customerOverrides * @param array<string, string|bool|null> $addressOverrides */
    private function createCustomer(array $customerOverrides = [], array $addressOverrides = []): void
    {
        $billingAddressId = $this->ids->create('billingAddress');
        $defaultCountry = $this->connection->fetchOne('SELECT id FROM country WHERE active = 1 ORDER BY `position`');
        $defaultPaymentMethod = $this->connection->fetchOne('SELECT id FROM payment_method WHERE active = 1 ORDER BY `position`');

$cache_contexts_manager = $this->prophesize(CacheContextsManager::class);
    $cache_contexts_manager->assertValidTokens()->willReturn(TRUE);
    $cache_contexts_manager->reveal();
    $container = new Container();
    $container->set('cache_contexts_manager', $cache_contexts_manager);
    \Drupal::setContainer($container);

    $role_access_check = new RoleAccessCheck();
    $collection = $this->getTestRouteCollection();

    foreach ($grant_accounts as $account) {
      $message = sprintf('Access granted for user with the roles %s on path: %s', implode(', ', $account->getRoles()), $path);
      $this->assertEquals(AccessResult::allowed()->addCacheContexts(['user.roles']), $role_access_check->access($collection->get($path), $account), $message);
    }

    // Check all users which don't have access.     foreach ($deny_accounts as $account) {
      $message = sprintf('Access denied for user %s with the roles %s on path: %s', $account->id(), implode(', ', $account->getRoles()), $path);
      $has_access = $role_access_check->access($collection->get($path), $account);
      $this->assertEquals(AccessResult::neutral()->addCacheContexts(['user.roles']), $has_access, $message);
    }
  }

}

new ProductBuilder($ids, 'a'))->price(99.94, null, 'default', 99.94)->build(),
            (new ProductBuilder($ids, 'b'))->price(15, 10)->price(99.93, null, $isoCode, 99.93)->build(),
            (new ProductBuilder($ids, 'c'))->price(15, 10)->price(99.97, null, $isoCode, 99.97)->build(),
            (new ProductBuilder($ids, 'd'))->price(15, 10)->price(99.91, null, $isoCode, 99.91)->build(),
            (new ProductBuilder($ids, 'e'))->price(15, 10)->price(99.95, null, $isoCode, 99.95)->build(),
        ];

        $this->repository->create($data, Context::createDefaultContext());

        foreach (['', '.listPrice'] as $priceType) {
            $criteria = new Criteria($ids->all());
            $criteria->addSorting(new FieldSorting(sprintf('price.%s%s.gross', $ids->get($isoCode), $priceType)));

            $result = $this->repository->searchIds($criteria, Context::createDefaultContext());

            static::assertEquals(
                array_values($ids->getList(['a', 'd', 'b', 'e', 'c'])),
                $result->getIds()
            );

            $criteria = new Criteria($ids->all());
            $criteria->addSorting(new FieldSorting(sprintf('price.%s%s.gross', $ids->get($isoCode), $priceType), 'DESC'));

/** * Encodes the domain part of an address using IDN. */
    public function encodeString(string $address): string
    {
        $i = strrpos($address, '@');
        if (false !== $i) {
            $local = substr($address, 0, $i);
            $domain = substr($address, $i + 1);

            if (preg_match('/[^\x00-\x7F]/', $domain)) {
                $address = sprintf('%s@%s', $local, idn_to_ascii($domain, \IDNA_DEFAULT | \IDNA_USE_STD3_RULES | \IDNA_CHECK_BIDI | \IDNA_CHECK_CONTEXTJ | \IDNA_NONTRANSITIONAL_TO_ASCII, \INTL_IDNA_VARIANT_UTS46));
            }
        }

        return $address;
    }
}

public function getSpecificity(): Specificity
    {
        return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0));
    }

    public function __toString(): string
    {
        $attribute = $this->namespace ? $this->namespace.'|'.$this->attribute : $this->attribute;

        return 'exists' === $this->operator
            ? sprintf('%s[%s[%s]]', $this->getNodeName(), $this->selector, $attribute)
            : sprintf("%s[%s[%s %s '%s']]", $this->getNodeName(), $this->selector, $attribute, $this->operator, $this->value);
    }
}

/** * @return void */
    protected function configure()
    {
        $this
            ->setDefinition([
                new InputArgument('class', InputArgument::OPTIONAL, 'The form type class'),
                new InputArgument('option', InputArgument::OPTIONAL, 'The form type option'),
                new InputOption('show-deprecated', null, InputOption::VALUE_NONE, 'Display deprecated options in form types'),
                new InputOption('format', null, InputOption::VALUE_REQUIRED, sprintf('The output format ("%s")', implode('", "', $this->getAvailableFormatOptions())), 'txt'),
            ])
            ->setHelp(<<<'EOF' The <info>%command.name%</info> command displays information about form types. <info>php %command.full_name%</info> The command lists all built-in types, services types, type extensions and guessers currently available. <info>php %command.full_name% Symfony\Component\Form\Extension\Core\Type\ChoiceType</info> <info>php %command.full_name% ChoiceType</info> The command lists all defined options that contains the given form type, as well as their parents and type extensions. <info>php %command.full_name% ChoiceType choice_value</info> Use the <info>--show-deprecated</info> option to display form types with deprecated options or the deprecated options of the given form type: <info>php %command.full_name% --show-deprecated</info> <info>php %command.full_name% ChoiceType --show-deprecated</info> The command displays the definition of the given option name. <info>php %command.full_name% --format=json</info> The command lists everything in a machine readable json format.

throw new \InvalidArgumentException('The "callable" must be a valid function or method.');
    }
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

  /** * {@inheritdoc} */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    if (!empty($this->configuration['unpack_source'])) {
      if (!is_array($value)) {
        throw new MigrateException(sprintf("When 'unpack_source' is set, the source must be an array. Instead it was of type '%s'", gettype($value)));
      }
      return call_user_func($this->configuration['callable'], ...$value);
    }
    return call_user_func($this->configuration['callable'], $value);
  }

}