Webmozart\Json\Versioning\JsonVersioner

Size/Duplication

Total Lines	23
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	1

2 Methods

Rating	Name	Duplication	Size	Complexity
	parseVersion()	0	1	?
	updateVersion()	0	1	?

<?php

/*
 * This file is part of the webmozart/json package.
 *
 * (c) Bernhard Schussek <bschussek@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Webmozart\Json\Versioning;

use stdClass;

/**
 * Parses and updates the version of a JSON object.
 *
 * @since  1.3
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
interface JsonVersioner
{
    /**
     * Parses and returns the version of a JSON object.
     *
     * @param stdClass $jsonData The JSON object
     *
     * @return string The version
     *
     * @throws CannotParseVersionException If the version cannot be parsed
     */
    public function parseVersion(stdClass $jsonData);

    /**
     * Updates the version of a JSON object.
     *
     * @param stdClass $jsonData The JSON object
     * @param string   $version  The version to set
     *
     * @throws CannotUpdateVersionException If the version cannot be updated
     */
    public function updateVersion(stdClass $jsonData, $version);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

}