Tobscure\JsonApi\Parameters::getOffset PHP Method

getOffset() public method

Get number of offset.
public getOffset ( integer | null $perPage = null ) : integer
$perPage integer | null
return integer
    public function getOffset($perPage = null)
    {
        if ($perPage && ($offset = $this->getOffsetFromNumber($perPage))) {
            return $offset;
        }
        $offset = (int) $this->getPage('offset');
        if ($offset < 0) {
            throw new InvalidParameterException('page[offset] must be >=0', 2, null, 'page[offset]');
        }
        return $offset;
    }

Usage Example

Example #1
0
 public function testGetOffsetParsesThePageNumber()
 {
     $parameters = new Parameters(['page' => ['number' => 2]]);
     $this->assertEquals(20, $parameters->getOffset(20));
 }
All Usage Examples Of Tobscure\JsonApi\Parameters::getOffset