chippyash/Matrix

View on GitHub
src/Chippyash/Matrix/Traits/AssertParameterIsMatrix.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php
/*
 * Matrix library
 *
 * @author Ashley Kitson <akitson@zf4.biz>
 * @copyright Ashley Kitson, UK, 2014
 * @licence GPL V3 or later : http://www.gnu.org/licenses/gpl.html
 * @link http://en.wikipedia.org/wiki/Matrix_(mathematics)
 */
namespace Chippyash\Matrix\Traits;

use Chippyash\Matrix\Matrix;
use Chippyash\Matrix\Exceptions\MatrixException;

/**
 * Assert parameter is a Matrix
 */
Trait AssertParameterIsMatrix
{
    /**
     * Run test to ensure parameter is a Matrix
     *
     * @param $param
     * @param string $msg Optional message
     * @return $this
     *
     * @throws MatrixException
     * @internal param mixed $value
     */
    protected function assertParameterIsMatrix($param, $msg = 'Parameter is not a matrix')
    {
        if (!$param instanceof Matrix) {
            throw new MatrixException($msg);
        }

        return $this;
    }
}