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

matomo / app / core / Development.php

matomo / app / core Last commit date

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 2 years 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 2 years 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 2 years ago Translation 2 years ago Twig 2 years ago UpdateCheck 2 years ago Updater 2 years ago Updates 2 years 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 2 years ago DbHelper.php 2 years 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 2 years ago Version.php 2 years ago View.php 2 years ago bootstrap.php 2 years ago dispatch.php 2 years ago testMinimumPhpVersion.php 2 years ago

Development.php

171 lines

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