Blame view

addons/fastflow/library/PHPWord-master/src/PhpWord/Element/AbstractElement.php 11.4 KB
2db47680   hexiaodong   chore: 初始提交 php 遗...
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
  <?php
  /**
   * This file is part of PHPWord - A pure PHP library for reading and writing
   * word processing documents.
   *
   * PHPWord is free software distributed under the terms of the GNU Lesser
   * General Public License version 3 as published by the Free Software Foundation.
   *
   * For the full copyright and license information, please read the LICENSE
   * file that was distributed with this source code. For the full list of
   * contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
   *
   * @see         https://github.com/PHPOffice/PHPWord
   * @copyright   2010-2018 PHPWord contributors
   * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
   */
  
  namespace PhpOffice\PhpWord\Element;
  
  use PhpOffice\PhpWord\Media;
  use PhpOffice\PhpWord\PhpWord;
  
  /**
   * Element abstract class
   *
   * @since 0.10.0
   */
  abstract class AbstractElement
  {
      /**
       * PhpWord object
       *
       * @var \PhpOffice\PhpWord\PhpWord
       */
      protected $phpWord;
  
      /**
       * Section Id
       *
       * @var int
       */
      protected $sectionId;
  
      /**
       * Document part type: Section|Header|Footer|Footnote|Endnote
       *
       * Used by textrun and cell container to determine where the element is
       * located because it will affect the availability of other element,
       * e.g. footnote will not be available when $docPart is header or footer.
       *
       * @var string
       */
      protected $docPart = 'Section';
  
      /**
       * Document part Id
       *
       * For header and footer, this will be = ($sectionId - 1) * 3 + $index
       * because the max number of header/footer in every page is 3, i.e.
       * AUTO, FIRST, and EVEN (AUTO = ODD)
       *
       * @var int
       */
      protected $docPartId = 1;
  
      /**
       * Index of element in the elements collection (start with 1)
       *
       * @var int
       */
      protected $elementIndex = 1;
  
      /**
       * Unique Id for element
       *
       * @var string
       */
      protected $elementId;
  
      /**
       * Relation Id
       *
       * @var int
       */
      protected $relationId;
  
      /**
       * Depth of table container nested level; Primarily used for RTF writer/reader
       *
       * 0 = Not in a table; 1 = in a table; 2 = in a table inside another table, etc.
       *
       * @var int
       */
      private $nestedLevel = 0;
  
      /**
       * A reference to the parent
       *
       * @var AbstractElement|null
       */
      private $parent;
  
      /**
       * changed element info
       *
       * @var TrackChange
       */
      private $trackChange;
  
      /**
       * Parent container type
       *
       * @var string
       */
      private $parentContainer;
  
      /**
       * Has media relation flag; true for Link, Image, and Object
       *
       * @var bool
       */
      protected $mediaRelation = false;
  
      /**
       * Is part of collection; true for Title, Footnote, Endnote, Chart, and Comment
       *
       * @var bool
       */
      protected $collectionRelation = false;
  
      /**
       * The start position for the linked comment
       *
       * @var Comment
       */
      protected $commentRangeStart;
  
      /**
       * The end position for the linked comment
       *
       * @var Comment
       */
      protected $commentRangeEnd;
  
      /**
       * Get PhpWord
       *
       * @return \PhpOffice\PhpWord\PhpWord
       */
      public function getPhpWord()
      {
          return $this->phpWord;
      }
  
      /**
       * Set PhpWord as reference.
       *
       * @param \PhpOffice\PhpWord\PhpWord $phpWord
       */
      public function setPhpWord(PhpWord $phpWord = null)
      {
          $this->phpWord = $phpWord;
      }
  
      /**
       * Get section number
       *
       * @return int
       */
      public function getSectionId()
      {
          return $this->sectionId;
      }
  
      /**
       * Set doc part.
       *
       * @param string $docPart
       * @param int $docPartId
       */
      public function setDocPart($docPart, $docPartId = 1)
      {
          $this->docPart = $docPart;
          $this->docPartId = $docPartId;
      }
  
      /**
       * Get doc part
       *
       * @return string
       */
      public function getDocPart()
      {
          return $this->docPart;
      }
  
      /**
       * Get doc part Id
       *
       * @return int
       */
      public function getDocPartId()
      {
          return $this->docPartId;
      }
  
      /**
       * Return media element (image, object, link) container name
       *
       * @return string section|headerx|footerx|footnote|endnote
       */
      private function getMediaPart()
      {
          $mediaPart = $this->docPart;
          if ($mediaPart == 'Header' || $mediaPart == 'Footer') {
              $mediaPart .= $this->docPartId;
          }
  
          return strtolower($mediaPart);
      }
  
      /**
       * Get element index
       *
       * @return int
       */
      public function getElementIndex()
      {
          return $this->elementIndex;
      }
  
      /**
       * Set element index.
       *
       * @param int $value
       */
      public function setElementIndex($value)
      {
          $this->elementIndex = $value;
      }
  
      /**
       * Get element unique ID
       *
       * @return string
       */
      public function getElementId()
      {
          return $this->elementId;
      }
  
      /**
       * Set element unique ID from 6 first digit of md5.
       */
      public function setElementId()
      {
          $this->elementId = substr(md5(rand()), 0, 6);
      }
  
      /**
       * Get relation Id
       *
       * @return int
       */
      public function getRelationId()
      {
          return $this->relationId;
      }
  
      /**
       * Set relation Id.
       *
       * @param int $value
       */
      public function setRelationId($value)
      {
          $this->relationId = $value;
      }
  
      /**
       * Get nested level
       *
       * @return int
       */
      public function getNestedLevel()
      {
          return $this->nestedLevel;
      }
  
      /**
       * Get comment start
       *
       * @return Comment
       */
      public function getCommentRangeStart()
      {
          return $this->commentRangeStart;
      }
  
      /**
       * Set comment start
       *
       * @param Comment $value
       */
      public function setCommentRangeStart(Comment $value)
      {
          if ($this instanceof Comment) {
              throw new \InvalidArgumentException('Cannot set a Comment on a Comment');
          }
          $this->commentRangeStart = $value;
          $this->commentRangeStart->setStartElement($this);
      }
  
      /**
       * Get comment end
       *
       * @return Comment
       */
      public function getCommentRangeEnd()
      {
          return $this->commentRangeEnd;
      }
  
      /**
       * Set comment end
       *
       * @param Comment $value
       */
      public function setCommentRangeEnd(Comment $value)
      {
          if ($this instanceof Comment) {
              throw new \InvalidArgumentException('Cannot set a Comment on a Comment');
          }
          $this->commentRangeEnd = $value;
          $this->commentRangeEnd->setEndElement($this);
      }
  
      /**
       * Get parent element
       *
       * @return AbstractElement|null
       */
      public function getParent()
      {
          return $this->parent;
      }
  
      /**
       * Set parent container
       *
       * Passed parameter should be a container, except for Table (contain Row) and Row (contain Cell)
       *
       * @param \PhpOffice\PhpWord\Element\AbstractElement $container
       */
      public function setParentContainer(self $container)
      {
          $this->parentContainer = substr(get_class($container), strrpos(get_class($container), '\\') + 1);
          $this->parent = $container;
  
          // Set nested level
          $this->nestedLevel = $container->getNestedLevel();
          if ($this->parentContainer == 'Cell') {
              $this->nestedLevel++;
          }
  
          // Set phpword
          $this->setPhpWord($container->getPhpWord());
  
          // Set doc part
          if (!$this instanceof Footnote) {
              $this->setDocPart($container->getDocPart(), $container->getDocPartId());
          }
  
          $this->setMediaRelation();
          $this->setCollectionRelation();
      }
  
      /**
       * Set relation Id for media elements (link, image, object; legacy of OOXML)
       *
       * - Image element needs to be passed to Media object
       * - Icon needs to be set for Object element
       */
      private function setMediaRelation()
      {
          if (!$this instanceof Link && !$this instanceof Image && !$this instanceof OLEObject) {
              return;
          }
  
          $elementName = substr(get_class($this), strrpos(get_class($this), '\\') + 1);
          if ($elementName == 'OLEObject') {
              $elementName = 'Object';
          }
          $mediaPart = $this->getMediaPart();
          $source = $this->getSource();
          $image = null;
          if ($this instanceof Image) {
              $image = $this;
          }
          $rId = Media::addElement($mediaPart, strtolower($elementName), $source, $image);
          $this->setRelationId($rId);
  
          if ($this instanceof OLEObject) {
              $icon = $this->getIcon();
              $rId = Media::addElement($mediaPart, 'image', $icon, new Image($icon));
              $this->setImageRelationId($rId);
          }
      }
  
      /**
       * Set relation Id for elements that will be registered in the Collection subnamespaces.
       */
      private function setCollectionRelation()
      {
          if ($this->collectionRelation === true && $this->phpWord instanceof PhpWord) {
              $elementName = substr(get_class($this), strrpos(get_class($this), '\\') + 1);
              $addMethod = "add{$elementName}";
              $rId = $this->phpWord->$addMethod($this);
              $this->setRelationId($rId);
          }
      }
  
      /**
       * Check if element is located in Section doc part (as opposed to Header/Footer)
       *
       * @return bool
       */
      public function isInSection()
      {
          return $this->docPart == 'Section';
      }
  
      /**
       * Set new style value
       *
       * @param mixed $styleObject Style object
       * @param mixed $styleValue Style value
       * @param bool $returnObject Always return object
       * @return mixed
       */
      protected function setNewStyle($styleObject, $styleValue = null, $returnObject = false)
      {
          if (!is_null($styleValue) && is_array($styleValue)) {
              $styleObject->setStyleByArray($styleValue);
              $style = $styleObject;
          } else {
              $style = $returnObject ? $styleObject : $styleValue;
          }
  
          return $style;
      }
  
      /**
       * Sets the trackChange information
       *
       * @param TrackChange $trackChange
       */
      public function setTrackChange(TrackChange $trackChange)
      {
          $this->trackChange = $trackChange;
      }
  
      /**
       * Gets the trackChange information
       *
       * @return TrackChange
       */
      public function getTrackChange()
      {
          return $this->trackChange;
      }
  
      /**
       * Set changed
       *
       * @param string $type INSERTED|DELETED
       * @param string $author
       * @param null|int|\DateTime $date allways in UTC
       */
      public function setChangeInfo($type, $author, $date = null)
      {
          $this->trackChange = new TrackChange($type, $author, $date);
      }
  
      /**
       * Set enum value
       *
       * @param string|null $value
       * @param string[] $enum
       * @param string|null $default
       *
       * @throws \InvalidArgumentException
       * @return string|null
       *
       * @todo Merge with the same method in AbstractStyle
       */
      protected function setEnumVal($value = null, $enum = array(), $default = null)
      {
          if ($value !== null && trim($value) != '' && !empty($enum) && !in_array($value, $enum)) {
              throw new \InvalidArgumentException("Invalid style value: {$value}");
          } elseif ($value === null || trim($value) == '') {
              $value = $default;
          }
  
          return $value;
      }
  }