Development.php — Matomo Analytics – Powerful, Privacy-First Insights for WordPress 5.12.1

matomo / app / core / Development.php

matomo / app / core Last commit date

API 3 weeks ago Access 3 weeks ago Application 3 weeks ago Archive 3 weeks ago ArchiveProcessor 3 weeks ago Archiver 2 years ago AssetManager 3 weeks ago Auth 3 weeks ago Category 3 weeks ago Changes 2 months ago CliMulti 3 weeks ago Columns 3 weeks ago Concurrency 3 weeks ago Config 3 weeks ago Container 2 months ago CronArchive 3 weeks ago DataAccess 3 weeks ago DataFiles 2 years ago DataTable 3 weeks ago Db 3 weeks ago DeviceDetector 1 year ago Email 2 years ago Exception 5 months ago Http 3 weeks ago Intl 4 months ago Log 2 years ago Mail 1 year ago Measurable 8 months ago Menu 3 weeks ago Metrics 3 weeks ago Notification 8 months ago Period 3 weeks ago Plugin 3 weeks ago Policy 2 months ago ProfessionalServices 1 year ago Report 1 year ago ReportRenderer 3 weeks ago Request 3 weeks ago Scheduler 3 weeks ago Segment 3 weeks ago Session 1 month ago Settings 3 weeks ago Tracker 3 weeks ago Translation 2 months ago Twig 1 year ago UpdateCheck 4 months ago Updater 3 weeks ago Updates 1 month ago Validators 1 year ago View 2 months ago ViewDataTable 3 weeks ago Visualization 3 weeks ago Widget 3 weeks ago .htaccess 2 years ago Access.php 3 weeks ago Archive.php 2 months ago ArchiveProcessor.php 3 weeks ago AssetManager.php 3 weeks ago Auth.php 8 months ago AuthResult.php 8 months ago BaseFactory.php 2 years ago Cache.php 3 weeks ago CacheId.php 5 months ago CliMulti.php 3 weeks ago Common.php 3 weeks ago Config.php 3 weeks ago Console.php 4 months ago Context.php 2 years ago Cookie.php 3 weeks ago CronArchive.php 3 weeks ago DI.php 4 months ago DataArray.php 3 weeks ago DataTable.php 3 weeks ago Date.php 2 months ago Db.php 2 months ago DbHelper.php 3 weeks ago Development.php 3 weeks ago ErrorHandler.php 8 months ago EventDispatcher.php 2 months ago ExceptionHandler.php 5 months ago FileIntegrity.php 3 weeks ago Filechecks.php 1 year ago Filesystem.php 3 weeks ago FrontController.php 3 weeks ago Http.php 3 weeks ago IP.php 1 year ago Log.php 4 months ago LogDeleter.php 3 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 3 weeks ago Option.php 3 weeks ago Period.php 3 weeks ago Piwik.php 3 weeks ago Plugin.php 2 months ago Process.php 2 months ago Profiler.php 3 weeks ago ProxyHeaders.php 5 months ago ProxyHttp.php 3 weeks ago QuickForm2.php 4 months ago RankingQuery.php 2 months ago ReportRenderer.php 3 weeks ago Request.php 2 months ago Segment.php 3 weeks ago Sequence.php 3 weeks ago Session.php 1 month ago SettingsPiwik.php 3 weeks ago SettingsServer.php 3 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 3 weeks ago Timer.php 3 weeks ago Tracker.php 3 weeks ago Twig.php 2 months ago Unzip.php 1 year ago UpdateCheck.php 2 months ago Updater.php 3 weeks ago UpdaterErrorException.php 2 years ago Updates.php 3 weeks ago Url.php 3 weeks ago UrlHelper.php 2 months ago Version.php 3 weeks ago View.php 3 weeks ago bootstrap.php 1 year ago dispatch.php 2 years ago testMinimumPhpVersion.php 8 months ago

Development.php

