Limoncello\Flute\Contracts\Api\CrudInterface

Size/Duplication

Total Lines	246
Duplicated Lines	0 %

Importance

Changes

0

32 Methods

Rating	Name	Duplication	Size	Complexity
	combineWithAnd()	0	1	?
	combineWithOr()	0	1	?
	withFilters()	0	1	?
	withIndexFilter()	0	1	?
	withIndexesFilter()	0	1	?
	withSorts()	0	1	?
	withIncludes()	0	1	?
	withPaging()	0	1	?
	withoutPaging()	0	1	?
	withRelationshipFilters()	0	1	?
	withRelationshipSorts()	0	1	?
	createIndexBuilder()	0	1	?
	createDeleteBuilder()	0	1	?
	fetchResources()	0	1	?
	fetchResource()	0	1	?
	fetchRow()	0	1	?
	fetchColumn()	0	1	?
	index()	0	1	?
	indexIdentities()	0	1	?
	read()	0	1	?
	count()	0	1	?
	delete()	0	1	?
	remove()	0	1	?
	create()	0	1	?
	update()	0	1	?
	indexRelationship()	0	5	?
	indexRelationshipIdentities()	0	5	?
	readRelationship()	0	6	?
	hasInRelationship()	0	1	?
	createInBelongsToManyRelationship()	0	1	?
	removeInBelongsToManyRelationship()	0	1	?
	inTransaction()	0	1	?

<?php declare (strict_types = 1);

namespace Limoncello\Flute\Contracts\Api;

/**
 * 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.
 */

use Closure;
use Doctrine\DBAL\Query\QueryBuilder;
use Limoncello\Flute\Contracts\Models\PaginatedDataInterface;

/**
 * @package Limoncello\Flute
 */
interface CrudInterface
{
    /**
     * @return self

Should the return type not be \self?

     */
    public function combineWithAnd(): self;

    /**
     * @return self

Should the return type not be \self?

     */
    public function combineWithOr(): self;

    /**
     * @param iterable $filterParameters
     *
     * @return self

Should the return type not be \self?

     */
    public function withFilters(iterable $filterParameters): self;

    /**
     * @param string $index
     *
     * @return self

Should the return type not be \self?

     */
    public function withIndexFilter(string $index): self;

    /**
     * @param array $indexes
     *
     * @return self

Should the return type not be \self?

     */
    public function withIndexesFilter(array $indexes): self;

    /**
     * @param iterable $sortingParameters
     *
     * @return self

Should the return type not be \self?

     */
    public function withSorts(iterable $sortingParameters): self;

    /**
     * @param iterable $includePaths
     *
     * @return self

Should the return type not be \self?

     */
    public function withIncludes(iterable $includePaths): self;

    /**
     * @param int $offset
     * @param int $limit
     *
     * @return self

Should the return type not be \self?

     */
    public function withPaging(int $offset, int $limit): self;

    /**
     * @return self

Should the return type not be \self?

     */
    public function withoutPaging(): self;

    /**
     * @param string   $name
     * @param iterable $filters
     *
     * @return CrudInterface

Should the return type not be \self?

     */
    public function withRelationshipFilters(string $name, iterable $filters): self;

    /**
     * @param string   $name
     * @param iterable $sorts
     *
     * @return CrudInterface

Should the return type not be \self?

     */
    public function withRelationshipSorts(string $name, iterable $sorts): self;

    /**
     * @param iterable|null $columns
     *
     * @return QueryBuilder
     */
    public function createIndexBuilder(iterable $columns = null): QueryBuilder;

    /**
     * @return QueryBuilder
     */
    public function createDeleteBuilder(): QueryBuilder;

    /**
     * @param QueryBuilder $builder
     * @param string       $modelClass
     *
     * @return PaginatedDataInterface
     */
    public function fetchResources(QueryBuilder $builder, string $modelClass): PaginatedDataInterface;

    /**
     * @param QueryBuilder|null $builder

Consider making the type for parameter $builder a bit more specific; maybe use QueryBuilder.

     * @param string|null       $modelClass
     *
     * @return mixed|null
     */
    public function fetchResource(QueryBuilder $builder, string $modelClass);

    /**
     * @param QueryBuilder $builder
     * @param string       $modelClass
     *
     * @return array|null
     */
    public function fetchRow(QueryBuilder $builder, string $modelClass): ?array;

    /**
     * @param QueryBuilder $builder
     * @param string       $modelClass
     * @param string       $columnName
     *
     * @return iterable
     */
    public function fetchColumn(QueryBuilder $builder, string $modelClass, string $columnName): iterable;

    /**
     * @return PaginatedDataInterface
     */
    public function index(): PaginatedDataInterface;

    /**
     * @return array
     */
    public function indexIdentities(): array;

    /**
     * @param string $index
     *
     * @return mixed|null
     */
    public function read(string $index);

    /**
     * @return int|null
     */
    public function count(): ?int;

    /**
     * @return int
     */
    public function delete(): int;

    /**
     * @param string $index
     *
     * @return bool
     */
    public function remove(string $index): bool;

    /**
     * @param null|string $index
     * @param array       $attributes
     * @param array       $toMany
     *
     * @return string
     */
    public function create(?string $index, array $attributes, array $toMany): string;

    /**
     * @param string $index
     * @param array  $attributes
     * @param array  $toMany
     *
     * @return int
     */
    public function update(string $index, array $attributes, array $toMany): int;

    /**
     * @param string        $name
     * @param iterable|null $relationshipFilters
     * @param iterable|null $relationshipSorts
     *
     * @return PaginatedDataInterface|mixed|null
     */
    public function indexRelationship(
        string $name,
        iterable $relationshipFilters = null,
        iterable $relationshipSorts = null
    );

    /**
     * @param string        $name
     * @param iterable|null $relationshipFilters
     * @param iterable|null $relationshipSorts
     *
     * @return array
     */
    public function indexRelationshipIdentities(
        string $name,
        iterable $relationshipFilters = null,
        iterable $relationshipSorts = null
    ): array;

    /**
     * @param string        $index
     * @param string        $name
     * @param iterable|null $relationshipFilters
     * @param iterable|null $relationshipSorts
     *
     * @return PaginatedDataInterface|mixed|null
     */
    public function readRelationship(
        string $index,
        string $name,
        iterable $relationshipFilters = null,
        iterable $relationshipSorts = null
    );

    /**
     * @param string $parentId
     * @param string $name
     * @param string $childId
     *
     * @return bool
     */
    public function hasInRelationship(string $parentId, string $name, string $childId): bool;

    /**
     * @param string   $parentId
     * @param string   $name
     * @param iterable $childIds
     *
     * @return int
     */
    public function createInBelongsToManyRelationship(string $parentId, string $name, iterable $childIds): int;

    /**
     * @param string   $parentId
     * @param string   $name
     * @param iterable $childIds
     *
     * @return int
     */
    public function removeInBelongsToManyRelationship(string $parentId, string $name, iterable $childIds): int;

    /**
     * @param Closure $closure
     */
    public function inTransaction(Closure $closure): void;
}