forked from setola/Wordpress-Theme-Utils-Classes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
LipsumGenerator.class.php
696 lines (599 loc) · 16.2 KB
/
LipsumGenerator.class.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
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
<?php
/**
* Contains the LipsumGenerator
*/
/**
* Generates Lorem Ipsum text
* @author etessore
* @version 1.0.0
* @package classes
*/
class LipsumGenerator {
/**
* @const int use html tag <p> to separate paragraphs
*/
const FORMAT_HTML = 0;
/**
* @const int use 2 newlines to separate paragraphs
* and a tab before the first word of every paragraph
*/
const FORMAT_TEXT = 1;
/**
* @const int generates plain text with a
* newline as separation between paragraphs
*/
const FORMAT_PLAIN = 2;
/**
* @const int generates html with <strong> <em> <a> and <p> tags
*/
const FORMAT_RICH_HTML = 3;
/**
* @const string the WP option name where
* the generator can store his config
*/
const OPTION_NAME = 'lipsum_generator_config';
/**
* @const string the WP options name where
* the generator can store the rendered text
*/
//const OPTION_NAME_RENDER = 'lipsum_generator_render';
/**
* @var string the format type
*/
private $format;
/**
* @var int number of paragraphs
*/
private $number_of_paragraphs;
/**
* @var int words in a paragraph
*/
private $words_per_paragraph;
/**
* @var int minimum amount of words until a single word can be repeated
*/
private $words_per_sentence;
/**
* @var array all generated texts will start with thouse words (ex. 'Lorem Ipsum')
*/
private $beginning;
/**
* @var GeneratorDictionary a dictionary for the current generator
*/
private $dictionary;
/**
* @var int the minimum amount of words until a single word can be repeated
*/
private $min_repeat_count;
/**
* @var array config for rich html generator
*/
private $rich_html_config;
/**
* @var mixed a seed for random generator
*/
private $seed;
/**
* @var string the rendered text
*/
private $render;
/**
* @var GaussianMath some math utils
*/
private $gaussian_math;
//public $count;
/**
* Look for a config stored in the db
* If it doesn't exist it will load the default one
* @return LipsumGenerator $this for chainability
*/
public function init(){
if(!$this->load()){
$this->defaults();
$this->seed = rand(0, 1000000);
}
return $this;
}
/**
* Initializes the current object with default settings
* @return LipsumGenerator $this for chainability
*/
public function defaults(){
return $this
->set_format(self::FORMAT_RICH_HTML)
->set_number_of_paragraphs(5)
->set_words_per_paragraph(100)
->set_words_per_sentence(24.460)
->set_dictionary(new LoremIpsumDictionary)
->set_begins_with(array('lorem', 'ipsum'))
->set_min_repeat_count(5)
->set_math(new GaussianMath);
}
/**
* Set the format for the current object
* use only self::FORMAT_* constants
* @see self::FORMAT_RICH_HTML
* @see self::FORMAT_HTML
* @see self::FORMAT_TEXT
* @see self::FORMAT_PLAIN
* @param int $format the format
* @return LipsumGenerator $this for chainability
*/
public function set_format($format){
$format = intval($format);
switch($format){
case self::FORMAT_HTML:
case self::FORMAT_PLAIN:
case self::FORMAT_RICH_HTML:
case self::FORMAT_TEXT:
$this->format = $format;
break;
default:
throw new InvalidArgumentException(sprintf("Unsupported format '%s'", $format));
break;
}
return $this;
}
/**
* Sets the number of paragraphs for the current object
* @param int $number_of_paragraphs the number
* @return LipsumGenerator $this for chainability
*/
public function set_number_of_paragraphs($number_of_paragraphs){
$this->number_of_paragraphs = $number_of_paragraphs;
return $this;
}
/**
* Sets how many words a paragraph is made by.
* @param int $words_per_paragraph the number of words
*/
public function set_words_per_paragraph($words_per_paragraph){
$this->words_per_paragraph = intval($words_per_paragraph);
return $this;
}
/**
* Sets how many words a sentence is made by
* @param int $words_per_sentence number of words
* @return LipsumGenerator $this for chainability
*/
public function set_words_per_sentence($words_per_sentence){
$this->words_per_sentence = intval($words_per_sentence);
return $this;
}
/**
* Sets the first n words of the generated text.
* Usually they are 'Lorem ipsum'.
* @param array $beginning list of first n words
* @return LipsumGenerator $this for chainability
*/
public function set_begins_with($beginning){
$this->beginning = (array) $beginning;
return $this;
}
/**
* Sets the dictionary for the current generator
* @param GeneratorDictionary $dictionary the dictionary
* @return LipsumGenerator $this for chainability
*/
public function set_dictionary(GeneratorDictionary $dictionary){
$this->dictionary = $dictionary;
return $this;
}
/**
* Sets the mathematical object used for count words and punctuage distribution
* @param GaussianMath $math
*/
public function set_math(GaussianMath $math){
$this->gaussian_math = $math;
return $this;
}
/**
* Sets the minimum amount of words until a single word can be repeated
* @param $min_repeat_count the number of words withour repetitions
* @return LipsumGenerator $this for chainability
*/
public function set_min_repeat_count($min_repeat_count){
$this->min_repeat_count = intval($min_repeat_count);
return $this;
}
/**
* Retrieves an array of random words
* @return array a list of random words
* @param $count int the number of words to ber retrieved
*/
private function get_words($count){
$toret = array();
$words = $this->dictionary->get_all_words();
while(count($toret)<$count){
//$word = $words[array_rand($words)];
$word = $words[rand(0, $this->dictionary->number_of_words()-1)];
// do not repeat the same word in a 5 words group
if(!in_array($word, array_slice($toret, $this->min_repeat_count*-1))){
$toret[] = $word;
}
}
return $toret;
}
/**
* Returns a number on a gaussian distribution based
* on the average word length of an english sentence.
* Statistics Source:
* http://hearle.nahoo.net/Academic/Maths/Sentence.html
* Average: 24.46
* Standard Deviation: 5.08
*/
private function gaussian_sentence(){
$avg = (float) 24.460;
$std_dev = (float) 5.080;
return (int) round($this->gaussian_math->gauss_ms($avg, $std_dev));
}
/**
* Builds a single paragraph
*/
private function get_paragraph(){
$count = $this->words_per_paragraph;
$words = $this->get_words($count);
$delta = $count;
$curr = 0;
$sentences = array();
while ($delta > 0) {
$senSize = $this->gaussian_sentence();
if (($delta - $senSize) < 4) {
$senSize = $delta;
}
$delta -= $senSize;
$sentence = array();
for ($i = $curr; $i < ($curr + $senSize); $i++) {
$sentence[] = $words[$i];
}
$sentence[0] = ucfirst($sentence[0]);
$this->punctuate($sentence);
$curr = $curr + $senSize;
$sentences[] = $sentence;
}
return $sentences;
}
/**
* Renders the current object according to the current format
* @return LipsumGenerator $this for chainability
*/
public function render(){
srand($this->seed);
if(empty($this->render)){
switch($this->format){
case self::FORMAT_HTML:
$this->render_html();
break;
case self::FORMAT_PLAIN:
$this->render_plain();
break;
case self::FORMAT_RICH_HTML:
$this->render_rich_html();
break;
case self::FORMAT_TEXT:
$this->render_text();
break;
default:
throw new InvalidArgumentException(sprintf("Unsupported format '%s'", $format));
}
}
return $this;
}
/**
* Magic method called when the current object is casted to string
*/
public function __toString(){
return $this->render()->render;
}
/**
* Generates and renders in plain forma
* @see LipsumGenerator::FORMAT_PLAIN
* @return LipsumGenerator $this for chainability
*/
private function render_plain(){
$this->render = '';
$is_first_p = true;
for($i=0; $i<$this->number_of_paragraphs; $i++){
$paragraph = $this->get_paragraph();
$rendered_p = '';
if($is_first_p){
$this->force_beginning(&$paragraph);
} else {
$rendered_p .= "\n";
}
foreach($paragraph as $sentence){
$rendered_p .= implode(' ', $sentence).' ';
}
$this->render .= $rendered_p;
$is_first_p = false;
}
return $this;
}
/**
* Generates and render in text format
* @see LipsumGenerator::FORMAT_TEXT
* @return LipsumGenerator $this for chainability
*/
private function render_text(){
$this->render = '';
$is_first_p = true;
for($i=0; $i<$this->number_of_paragraphs; $i++){
$paragraph = $this->get_paragraph();
$rendered_p = '';
if($is_first_p){
$this->force_beginning(&$paragraph);
} else {
$rendered_p .= "\n\n\t";
}
foreach($paragraph as $sentence){
$rendered_p .= implode(' ', $sentence).' ';
}
$this->render .= $rendered_p;
$is_first_p = false;
}
return $this;
}
/**
* Generates and renders in html format
* @see LipsumGenerator::FORMAT_HTML
* @return LipsumGenerator $this for chainability
*/
private function render_html(){
$this->render = '';
$is_first_p = true;
for($i=0; $i<$this->number_of_paragraphs; $i++){
$paragraph = $this->get_paragraph();
$rendered_p = '';
if($is_first_p){
$this->force_beginning(&$paragraph);
} else {
$rendered_p .= "\n";
}
$rendered_p .= HtmlHelper::open_tag('p'); //'<p>';
foreach($paragraph as $sentence){
$rendered_p .= implode(' ', $sentence);
}
$rendered_p .= HtmlHelper::close_tag('p'); //"</p>";
$this->render .= $rendered_p;
$is_first_p = false;
}
return $this;
}
/**
* Sets the configuration for the rich html generation
* @param array $config an array of parameters:
* <code>
* $default = array(
'strong' => array(
'percent' => 2,
'max_words' => 5,
'params' => ''
),
'a' => array(
'percent' => 5,
'max_words' => 5,
'params' => 'href="#"'
),
'em' => array(
'percent' => 10,
'max_words' => 5,
'params' => ''
)
);
<code>
*/
public function set_rich_html_config($config=array()){
$default = array(
'strong' => array(
'percent' => 10,
'max_words' => 5,
'params' => ''
),
'a' => array(
'percent' => 5,
'max_words' => 5,
'params' => 'href="#"'
),
'em' => array(
'percent' => 2,
'max_words' => 5,
'params' => ''
)
);
$this->rich_html_config = array_merge($default, (array)$config);
return $this;
}
/**
* Generates and renders in rich html format
* @see LipsumGenerator::FORMAT_RICH_HTML
* @return LipsumGenerator $this for chainability
*/
private function render_rich_html(){
$this->render = '';
$is_first_p = true;
$this->stats = array();
// useful to avoid the same tag to be repeated without plain text between
$last_closed_tag = false;
if(empty($this->rich_html_config)) $this->set_rich_html_config();
for($i=0; $i<$this->number_of_paragraphs; $i++){
$paragraph = $this->get_paragraph();
$rendered_p = '';
if($is_first_p){
$this->force_beginning(&$paragraph);
} else {
$rendered_p .= "\n";
}
$rendered_p .= HtmlHelper::open_tag('p'); //'<p>';
foreach($paragraph as $sentence){
// stores the currently opened html tag
$current_tag = '';
// stores how many words are left before the current tag have to be closed
$words_until_close_tag = 0;
foreach($sentence as $index => $word){
if($words_until_close_tag < 0){
$words_until_close_tag = 0;
}
if(empty($current_tag) && empty($last_closed_tag)){
$tag_to_add = '';
foreach($this->rich_html_config as $tag => $tag_config){
$rnd = rand(0, 99);
if($rnd < $tag_config['percent']){
//v(array($rnd, $tag, $index));
if(
isset($this->rich_html_config[$tag_to_add]['percent'])
&& $this->rich_html_config[$tag_to_add]['percent'] < $tag_config['percent']
){
$tag_to_add = $tag;
$this->stats[$tag]++;
}
}
}
}
if(!empty($tag_to_add)){
// insert the current tag!
$current_tag = $tag_to_add;
//$rendered_p .= $this->open_tag($tag_to_add);
$rendered_p .= HtmlHelper::open_tag($tag_to_add, $this->rich_html_config[$tag_to_add]['params']);
$words_until_close_tag = rand(1, $this->rich_html_config[$tag_to_add]['max_words']);
$tag_to_add = '';
}
$rendered_p .= $word;
$last_closed_tag = '';
if(!empty($current_tag)){
if($words_until_close_tag == 0){
$rendered_p .= HtmlHelper::close_tag($current_tag);
$last_closed_tag = $current_tag;
$current_tag = '';
} else {
$words_until_close_tag--;
}
}
$rendered_p .= ' ';
}
// close the last tag if it's still open at the paragraph end
$rendered_p .= HtmlHelper::close_tag($current_tag);
}
$rendered_p .= HtmlHelper::close_tag('p'); //"</p>";
$this->render .= $rendered_p;
$is_first_p = false;
}
return $this;
}
/**
* Forces the given sentences (paragraph)
* to start with $this->beginning list of words.
* @param array $sentences the list of sentences
*/
private function force_beginning(&$sentences){
if(count($this->beginning)){
foreach($this->beginning as $k => $v){
$sentences[0][$k] = $v;
}
$sentences[0][0] = ucfirst($sentences[0][0]);
}
}
/**
* Inserts commas and periods in the given array of words.
* @param array $sentence the list of sentence
*/
private function punctuate(& $sentence){
$count = count($sentence);
$sentence[$count - 1] .= '.';
if ($count < 4) {
return $sentence;
}
$commas = $this->numberOfCommas($count);
for ($i = 1; $i <= $commas; $i++) {
$index = (int) round($i * $count / ($commas + 1));
if ($index < ($count - 1) && $index > 0) {
$sentence[$index] .= ',';
}
}
}
/**
* Determines the number of commas for a
* sentence of the given length. Average and
* standard deviation are determined superficially
* @param $len int a medium amount of words between two commas
*/
private function numberOfCommas($len){
$avg = (float) log($len, 6);
$stdDev = (float) $avg / 6.000;
return (int) round($this->gaussian_math->gauss_ms($avg, $stdDev));
}
/**
* Retrieves the config set for this generator
* @return array the list of settings
*/
private function get_config(){
$fields = array_keys(get_class_vars(__CLASS__));
$config = array();
foreach($fields as $field){
$config[$field] = $this->{$field};
}
// avoid waste of memory in the db
unset($config['render']);
return $config;
}
/**
* Bulk configure the generator.
* @param array $config the list of settings pairs name=>value
* @return LipsumGenerator $this for chainability
*/
private function set_config($config){
$fields = array_keys(get_class_vars(__CLASS__));
foreach($fields as $field){
if(isset($config[$field]))
$this->{$field} = $config[$field];
}
return $this;
/* ->set_math(new GaussianMath())
->set_dictionary(new LoremIpsumDictionary());*/
}
/**
* Store config into WP options system
* @return LipsumGenerator $this for chainability
*/
public function save(){
add_option(self::OPTION_NAME, $this->get_config(), null, false);
return $this;
}
/**
* Retrives config from WP options system
* @return boolean false if config is not present
*/
public function load(){
$config = get_option(self::OPTION_NAME, false);
if(!$config) return false;
$this->set_config($config);
return true;
}
/**
* Removes current config from WP options system
* @return LipsumGenerator $this for chainability
*/
public function flush(){
delete_option(self::OPTION_NAME);
return $this;
}
/**
* Hooks to 'the_content' hook.
* If the page has no content it will fill it with the generated text.
* @return LipsumGenerator $this for chainability
*/
public function hook(){
$this->init();
add_filter('the_content', array($this, 'the_content'), 10, 1);
return $this;
}
/**
* Hook for the_content:
* if there is no content it appends the generated
* @param $content string the content
*/
public function the_content($content){
return (empty($content))
? $this->init()->__toString()
: $content;
}
}