You are here

final class Area in Physical Fields 8

Provides a value object for area amounts.

Usage example:

$area = new Area('7.00', AreaUnit::SQUARE_CENTIMETER);

Hierarchy

Expanded class hierarchy of Area

1 file declares its use of Area
AreaTest.php in tests/src/Unit/AreaTest.php
1 string reference to 'Area'
MeasurementType::getLabels in src/MeasurementType.php
Gets the labels for the defined measurement types.

File

src/Area.php, line 13

Namespace

Drupal\physical
View source
final class Area extends Measurement {

  /**
   * The measurement type.
   *
   * @var string
   */
  protected $type = MeasurementType::AREA;

}

Members

Namesort descending Modifiers Type Description Overrides
Area::$type protected property The measurement type. Overrides Measurement::$type
Measurement::$number protected property The number.
Measurement::$unit protected property The unit.
Measurement::add public function Adds the given measurement to the current one.
Measurement::compareTo public function Compares the current measurement with the given one.
Measurement::convert public function Converts the current measurement to a new unit. 1
Measurement::divide public function Divides the current measurement by the given number.
Measurement::equals public function Gets whether the current measurement is equivalent to the given one.
Measurement::getNumber public function Gets the number.
Measurement::getUnit public function Gets the unit.
Measurement::greaterThan public function Gets whether the current measurement is greater than the given one.
Measurement::greaterThanOrEqual public function Gets whether the current measurement is greater than or equal to the given one.
Measurement::isZero public function Gets whether the current measurement is zero.
Measurement::lessThan public function Gets whether the current measurement is lesser than the given measurement.
Measurement::lessThanOrEqual public function Gets whether the current measurement is lesser than or equal to the given measurement.
Measurement::multiply public function Multiplies the current measurement by the given number.
Measurement::round public function Rounds the current measurement.
Measurement::subtract public function Subtracts the given measurement from the current one.
Measurement::toArray public function Gets the array representation of the measurement.
Measurement::__construct public function Constructs a new Measurement object.
Measurement::__toString public function Gets the string representation of the measurement.