- md5
- af1b28d2c339ac99a660c7429a3fdbb9
- sha1
- 8d8ead7ffba6f507c4bf7749830ea3e6ec11b445
- sha256
- 46afb239080e89d082b68a210f44b5014feb6700d58457a3272bd025c088ef0b
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
<?php
/**
* @package Joomla.Administrator
* @subpackage com_users
*
* @copyright (C) 2022 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\Component\Users\Administrator\DataShape;
use InvalidArgumentException;
// This line is required because of the PHP 8 attributes which are necessary to prevent PHP notices
//phpcs:ignoreFile
/**
* Generic helper for handling data shapes in com_users
*
* @since 4.2.0
*/
abstract class DataShapeObject implements \ArrayAccess
{
/**
* Public constructor
*
* @param array $array The data to initialise this object with
*
* @since 4.2.0
*/
public function __construct(array $array = [])
{
if (!is_array($array) && !($array instanceof self))
{
throw new InvalidArgumentException(sprintf('%s needs an array or a %s object', __METHOD__, __CLASS__));
}
foreach (($array instanceof self) ? $array->asArray() : $array as $k => $v)
{
$this[$k] = $v;
}
}
/**
* Get the data shape as a key-value array
*
* @return array
*
* @since 4.2.0
*/
public function asArray(): array
{
return get_object_vars($this);
}
/**
* Merge another data shape object or key-value array into this object.
*
* @param array|self $newValues The object or array to merge into self.
*
* @return $this
*
* @since 4.2.0
*/
public function merge($newValues): self
{
if (!is_array($newValues) && !($newValues instanceof self))
{
throw new InvalidArgumentException(sprintf('%s needs an array or a %s object', __METHOD__, __CLASS__));
}
foreach (($newValues instanceof self) ? $newValues->asArray() : $newValues as $k => $v)
{
if (!isset($this->{$k}))
{
continue;
}
$this[$k] = $v;
}
return $this;
}
/**
* Magic getter
*
* @param string $name The name of the property to retrieve
*
* @return mixed
*
* @since 4.2.0
*/
public function __get($name)
{
$methodName = 'get' . ucfirst($name);
if (method_exists($this, $methodName))
{
return $this->{$methodName};
}
if (property_exists($this, $name))
{
return $this->{$name};
}
throw new InvalidArgumentException(sprintf('Property %s not found in %s', $name, __CLASS__));
}
/**
* Magic Setter
*
* @param string $name The property to set the value for
* @param mixed $value The property value to set it to
*
* @return mixed
* @since 4.2.0
*/
public function __set($name, $value)
{
$methodName = 'set' . ucfirst($name);
if (method_exists($this, $methodName))
{
return $this->{$methodName}($value);
}
if (property_exists($this, $name))
{
$this->{$name} = $value;
}
throw new InvalidArgumentException(sprintf('Property %s not found in %s', $name, __CLASS__));
}
/**
* Is a property set?
*
* @param string $name Property name
*
* @return boolean Does it exist in the object?
* @since 4.2.0
*/
#[\ReturnTypeWillChange]
public function __isset($name)
{
$methodName = 'get' . ucfirst($name);
return method_exists($this, $methodName) || property_exists($this, $name);
}
/**
* Does the property exist (array access)?
*
* @param string $offset Property name
*
* @return boolean
* @since 4.2.0
*/
#[\ReturnTypeWillChange]
public function offsetExists($offset)
{
return isset($this->{$offset});
}
/**
* Get the value of a property (array access).
*
* @param string $offset Property name
*
* @return mixed
* @since 4.2.0
*/
#[\ReturnTypeWillChange]
public function offsetGet($offset)
{
return $this->{$offset};
}
/**
* Set the value of a property (array access).
*
* @param string $offset Property name
* @param mixed $value Property value
*
* @return void
* @since 4.2.0
*/
#[\ReturnTypeWillChange]
public function offsetSet($offset, $value)
{
$this->{$offset} = $value;
}
/**
* Unset a property (array access).
*
* @param string $offset Property name
*
* @return mixed
* @since 4.2.0
*/
#[\ReturnTypeWillChange]
public function offsetUnset($offset)
{
throw new \LogicException(sprintf('You cannot unset members of %s', __CLASS__));
}
}
The same content is in 2 releases, Joomla 4.2.0-beta1 to 4.2.0-beta2. See them all, or every version of this file.