location-bundle/src/Common/Database/DataBaseInterface.php at 0dc9e10186b4049af18d70bf301e391b7ed84645 · apacheborys/location-bundle · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<?php

declare(strict_types=1);

/*
 * This file is part of the Location bundle package (@see https://github.com/apacheborys/location-bundle).
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license    MIT License
 */

namespace ApacheBorys\Location\Database;

use ApacheBorys\Location\Model\Address;
use ApacheBorys\Location\Model\DBConfig;
use ApacheBorys\Location\Model\Place;
use ApacheBorys\Location\Model\PlaceCollection;

/**
 * @author Borys Yermokhin <borys_ermokhin@yahoo.com>
 */
interface DataBaseInterface
{
    public function __construct($databaseProvider, DBConfig $dbConfig);

    /**
     * @param Place $place
     *
     * @return bool
     */
    public function add(Place $place): bool;

    /**
     * @param Place $place
     *
     * @return bool
     */
    public function update(Place $place): bool;

    /**
     * @param string $searchKey
     * @param int    $page
     * @param int    $maxResults
     * @param string $locale
     * @param int    $filterAdminLevel
     *
     * @return Place[]
     */
    public function get(string $searchKey, int $page = 0, int $maxResults = 30, string $locale = '', int $filterAdminLevel = -1): array;

    /**
     * @param Place $place
     *
     * @return bool
     */
    public function delete(Place $place): bool;

    /**
     * As findAll in repository
     *
     * @param int $offset
     * @param int $limit
     *
     * @return PlaceCollection
     */
    public function getAllPlaces(int $offset = 0, int $limit = 50): PlaceCollection;

    /**
     * All admin levels what contain database
     *
     * @return int[]
     */
    public function getAdminLevels(): array;

    /**
     * Current db configuration
     *
     * @return DBConfig
     */
    public function getDbConfig(): DBConfig;

    /**
     * Compile keys for each Address entity in Place's collection
     *
     * @param Place $place
     * @param bool  $useLevels
     * @param bool  $usePrefix
     * @param bool  $useAddress
     *
     * @return string[]
     */
    public function compileKeys(
        Place $place,
        bool $useLevels = true,
        bool $usePrefix = true,
        bool $useAddress = true
    ): array;

    /**
     * Compile key for specific Address entity
     *
     * @param Address $address
     * @param bool    $useLevels
     * @param bool    $usePrefix
     * @param bool    $useAddress
     *
     * @return string
     */
    public function compileKey(
        Address $address,
        bool $useLevels = true,
        bool $usePrefix = true,
        bool $useAddress = true
    ): string;

    /**
     * Service method for update all existing admin levels
     *
     * @return bool
     */
    public function updateExistAdminLevels(): bool;

    /**
     * Service method for normalize string for key name what should stored in database
     *
     * @param string $rawString
     *
     * @return mixed
     */
    public function normalizeStringForKeyName(string $rawString);
}