1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
<?php
namespace Tev\Field\Model;
use Exception;
/**
* File field.
*
* Will normalize the data that comes from the field to attempt to return
* all attributes.
*/
class FileField extends AbstractField
{
/**
* Attachment ID.
*
* @var string
*/
protected $atId;
/**
* Attachemnt URL.
*
* @var string
*/
protected $atUrl;
/**
* Attachment title.
*
* @var string
*/
protected $atTitle;
/**
* Attachment caption.
*
* @var string
*/
protected $atCaption;
/**
* Attachment description.
*
* @var string
*/
protected $atDescription;
/**
* {@inheritDoc}
*/
public function __construct($data)
{
parent::__construct($data);
$this->normalize();
}
/**
* Get the attachment URL.
*
* @return string
*/
public function getValue()
{
return $this->url();
}
/**
* Get the attachment ID.
*
* May be empty, depending on field config.
*
* @return string
*/
public function id()
{
return $this->atId;
}
/**
* Get the attachment URL.
*
* May be empty, depending on field config.
*
* @return string
*/
public function url()
{
return $this->atUrl;
}
/**
* Get the attachment title.
*
* May be empty, depending on field config.
*
* @return string
*/
public function title()
{
return $this->atTitle;
}
/**
* Get the attachment caption.
*
* May be empty, depending on field config.
*
* @return string
*/
public function caption()
{
return $this->atCaption;
}
/**
* Get the attachment description.
*
* May be empty, depending on field config.
*
* @return string
*/
public function description()
{
return $this->atDescription;
}
/**
* Normalize attachment data, depending on how the underlying field is
* configured.
*
* @return void
*
* @throws \Exception If invalid return_format is found
*/
protected function normalize()
{
$val = $this->base['value'];
if ($val) {
switch ($this->base['return_format']) {
case 'array':
$this->atId = $val['ID'];
$this->atUrl = $val['url'];
$this->atTitle = $val['title'];
$this->atCaption = $val['caption'];
$this->atDescription = $val['description'];
break;
case 'id':
$atch = get_post($val);
$this->atId = $val;
$this->atUrl = wp_get_attachment_url($val);
$this->atTitle = $atch->post_title;
$this->atCaption = $atch->post_excerpt;
$this->atDescription = $atch->description;
break;
case 'url':
$this->atId = '';
$this->atUrl = $this->base['value'];
$this->atTitle = '';
$this->atCaption = '';
$this->atDescription = '';
break;
default:
throw new Exception("Field format {$this->base['return_format']} not valid");
}
} else {
$this->atId = '';
$this->atUrl = '';
$this->atTitle = '';
$this->atCaption = '';
$this->atDescription = '';
}
}
}