diff --git a/flag.module b/flag.module index 9fbd375..03b2343 100644 --- a/flag.module +++ b/flag.module @@ -157,7 +157,7 @@ function flag_form_alter(&$form, FormStateInterface $form_state, $form_id) { $form['flag'][$flag->id()] = array( '#type' => 'checkbox', '#title' => $flag->label(), - '#description' => $flag->getFlagLongText(), + '#description' => $flag->getLongText('flag'), '#default_value' => is_null($flagging)? NULL: 1, '#return_value' => 1, // Used by our drupalSetSummary() on vertical tabs. @@ -579,7 +579,7 @@ function flag_flag_insert(FlagInterface $flag) { $action = Action::create([ 'id' => $flag_id, 'type' => $flag->getFlaggableEntityTypeId(), - 'label' => $flag->getFlagShortText(), + 'label' => $flag->getShortText('flag'), 'plugin' => 'flag_action:' . $flag->id() . '.flag', 'configuration' => [ 'flag_id' => $flag->id(), @@ -593,7 +593,7 @@ function flag_flag_insert(FlagInterface $flag) { $action = Action::create([ 'id' => $unflag_id, 'type' => $flag->getFlaggableEntityTypeId(), - 'label' => $flag->getUnflagShortText(), + 'label' => $flag->getShortText('unflag'), 'plugin' => 'flag_action:' . $flag->id() . '.unflag', 'configuration' => [ 'flag_id' => $flag->id(), diff --git a/src/ActionLink/ActionLinkTypeBase.php b/src/ActionLink/ActionLinkTypeBase.php index ad2688b..19b9a05 100644 --- a/src/ActionLink/ActionLinkTypeBase.php +++ b/src/ActionLink/ActionLinkTypeBase.php @@ -85,7 +85,7 @@ abstract class ActionLinkTypeBase extends PluginBase implements ActionLinkTypePl $action = $this->getAction($flag, $entity); $url = $this->getUrl($action, $flag, $entity); $url->setOption('query', ['destination' => $this->getDestination()]); - $title = $action === 'unflag' ? $flag->getUnflagShortText() : $flag->getFlagShortText(); + $title = $flag->getShortText($action); return Link::fromTextAndUrl($title, $url); } @@ -106,9 +106,9 @@ abstract class ActionLinkTypeBase extends PluginBase implements ActionLinkTypePl '#flaggable' => $entity, '#action' => $action, '#access' => $access->isAllowed(), - '#title' => $action === 'unflag' ? $flag->getUnflagShortText() : $flag->getFlagShortText(), + '#title' => $flag->getShortText($action), '#attributes' => [ - 'title' => $action === 'unflag' ? $flag->getUnflagLongText() : $flag->getFlagLongText(), + 'title' => $flag->getLongText($action), ], ]; // Build the URL. It is important that bubbleable metadata is explicitly diff --git a/src/Entity/Flag.php b/src/Entity/Flag.php index 3175cf9..8220dad 100644 --- a/src/Entity/Flag.php +++ b/src/Entity/Flag.php @@ -384,15 +384,15 @@ class Flag extends ConfigEntityBundleBase implements FlagInterface { /** * {@inheritdoc} */ - public function getFlagShortText() { - return $this->flag_short; + public function getShortText($action) { + return $action === 'unflag' ? $this->unflag_short : $this->flag_short; } /** * {@inheritdoc} */ - public function getFlagLongText() { - return $this->flag_long; + public function getLongText($action) { + return $action === 'unflag' ? $this->unflag_long : $this->flag_long; } /** @@ -419,13 +419,6 @@ class Flag extends ConfigEntityBundleBase implements FlagInterface { /** * {@inheritdoc} */ - public function getUnflagLongText() { - return $this->unflag_long; - } - - /** - * {@inheritdoc} - */ public function setUnflagLongText($unflag_long) { $this->unflag_long = $unflag_long; } @@ -447,13 +440,6 @@ class Flag extends ConfigEntityBundleBase implements FlagInterface { /** * {@inheritdoc} */ - public function getUnflagShortText() { - return $this->unflag_short; - } - - /** - * {@inheritdoc} - */ public function setUnflagShortText($unflag_short) { $this->unflag_short = $unflag_short; } diff --git a/src/FlagInterface.php b/src/FlagInterface.php index 7ba20b4..a26eb05 100644 --- a/src/FlagInterface.php +++ b/src/FlagInterface.php @@ -162,18 +162,24 @@ interface FlagInterface extends ConfigEntityInterface, EntityWithPluginCollectio /** * Gets the flag short text. * + * @param string $action + * The flag action, either 'flag' or 'unflag'. + * * @return string * A string containing the flag short text. */ - public function getFlagShortText(); + public function getShortText($action); /** * Gets the flag long text. * + * @param string $action + * The flag action, either 'flag' or 'unflag'. + * * @return string * A string containing the flag long text. */ - public function getFlagLongText(); + public function getLongText($action); /** * Sets the flag long text. @@ -200,14 +206,6 @@ interface FlagInterface extends ConfigEntityInterface, EntityWithPluginCollectio public function setFlagMessage($flag_message); /** - * Gets the unflag short text. - * - * @return string - * A string containing the unflag short text. - */ - public function getUnflagShortText(); - - /** * Sets the unflag short text. * * @param string $flag_short @@ -216,14 +214,6 @@ interface FlagInterface extends ConfigEntityInterface, EntityWithPluginCollectio public function setUnflagShortText($flag_short); /** - * Gets the flag long text. - * - * @return string - * A string containing the unflag long text. - */ - public function getUnflagLongText(); - - /** * Sets the unflag long text. * * @param string $unflag_long diff --git a/src/Form/FlagConfirmForm.php b/src/Form/FlagConfirmForm.php index 3b8b15c..77a0520 100644 --- a/src/Form/FlagConfirmForm.php +++ b/src/Form/FlagConfirmForm.php @@ -32,7 +32,7 @@ class FlagConfirmForm extends FlagConfirmFormBase { * {@inheritdoc} */ public function getDescription() { - return $this->flag->getFlagLongText(); + return $this->flag->getLongText('flag'); } /** diff --git a/src/Form/FlagFormBase.php b/src/Form/FlagFormBase.php index 21b03c2..4f0079e 100644 --- a/src/Form/FlagFormBase.php +++ b/src/Form/FlagFormBase.php @@ -108,7 +108,7 @@ abstract class FlagFormBase extends EntityForm { '#title' => $this->t('Messages'), ]; - $flag_short = $flag->getFlagShortText(); + $flag_short = $flag->getShortText('flag'); $form['messages']['flag_short'] = [ '#type' => 'textfield', '#title' => $this->t('Flag link text'), @@ -120,7 +120,7 @@ abstract class FlagFormBase extends EntityForm { $form['messages']['flag_long'] = [ '#type' => 'textfield', '#title' => $this->t('Flag link description'), - '#default_value' => $flag->getFlagLongText(), + '#default_value' => $flag->getLongText('flag'), '#description' => $this->t('The description of the "flag this" link. Usually displayed on mouseover.'), ]; @@ -131,7 +131,7 @@ abstract class FlagFormBase extends EntityForm { '#description' => $this->t('Message displayed after flagging content. If JavaScript is enabled, it will be displayed below the link. If not, it will be displayed in the message area.'), ]; - $unflag_short = $flag->getUnflagShortText(); + $unflag_short = $flag->getShortText('unflag'); $form['messages']['unflag_short'] = [ '#type' => 'textfield', '#title' => $this->t('Unflag link text'), @@ -143,7 +143,7 @@ abstract class FlagFormBase extends EntityForm { $form['messages']['unflag_long'] = [ '#type' => 'textfield', '#title' => $this->t('Unflag link description'), - '#default_value' => $flag->getUnflagLongText(), + '#default_value' => $flag->getLongText('unflag'), '#description' => $this->t('The description of the "unflag this" link. Usually displayed on mouseover.'), ]; diff --git a/src/Form/UnflagConfirmForm.php b/src/Form/UnflagConfirmForm.php index 903f2b1..f91a925 100644 --- a/src/Form/UnflagConfirmForm.php +++ b/src/Form/UnflagConfirmForm.php @@ -30,7 +30,7 @@ class UnflagConfirmForm extends FlagConfirmFormBase { * {@inheritdoc} */ public function getDescription() { - return $this->flag->getUnflagLongText(); + return $this->flag->getLongText('unflag'); } /** diff --git a/src/Form/UnflaggingForm.php b/src/Form/UnflaggingForm.php index cb9d84f..045efa4 100644 --- a/src/Form/UnflaggingForm.php +++ b/src/Form/UnflaggingForm.php @@ -52,7 +52,7 @@ class UnflaggingForm extends FlagConfirmFormBase { * {@inheritdoc} */ public function getDescription() { - return $this->flag->getUnflagLongText(); + return $this->flag->getLongText('unflag'); } /** diff --git a/src/Plugin/Derivative/EntityFlagActionDeriver.php b/src/Plugin/Derivative/EntityFlagActionDeriver.php index 0f6d52d..f0862e0 100644 --- a/src/Plugin/Derivative/EntityFlagActionDeriver.php +++ b/src/Plugin/Derivative/EntityFlagActionDeriver.php @@ -47,7 +47,7 @@ class EntityFlagActionDeriver extends DeriverBase implements ContainerDeriverInt foreach (['flag', 'unflag'] as $action) { $this->derivatives[$flag_id . '.' . $action] = [ 'id' => $flag_id . '.' . $action, - 'label' => $action === 'unflag' ? $flag->getUnflagShortText() : $flag->getFlagShortText(), + 'label' => $flag->getShortText($action), 'type' => $flag->getFlaggableEntityTypeId(), ] + $base_plugin_definition; } diff --git a/src/Tests/FlagContextualLinksTest.php b/src/Tests/FlagContextualLinksTest.php index d9d0492..8014113 100644 --- a/src/Tests/FlagContextualLinksTest.php +++ b/src/Tests/FlagContextualLinksTest.php @@ -152,8 +152,7 @@ class FlagContextualLinksTest extends FlagTestBase { 'entity_id' => $node->id(), )); - $flag_short_text = $flag_action == 'flag' ? $flag->getFlagShortText() : $flag->getUnflagShortText(); - + $flag_short_text = $flag->getShortText($flag_action); $matches = array(); $url_pattern = preg_quote(base_path()) . '(' . preg_quote($flag_url->getInternalPath(), '@') . '[^"]*)'; $found = preg_match('@' . preg_quote('