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