1
0
mirror of https://github.com/danog/amp.git synced 2024-12-12 09:29:45 +01:00
amp/lib/Struct.php

79 lines
2.2 KiB
PHP
Raw Normal View History

<?php
2016-08-16 06:46:26 +02:00
2014-11-11 17:11:58 +01:00
namespace Amp;
/**
* A "safe" struct trait for public property aggregators.
2015-02-05 18:17:05 +01:00
*
* This trait is intended to make using public properties a little safer by throwing when
* nonexistent property names are read or written.
*/
2018-06-18 20:00:01 +02:00
trait Struct
{
/**
* The minimum percentage [0-100] at which to recommend a similar property
* name when generating error messages.
*/
private $__propertySuggestThreshold = 70;
2020-03-28 22:20:44 +01:00
/**
* @param string $property
*
* @psalm-return no-return
*/
2018-06-18 20:00:01 +02:00
public function __get(string $property)
{
throw new \Error(
$this->generateStructPropertyError($property)
2014-11-11 17:11:58 +01:00
);
}
2020-03-28 22:20:44 +01:00
/**
* @param string $property
* @param mixed $value
*
* @psalm-return no-return
*/
2018-06-18 20:00:01 +02:00
public function __set(string $property, $value)
{
throw new \Error(
$this->generateStructPropertyError($property)
2014-11-11 17:11:58 +01:00
);
}
2018-06-18 20:00:01 +02:00
private function generateStructPropertyError(string $property): string
{
$suggestion = $this->suggestPropertyName($property);
$suggestStr = ($suggestion == "") ? "" : " ... did you mean \"{$suggestion}?\"";
2016-08-18 05:25:54 +02:00
return \sprintf(
"%s property \"%s\" does not exist%s",
2016-08-18 05:25:54 +02:00
\str_replace("\0", "@", \get_class($this)), // Handle anonymous class names.
$property,
$suggestStr
);
}
2018-06-18 20:00:01 +02:00
private function suggestPropertyName(string $badProperty): string
{
2016-08-18 05:25:54 +02:00
$badProperty = \strtolower($badProperty);
$bestMatch = "";
$bestMatchPercentage = 0;
2020-03-28 22:20:44 +01:00
/** @psalm-suppress RawObjectIteration */
foreach ($this as $property => $value) {
// Never suggest properties that begin with an underscore
if ($property[0] === "_") {
continue;
}
2016-08-18 05:25:54 +02:00
\similar_text($badProperty, \strtolower($property), $byRefPercentage);
if ($byRefPercentage > $bestMatchPercentage) {
$bestMatchPercentage = $byRefPercentage;
$bestMatch = $property;
}
}
return ($bestMatchPercentage >= $this->__propertySuggestThreshold) ? $bestMatch : "";
2014-11-11 17:11:58 +01:00
}
}