API
2 years ago
Access
2 years ago
Application
2 years ago
Archive
2 years ago
ArchiveProcessor
2 years ago
Archiver
2 years ago
AssetManager
2 years ago
Auth
2 years ago
Category
2 years ago
Changes
2 years ago
CliMulti
2 years ago
Columns
2 years ago
Concurrency
2 years ago
Config
2 years ago
Container
2 years ago
CronArchive
2 years ago
DataAccess
2 years ago
DataFiles
2 years ago
DataTable
2 years ago
Db
1 year ago
DeviceDetector
2 years ago
Email
2 years ago
Exception
2 years ago
Http
2 years ago
Intl
2 years ago
Log
2 years ago
Mail
2 years ago
Measurable
2 years ago
Menu
2 years ago
Metrics
2 years ago
Notification
2 years ago
Period
1 year ago
Plugin
2 years ago
ProfessionalServices
2 years ago
Report
2 years ago
ReportRenderer
2 years ago
Scheduler
2 years ago
Segment
2 years ago
Session
2 years ago
Settings
2 years ago
Tracker
1 year ago
Translation
2 years ago
Twig
2 years ago
UpdateCheck
2 years ago
Updater
1 year ago
Updates
1 year ago
Validators
2 years ago
View
2 years ago
ViewDataTable
2 years ago
Visualization
2 years ago
Widget
2 years ago
.htaccess
2 years ago
Access.php
2 years ago
Archive.php
2 years ago
ArchiveProcessor.php
2 years ago
AssetManager.php
2 years ago
Auth.php
2 years ago
AuthResult.php
2 years ago
BaseFactory.php
2 years ago
Cache.php
2 years ago
CacheId.php
2 years ago
CliMulti.php
2 years ago
Common.php
2 years ago
Config.php
2 years ago
Console.php
2 years ago
Context.php
2 years ago
Cookie.php
2 years ago
CronArchive.php
2 years ago
DI.php
2 years ago
DataArray.php
2 years ago
DataTable.php
2 years ago
Date.php
2 years ago
Db.php
1 year ago
DbHelper.php
1 year ago
Development.php
2 years ago
ErrorHandler.php
2 years ago
EventDispatcher.php
2 years ago
ExceptionHandler.php
2 years ago
FileIntegrity.php
2 years ago
Filechecks.php
2 years ago
Filesystem.php
2 years ago
FrontController.php
2 years ago
Http.php
2 years ago
IP.php
2 years ago
Log.php
2 years ago
LogDeleter.php
2 years ago
Mail.php
2 years ago
Metrics.php
2 years ago
NoAccessException.php
2 years ago
Nonce.php
2 years ago
Notification.php
2 years ago
NumberFormatter.php
2 years ago
Option.php
2 years ago
Period.php
2 years ago
Piwik.php
2 years ago
Plugin.php
2 years ago
Profiler.php
2 years ago
ProxyHeaders.php
2 years ago
ProxyHttp.php
2 years ago
QuickForm2.php
2 years ago
RankingQuery.php
2 years ago
ReportRenderer.php
2 years ago
Request.php
2 years ago
Segment.php
2 years ago
Sequence.php
2 years ago
Session.php
2 years ago
SettingsPiwik.php
2 years ago
SettingsServer.php
2 years ago
Singleton.php
2 years ago
Site.php
2 years ago
SiteContentDetector.php
2 years ago
SupportedBrowser.php
2 years ago
TCPDF.php
2 years ago
Theme.php
2 years ago
Timer.php
2 years ago
Tracker.php
2 years ago
Twig.php
2 years ago
Unzip.php
2 years ago
UpdateCheck.php
2 years ago
Updater.php
2 years ago
UpdaterErrorException.php
2 years ago
Updates.php
2 years ago
Url.php
2 years ago
UrlHelper.php
1 year ago
Version.php
1 year ago
View.php
2 years ago
bootstrap.php
2 years ago
dispatch.php
2 years ago
testMinimumPhpVersion.php
2 years ago
Sequence.php
110 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Matomo - free/libre analytics platform |
| 5 | * |
| 6 | * @link https://matomo.org |
| 7 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 8 | */ |
| 9 | namespace Piwik; |
| 10 | |
| 11 | use Exception; |
| 12 | use Piwik\Db\AdapterInterface; |
| 13 | /** |
| 14 | * Used for generating auto increment ids. |
| 15 | * |
| 16 | * Example: |
| 17 | * |
| 18 | * $sequence = new Sequence('my_sequence_name'); |
| 19 | * $id = $sequence->getNextId(); |
| 20 | * $db->insert('anytable', array('id' => $id, '...' => '...')); |
| 21 | */ |
| 22 | class Sequence |
| 23 | { |
| 24 | public const TABLE_NAME = 'sequence'; |
| 25 | /** |
| 26 | * @var string |
| 27 | */ |
| 28 | private $name; |
| 29 | /** |
| 30 | * @var AdapterInterface |
| 31 | */ |
| 32 | private $db; |
| 33 | /** |
| 34 | * @var string |
| 35 | */ |
| 36 | private $table; |
| 37 | /** |
| 38 | * The name of the table or sequence you want to get an id for. |
| 39 | * |
| 40 | * @param string $name eg 'archive_numeric_2014_11' |
| 41 | * @param AdapterInterface $db You can optionally pass a DB adapter to make it work against another database. |
| 42 | * @param string|null $tablePrefix |
| 43 | */ |
| 44 | public function __construct($name, $db = null, $tablePrefix = null) |
| 45 | { |
| 46 | $this->name = $name; |
| 47 | $this->db = $db ?: \Piwik\Db::get(); |
| 48 | $this->table = $this->getTableName($tablePrefix); |
| 49 | } |
| 50 | /** |
| 51 | * Creates / initializes a new sequence. |
| 52 | * |
| 53 | * @param int $initialValue |
| 54 | * @return int The actually used value to initialize the table. |
| 55 | * |
| 56 | * @throws \Exception in case a sequence having this name already exists. |
| 57 | */ |
| 58 | public function create($initialValue = 0) |
| 59 | { |
| 60 | $initialValue = (int) $initialValue; |
| 61 | $this->db->insert($this->table, array('name' => $this->name, 'value' => $initialValue)); |
| 62 | return $initialValue; |
| 63 | } |
| 64 | /** |
| 65 | * Returns true if the sequence exist. |
| 66 | * |
| 67 | * @return bool |
| 68 | */ |
| 69 | public function exists() |
| 70 | { |
| 71 | $query = $this->db->query('SELECT * FROM ' . $this->table . ' WHERE name = ?', $this->name); |
| 72 | return $query->rowCount() > 0; |
| 73 | } |
| 74 | /** |
| 75 | * Get / allocate / reserve a new id for the current sequence. Important: Getting the next id will fail in case |
| 76 | * no such sequence exists. Make sure to create one if needed, see {@link create()}. |
| 77 | * |
| 78 | * @return int |
| 79 | * @throws Exception |
| 80 | */ |
| 81 | public function getNextId() |
| 82 | { |
| 83 | $sql = 'UPDATE ' . $this->table . ' SET value = LAST_INSERT_ID(value + 1) WHERE name = ?'; |
| 84 | $result = $this->db->query($sql, array($this->name)); |
| 85 | $rowCount = $result->rowCount(); |
| 86 | if (1 !== $rowCount) { |
| 87 | throw new Exception("Sequence '" . $this->name . "' not found."); |
| 88 | } |
| 89 | $createdId = $this->db->lastInsertId(); |
| 90 | return (int) $createdId; |
| 91 | } |
| 92 | /** |
| 93 | * Returns the current max id. |
| 94 | * @return int |
| 95 | * @internal |
| 96 | */ |
| 97 | public function getCurrentId() |
| 98 | { |
| 99 | $sql = 'SELECT value FROM ' . $this->table . ' WHERE name = ?'; |
| 100 | $id = $this->db->fetchOne($sql, array($this->name)); |
| 101 | if (!empty($id) || '0' === $id || 0 === $id) { |
| 102 | return (int) $id; |
| 103 | } |
| 104 | } |
| 105 | private function getTableName($prefix) |
| 106 | { |
| 107 | return $prefix !== null ? $prefix . self::TABLE_NAME : \Piwik\Common::prefixTable(self::TABLE_NAME); |
| 108 | } |
| 109 | } |
| 110 |