You are here

class Animal in farmOS 2.x

Same name in this branch
  1. 2.x modules/asset/animal/src/Plugin/Asset/AssetType/Animal.php \Drupal\farm_animal\Plugin\Asset\AssetType\Animal
  2. 2.x modules/asset/group/tests/modules/farm_group_test/src/Plugin/Asset/AssetType/Animal.php \Drupal\farm_group_test\Plugin\Asset\AssetType\Animal

Provides the animal asset type.

Plugin annotation


@AssetType(
  id = "animal",
  label = @Translation("Animal"),
)

Hierarchy

Expanded class hierarchy of Animal

2 string references to 'Animal'
asset.type.animal.yml in modules/asset/animal/config/install/asset.type.animal.yml
modules/asset/animal/config/install/asset.type.animal.yml
asset.type.animal.yml in modules/asset/group/tests/modules/farm_group_test/config/install/asset.type.animal.yml
modules/asset/group/tests/modules/farm_group_test/config/install/asset.type.animal.yml

File

modules/asset/animal/src/Plugin/Asset/AssetType/Animal.php, line 15

Namespace

Drupal\farm_animal\Plugin\Asset\AssetType
View source
class Animal extends FarmAssetType {

  /**
   * {@inheritdoc}
   */
  public function buildFieldDefinitions() {
    $fields = parent::buildFieldDefinitions();
    $field_info = [
      'animal_type' => [
        'type' => 'entity_reference',
        'label' => $this
          ->t('Species/breed'),
        'description' => $this
          ->t("Enter this animal asset's species/breed."),
        'target_type' => 'taxonomy_term',
        'target_bundle' => 'animal_type',
        'auto_create' => TRUE,
        'required' => TRUE,
        'weight' => [
          'form' => -90,
          'view' => -50,
        ],
      ],
      'birthdate' => [
        'type' => 'timestamp',
        'label' => $this
          ->t('Birthdate'),
        'weight' => [
          'form' => 15,
          'view' => -35,
        ],
      ],
      'is_castrated' => [
        'type' => 'boolean',
        'label' => $this
          ->t('Castrated'),
        'description' => $this
          ->t('Has this animal been castrated?'),
        'weight' => [
          'form' => 26,
        ],
        'view_display_options' => [
          'label' => 'inline',
          'type' => 'hideable_boolean',
          'settings' => [
            'format' => 'default',
            'format_custom_false' => '',
            'format_custom_true' => '',
            'hide_if_false' => TRUE,
          ],
          'weight' => -25,
        ],
      ],
      'nickname' => [
        'type' => 'string',
        'label' => $this
          ->t('Nicknames'),
        'description' => $this
          ->t('List any nicknames of this animal.'),
        'multiple' => TRUE,
        'weight' => [
          'form' => 10,
          'view' => -40,
        ],
      ],
      'sex' => [
        'type' => 'list_string',
        'label' => $this
          ->t('Sex'),
        'allowed_values' => [
          'F' => $this
            ->t('Female'),
          'M' => $this
            ->t('Male'),
        ],
        'weight' => [
          'form' => 20,
          'view' => -30,
        ],
      ],
    ];
    foreach ($field_info as $name => $info) {
      $fields[$name] = $this->farmFieldFactory
        ->bundleFieldDefinition($info);
    }
    return $fields;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Animal::buildFieldDefinitions public function Overrides AssetTypeBase::buildFieldDefinitions
AssetTypeBase::getLabel public function Gets the asset type label. Overrides AssetTypeInterface::getLabel
AssetTypeBase::getWorkflowId public function Gets the asset workflow ID. Overrides AssetTypeInterface::getWorkflowId
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FarmEntityTypeBase::$farmFieldFactory protected property The farm_field.factory service.
FarmEntityTypeBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FarmEntityTypeBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.