src/view/AphrontTagView.php

   1 <?php
   2
   3 /**
   4  * View which renders down to a single tag, and provides common access for tag
   5  * attributes (setting classes, sigils, IDs, etc).
   6  */
   7 abstract class AphrontTagView extends AphrontView {
   8
   9   private $id;
  10   private $classes = array();
  11   private $sigils = array();
  12   private $style;
  13   private $metadata;
  14   private $mustCapture;
  15   private $workflow;
  16
  17   public function setWorkflow($workflow) {
  18     $this->workflow = $workflow;
  19     return $this;
  20   }
  21
  22   public function getWorkflow() {
  23     return $this->workflow;
  24   }
  25
  26   public function setMustCapture($must_capture) {
  27     $this->mustCapture = $must_capture;
  28     return $this;
  29   }
  30
  31   public function getMustCapture() {
  32     return $this->mustCapture;
  33   }
  34
  35   final public function setMetadata(array $metadata) {
  36     $this->metadata = $metadata;
  37     return $this;
  38   }
  39
  40   final public function getMetadata() {
  41     return $this->metadata;
  42   }
  43
  44   final public function setStyle($style) {
  45     $this->style = $style;
  46     return $this;
  47   }
  48
  49   final public function getStyle() {
  50     return $this->style;
  51   }
  52
  53   final public function addSigil($sigil) {
  54     $this->sigils[] = $sigil;
  55     return $this;
  56   }
  57
  58   final public function getSigils() {
  59     return $this->sigils;
  60   }
  61
  62   public function addClass($class) {
  63     $this->classes[] = $class;
  64     return $this;
  65   }
  66
  67   public function getClasses() {
  68     return $this->classes;
  69   }
  70
  71   public function setID($id) {
  72     $this->id = $id;
  73     return $this;
  74   }
  75
  76   public function getID() {
  77     return $this->id;
  78   }
  79
  80   protected function getTagName() {
  81     return 'div';
  82   }
  83
  84   protected function getTagAttributes() {
  85     return array();
  86   }
  87
  88   protected function getTagContent() {
  89     return $this->renderChildren();
  90   }
  91
  92   final public function render() {
  93     $this->willRender();
  94
  95     // A tag view may render no tag at all. For example, the HandleListView is
  96     // a container which renders a tag in HTML mode, but can also render in
  97     // text mode without producing a tag. When a tag view has no tag name, just
  98     // return the tag content as though the view did not exist.
  99     $tag_name = $this->getTagName();
 100     if ($tag_name === null) {
 101       return $this->getTagContent();
 102     }
 103
 104     $attributes = $this->getTagAttributes();
 105
 106     $implode = array('class', 'sigil');
 107     foreach ($implode as $attr) {
 108       if (isset($attributes[$attr])) {
 109         if (is_array($attributes[$attr])) {
 110           $attributes[$attr] = implode(' ', $attributes[$attr]);
 111         }
 112       }
 113     }
 114
 115     if (!is_array($attributes)) {
 116       $class = get_class($this);
 117       throw new Exception(
 118         pht("View '%s' did not return an array from getTagAttributes()!",
 119           $class));
 120     }
 121
 122     $sigils = $this->sigils;
 123     if ($this->workflow) {
 124       $sigils[] = 'workflow';
 125     }
 126
 127     $tag_view_attributes = array(
 128       'id' => $this->id,
 129
 130       'class' => implode(' ', $this->classes),
 131       'style' => $this->style,
 132
 133       'meta' => $this->metadata,
 134       'sigil' => $sigils ? implode(' ', $sigils) : null,
 135       'mustcapture' => $this->mustCapture,
 136     );
 137
 138     foreach ($tag_view_attributes as $key => $value) {
 139       if ($value === null) {
 140         continue;
 141       }
 142       if (!isset($attributes[$key])) {
 143         $attributes[$key] = $value;
 144         continue;
 145       }
 146       switch ($key) {
 147         case 'class':
 148         case 'sigil':
 149           $attributes[$key] = $attributes[$key].' '.$value;
 150           break;
 151         default:
 152           // Use the explicitly set value rather than the tag default value.
 153           $attributes[$key] = $value;
 154           break;
 155       }
 156     }
 157
 158     return javelin_tag(
 159       $tag_name,
 160       $attributes,
 161       $this->getTagContent());
 162   }
 163 }