View file vendor/robmorgan/phinx/src/Phinx/Db/Action/ChangeComment.php

File size: 1.78Kb
<?php
/**
 * Phinx
 *
 * (The MIT license)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated * documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */
namespace Phinx\Db\Action;

use Phinx\Db\Table\Table;

class ChangeComment extends Action
{

    /**
     * The new comment for the table
     *
     * @var string|null
     */
    protected $newComment;

    /**
     * Constructor
     *
     * @param Table $table The table to be changed
     * @param string|null $newComment The new comment for the table
     */
    public function __construct(Table $table, $newComment)
    {
        parent::__construct($table);
        $this->newComment = $newComment;
    }

    /**
     * Return the new comment for the table
     *
     * @return string|null
     */
    public function getNewComment()
    {
        return $this->newComment;
    }
}