170 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\Container\StaticContainer;
13	use Piwik\Log\LoggerInterface;
14	/**
15	* Development related checks and tools. You can enable/disable development using `./console development:enable` and
16	* `./console development:disable`. The intention of the development mode and this class is to support the developer
17	* as much as possible by doing some additional checks if the development mode is enabled. For instance if a developer
18	* has to register any class/method we can make sure whether they actually exist and if not display a useful error
19	* message. This helps the user to find for instance simple typos and makes sure it will actually work even if he
20	* forgets to test it.
21	*/
22	class Development
23	{
24	private static $isEnabled = null;
25	/**
26	* Returns `true` if development mode is enabled and `false` otherwise.
27	*
28	* @return bool
29	*/
30	public static function isEnabled()
31	{
32	if (is_null(self::$isEnabled)) {
33	self::$isEnabled = (bool) \Piwik\Config::getInstance()->Development['enabled'];
34	}
35	return self::$isEnabled;
36	}
37	/**
38	* Verifies whether a className of object implements the given method. It does not check whether the given method
39	* is actually callable (public).
40	*
41	* @param string\|object $classOrObject
42	* @param string $method
43	*
44	* @return bool true if the method exists, false otherwise.
45	*/
46	public static function methodExists($classOrObject, $method)
47	{
48	if (is_string($classOrObject)) {
49	return class_exists($classOrObject) && method_exists($classOrObject, $method);
50	}
51	return method_exists($classOrObject, $method);
52	}
53	/**
54	* Formats a method call depending on the given class/object and method name. It does not perform any checks whether
55	* the method actually exists.
56	*
57	* @param string\|object $classOrObject
58	* @param string $method
59	*
60	* @return string Formatted method call. Example: "MyNamespace\MyClassname::methodName()"
61	*/
62	public static function formatMethodCall($classOrObject, $method)
63	{
64	if (is_object($classOrObject)) {
65	$classOrObject = get_class($classOrObject);
66	}
67	return $classOrObject . '::' . $method . '()';
68	}
69	/**
70	* Checks whether the given method is actually callable on the given class/object if the development mode is
71	* enabled. En error will be triggered if the method does not exist or is not callable (public) containing a useful
72	* error message for the developer.
73	*
74	* @param string\|object $classOrObject
75	* @param string $method
76	* @param string $prefixMessageIfError You can prepend any string to the error message in case the method is not
77	* callable.
78	*/
79	public static function checkMethodIsCallable($classOrObject, $method, $prefixMessageIfError)
80	{
81	if (!self::isEnabled()) {
82	return;
83	}
84	self::checkMethodExists($classOrObject, $method, $prefixMessageIfError);
85	if (!self::isCallableMethod($classOrObject, $method)) {
86	self::error($prefixMessageIfError . ' "' . self::formatMethodCall($classOrObject, $method) . '" is not callable. Please make sure to method is public');
87	}
88	}
89	/**
90	* Checks whether the given method actually exists on the given class/object if the development mode is
91	* enabled. An error will be triggered if the method does not exist, containing a useful error message
92	* for the developer.
93	*
94	* @param string\|object $classOrObject
95	* @param string $method
96	* @param string $prefixMessageIfError You can prepend any string to the error message in case the method
97	* does not exist.
98	*/
99	public static function checkMethodExists($classOrObject, $method, $prefixMessageIfError)
100	{
101	if (!self::isEnabled()) {
102	return;
103	}
104	if (!self::methodExists($classOrObject, $method)) {
105	self::error($prefixMessageIfError . ' "' . self::formatMethodCall($classOrObject, $method) . '" does not exist. Please make sure to define such a method.');
106	}
107	}
108	/**
109	* Verify whether the given method actually exists and is callable (public).
110	*
111	* @param string\|object $classOrObject
112	* @param string $method
113	* @return bool
114	*/
115	public static function isCallableMethod($classOrObject, $method)
116	{
117	if (!self::methodExists($classOrObject, $method)) {
118	return \false;
119	}
120	$reflection = new \ReflectionMethod($classOrObject, $method);
121	return $reflection->isPublic();
122	}
123	/**
124	* Triggers an error if the development mode is enabled. Depending on the current environment / mode it will either
125	* log the given message or throw an exception to make sure it will be displayed in the Piwik UI.
126	*
127	* @param string $message
128	* @throws Exception
129	*/
130	public static function error($message)
131	{
132	if (!self::isEnabled()) {
133	return;
134	}
135	$message .= ' (This error is only shown in development mode)';
136	if (\Piwik\SettingsServer::isTrackerApiRequest() \|\| \Piwik\Common::isPhpCliMode()) {
137	StaticContainer::get(LoggerInterface::class)->error($message, ['ignoreInScreenWriter' => \true]);
138	} else {
139	throw new Exception($message);
140	}
141	}
142	public static function getMethodSourceCode($className, $methodName)
143	{
144	$method = new \ReflectionMethod($className, $methodName);
145	$file = new \SplFileObject($method->getFileName());
146	$offset = $method->getStartLine() - 1;
147	$count = $method->getEndLine() - $method->getStartLine() + 1;
148	$fileIterator = new \LimitIterator($file, $offset, $count);
149	$methodCode = "\n " . $method->getDocComment() . "\n";
150	foreach ($fileIterator as $line) {
151	$methodCode .= $line;
152	}
153	$methodCode .= "\n";
154	return $methodCode;
155	}
156	public static function getUseStatements($className)
157	{
158	$class = new \ReflectionClass($className);
159	$file = new \SplFileObject($class->getFileName());
160	$fileIterator = new \LimitIterator($file, 0, $class->getStartLine());
161	$uses = array();
162	foreach ($fileIterator as $line) {
163	if (preg_match('/(\\s*)use (.+)/', $line, $match)) {
164	$uses[] = trim($match[2]);
165	}
166	}
167	return $uses;
168	}
169	}
170