-
-
Notifications
You must be signed in to change notification settings - Fork 825
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Civi/Schema - Extract FluentGetterSetterTrait. Add test coverage.
- Loading branch information
Showing
3 changed files
with
189 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| <?php | ||
| /* | ||
| +--------------------------------------------------------------------+ | ||
| | Copyright CiviCRM LLC. All rights reserved. | | ||
| | | | ||
| | This work is published under the GNU AGPLv3 license with some | | ||
| | permitted exceptions and without any warranty. For full license | | ||
| | and copyright information, see https://civicrm.org/licensing | | ||
| +--------------------------------------------------------------------+ | ||
| */ | ||
|
|
||
| namespace Civi\Schema\Traits; | ||
|
|
||
| /** | ||
| * Automatically define getter/setter methods for public and protected fields. | ||
| * | ||
| * For example, a protected field `$fooBar` will have methods `setFooBar($new)`, `getFooBar()`, and `isFooBar()`. | ||
| * | ||
| * You may optionally implement more specialized getters/setters for specific properties. | ||
| * | ||
| * Fields which begin with `_` will be excluded. | ||
| * | ||
| * @package Civi\Schema\Traits | ||
| */ | ||
| trait FluentGetterSetterTrait { | ||
|
|
||
| /** | ||
| * Magic function to provide getters/setters. | ||
| * | ||
| * @param string $method | ||
| * @param array $arguments | ||
| * @return static|mixed | ||
| * @throws \CRM_Core_Exception | ||
| */ | ||
| public function __call($method, $arguments) { | ||
| $mode = substr($method, 0, 3); | ||
| $prop = lcfirst(substr($method, 3)); | ||
| $props = static::getMagicProperties(); | ||
| if (isset($props[$prop])) { | ||
| switch ($mode) { | ||
| case 'get': | ||
| return $this->$prop; | ||
|
|
||
| case 'set': | ||
| $this->$prop = $arguments[0]; | ||
| return $this; | ||
| } | ||
| } | ||
|
|
||
| throw new \CRM_Core_Exception(sprintf('Unknown method: %s::%s()', static::CLASS, $method)); | ||
| } | ||
|
|
||
| /** | ||
| * Get a list of class properties for which magic methods are supported. | ||
| * | ||
| * @return array | ||
| * List of supported properties, keyed by property name. | ||
| * Array(string $propertyName => bool $true). | ||
| */ | ||
| protected static function getMagicProperties(): array { | ||
| // Thread-local cache of class metadata. This is strictly readonly and immutable, and it should ideally be reused across varied test-functions. | ||
| static $cache = []; | ||
|
|
||
| if (!isset($cache[static::CLASS])) { | ||
| try { | ||
| $clazz = new \ReflectionClass(static::CLASS); | ||
| } | ||
| catch (\ReflectionException $e) { | ||
| // This shouldn't happen. Cast to RuntimeException so that we don't have a million `@throws` statements. | ||
| throw new \RuntimeException(sprintf("Class %s cannot reflect upon itself.", static::CLASS)); | ||
| } | ||
|
|
||
| $fields = []; | ||
| foreach ($clazz->getProperties(\ReflectionProperty::IS_PROTECTED | \ReflectionProperty::IS_PUBLIC) as $property) { | ||
| $name = $property->getName(); | ||
| if (!$property->isStatic() && $name[0] !== '_') { | ||
| $fields[$name] = TRUE; | ||
| } | ||
| } | ||
| unset($clazz); | ||
| $cache[static::CLASS] = $fields; | ||
| } | ||
| return $cache[static::CLASS]; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| <?php | ||
|
|
||
| namespace Civi\Schema; | ||
|
|
||
| use Civi\Schema\Traits\FluentGetterSetterTrait; | ||
|
|
||
| class FluentGetterSetterTest extends \CiviUnitTestCase { | ||
|
|
||
| public function createExample() { | ||
| return new class() { | ||
|
|
||
| use FluentGetterSetterTrait; | ||
|
|
||
| protected $protectedField; | ||
| public $publicField; | ||
| protected $_obscureProtectedField; | ||
| public $_obscurePublicField; | ||
| protected $overriddenProtectedField; | ||
| protected $set; | ||
| protected $get; | ||
|
|
||
| /** | ||
| * @return mixed | ||
| */ | ||
| public function getOverriddenProtectedField() { | ||
| return $this->overriddenProtectedField . '_and_get'; | ||
| } | ||
|
|
||
| /** | ||
| * @param mixed $overriddenProtectedField | ||
| * @return $this | ||
| */ | ||
| public function setOverriddenProtectedField($overriddenProtectedField) { | ||
| $this->overriddenProtectedField = $overriddenProtectedField . '_and_set'; | ||
| return $this; | ||
| } | ||
|
|
||
| }; | ||
| } | ||
|
|
||
| public function testExample() { | ||
| $ex = $this->createExample(); | ||
| $this->assertEquals(NULL, $ex->setProtectedField(NULL)->getProtectedField()); | ||
| $this->assertEquals('apple', $ex->setProtectedField('apple')->getProtectedField()); | ||
| $this->assertEquals('banana', $ex->setPublicField('banana')->getPublicField()); | ||
| $this->assertEquals('cherry', $ex->setSet('cherry')->getSet()); | ||
| $this->assertEquals('date', $ex->setGet('date')->getGet()); | ||
| $this->assertEquals('base_and_set_and_get', $ex->setOverriddenProtectedField('base')->getOverriddenProtectedField()); | ||
|
|
||
| $nonMethods = [ | ||
| 'goozfraba', | ||
|
|
||
| // Typos | ||
| 'seProtectedField', | ||
| 'geProtectedField', | ||
| 'istProtectedField', | ||
|
|
||
| // Obscure fields | ||
| 'set_obscureProtectedField', | ||
| 'get_obscureProtectedField', | ||
| 'is_obscureProtectedField', | ||
| 'setObscureProtectedField', | ||
| 'getObscureProtectedField', | ||
| 'isObscureProtectedField', | ||
| 'set_obscurePublicField', | ||
| 'get_obscurePublicField', | ||
| 'is_obscurePublicField', | ||
| 'setObscurePublicField', | ||
| 'getObscurePublicField', | ||
| 'isObscurePublicField', | ||
|
|
||
| // Funny substrings | ||
| 'i', | ||
| 'g', | ||
| 's', | ||
| 'set', | ||
| 'get', | ||
| 'is', | ||
| 'istanbul', | ||
| 'getter', | ||
| 'setter', | ||
| ]; | ||
| foreach ($nonMethods as $nonMethod) { | ||
| try { | ||
| $ex->{$nonMethod}(); | ||
| $this->fail("Method $nonMethod() should raise exception."); | ||
| } | ||
| catch (\CRM_Core_Exception $e) { | ||
| $message = $e->getMessage(); | ||
| $this->assertRegExp('/Unknown method.*::' . $nonMethod . '()/', $message); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| } |