Webmozart\Json\Migration\JsonMigration

Size/Duplication

Total Lines	30
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
	getSourceVersion()	0	1	?
	getTargetVersion()	0	1	?
	up()	0	1	?
	down()	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\Migration;

use stdClass;

/**
 * Migrates a JSON object between versions.
 *
 * The JSON object is expected to have the property "version" set.
 *
 * @since  1.3
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
interface JsonMigration
{
    /**
     * Returns the version of the JSON object that this migration expects.
     *
     * @return string The version string
     */
    public function getSourceVersion();

    /**
     * Returns the version of the JSON object that this migration upgrades to.
     *
     * @return string The version string
     */
    public function getTargetVersion();

    /**
     * Upgrades a JSON object from the source to the target version.
     *
     * @param stdClass $data The JSON object of the package file
     */
    public function up(stdClass $data);

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.

    /**
     * Reverts a JSON object from the target to the source version.
     *
     * @param stdClass $data The JSON object of the package file
     */
    public function down(stdClass $data);

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.

}