API
2 weeks ago
Access
2 weeks ago
Application
2 weeks ago
Archive
2 weeks ago
ArchiveProcessor
2 weeks ago
Archiver
2 years ago
AssetManager
2 weeks ago
Auth
2 weeks ago
Category
2 weeks ago
Changes
2 months ago
CliMulti
2 weeks ago
Columns
2 weeks ago
Concurrency
2 weeks ago
Config
2 weeks ago
Container
2 months ago
CronArchive
2 weeks ago
DataAccess
2 weeks ago
DataFiles
2 years ago
DataTable
2 weeks ago
Db
2 weeks ago
DeviceDetector
1 year ago
Email
2 years ago
Exception
5 months ago
Http
2 weeks ago
Intl
4 months ago
Log
2 years ago
Mail
1 year ago
Measurable
8 months ago
Menu
2 weeks ago
Metrics
2 weeks ago
Notification
8 months ago
Period
2 weeks ago
Plugin
2 weeks ago
Policy
2 months ago
ProfessionalServices
1 year ago
Report
1 year ago
ReportRenderer
2 weeks ago
Request
2 weeks ago
Scheduler
2 weeks ago
Segment
2 weeks ago
Session
1 month ago
Settings
2 weeks ago
Tracker
2 weeks ago
Translation
2 months ago
Twig
1 year ago
UpdateCheck
4 months ago
Updater
2 weeks ago
Updates
1 month ago
Validators
1 year ago
View
2 months ago
ViewDataTable
2 weeks ago
Visualization
2 weeks ago
Widget
2 weeks ago
.htaccess
2 years ago
Access.php
2 weeks ago
Archive.php
2 months ago
ArchiveProcessor.php
2 weeks ago
AssetManager.php
2 weeks ago
Auth.php
8 months ago
AuthResult.php
8 months ago
BaseFactory.php
2 years ago
Cache.php
2 weeks ago
CacheId.php
5 months ago
CliMulti.php
2 weeks ago
Common.php
2 weeks ago
Config.php
2 weeks ago
Console.php
4 months ago
Context.php
2 years ago
Cookie.php
2 weeks ago
CronArchive.php
2 weeks ago
DI.php
4 months ago
DataArray.php
2 weeks ago
DataTable.php
2 weeks ago
Date.php
2 months ago
Db.php
2 months ago
DbHelper.php
2 weeks ago
Development.php
2 weeks ago
ErrorHandler.php
8 months ago
EventDispatcher.php
2 months ago
ExceptionHandler.php
5 months ago
FileIntegrity.php
2 weeks ago
Filechecks.php
1 year ago
Filesystem.php
2 weeks ago
FrontController.php
2 weeks ago
Http.php
2 weeks ago
IP.php
1 year ago
Log.php
4 months ago
LogDeleter.php
2 weeks ago
Mail.php
1 year ago
Metrics.php
2 months ago
NoAccessException.php
2 years ago
Nonce.php
8 months ago
Notification.php
2 months ago
NumberFormatter.php
2 weeks ago
Option.php
2 weeks ago
Period.php
2 weeks ago
Piwik.php
2 weeks ago
Plugin.php
2 months ago
Process.php
2 months ago
Profiler.php
2 weeks ago
ProxyHeaders.php
5 months ago
ProxyHttp.php
2 weeks ago
QuickForm2.php
4 months ago
RankingQuery.php
2 months ago
ReportRenderer.php
2 weeks ago
Request.php
2 months ago
Segment.php
2 weeks ago
Sequence.php
2 weeks ago
Session.php
1 month ago
SettingsPiwik.php
2 weeks ago
SettingsServer.php
2 weeks ago
Singleton.php
2 years ago
Site.php
2 months ago
SiteContentDetector.php
2 months ago
SupportedBrowser.php
2 years ago
TCPDF.php
1 year ago
Theme.php
2 weeks ago
Timer.php
2 weeks ago
Tracker.php
2 weeks ago
Twig.php
2 months ago
Unzip.php
1 year ago
UpdateCheck.php
2 months ago
Updater.php
2 weeks ago
UpdaterErrorException.php
2 years ago
Updates.php
2 weeks ago
Url.php
2 weeks ago
UrlHelper.php
2 months ago
Version.php
2 weeks ago
View.php
2 weeks ago
bootstrap.php
1 year ago
dispatch.php
2 years ago
testMinimumPhpVersion.php
8 months ago
BaseFactory.php
60 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 | /** |
| 13 | * Base class for all factory types. |
| 14 | * |
| 15 | * Factory types are base classes that contain a **factory** method. This method is used to instantiate |
| 16 | * concrete instances by a specified string ID. Fatal errors do not occur if a class does not exist. |
| 17 | * Instead an exception is thrown. |
| 18 | * |
| 19 | * Derived classes should override the **getClassNameFromClassId** and **getInvalidClassIdExceptionMessage** |
| 20 | * static methods. |
| 21 | */ |
| 22 | abstract class BaseFactory |
| 23 | { |
| 24 | /** |
| 25 | * Creates a new instance of a class using a string ID. |
| 26 | * |
| 27 | * @param string $classId The ID of the class. |
| 28 | * @return \Piwik\DataTable\Renderer |
| 29 | * @throws Exception if $classId is invalid. |
| 30 | */ |
| 31 | public static function factory($classId) |
| 32 | { |
| 33 | $className = static::getClassNameFromClassId($classId); |
| 34 | if (!class_exists($className)) { |
| 35 | self::sendPlainHeader(); |
| 36 | throw new Exception(static::getInvalidClassIdExceptionMessage($classId)); |
| 37 | } |
| 38 | return new $className(); |
| 39 | } |
| 40 | private static function sendPlainHeader() |
| 41 | { |
| 42 | \Piwik\Common::sendHeader('Content-Type: text/plain; charset=utf-8'); |
| 43 | } |
| 44 | /** |
| 45 | * Should return a class name based on the class's associated string ID. |
| 46 | */ |
| 47 | protected static function getClassNameFromClassId($id) |
| 48 | { |
| 49 | return $id; |
| 50 | } |
| 51 | /** |
| 52 | * Should return a message to use in an Exception when an invalid class ID is supplied to |
| 53 | * {@link factory()}. |
| 54 | */ |
| 55 | protected static function getInvalidClassIdExceptionMessage($id) |
| 56 | { |
| 57 | return "Invalid class ID '{$id}' for " . get_called_class() . "::factory()."; |
| 58 | } |
| 59 | } |
| 60 |