<?php declare(strict_types=1);
namespace Neomerx\JsonApi\Contracts\Parser;
/**
* Copyright 2015-2019 info@neomerx.com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @package Neomerx\JsonApi
*/
interface ParserInterface
{
/**
* Root level for parsed items.
*/
const ROOT_LEVEL = 0;
/**
* Root path for parsed items.
*/
const ROOT_PATH = '';
/**
* Parse data.
*
* @param mixed $data
* @param array $paths
*
* @see ParsedResultInterface
*
* @return iterable
*/
public function parse($data, array $paths = []): iterable;
}