Skip to content
This repository was archived by the owner on Jan 29, 2020. It is now read-only.

Commit 1cfe492

Browse files
committed
Prepared documentation for publication
- Fixed several examples - Updated README to point to published docs - Changed order of docs (pushed examples to top-level, after tutorial) - Changed component tag-line
1 parent 73c7ac9 commit 1cfe492

File tree

8 files changed

+15
-14
lines changed

8 files changed

+15
-14
lines changed

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
.*.sw*
77
.*.un~
88
nbproject
9-
tmp/
109
doc/html/
10+
tmp/
11+
vendor/
1112
zf-mkdoc-theme/
1213

1314
clover.xml
1415
composer.lock
1516
coveralls-upload.json
1617
phpunit.xml
17-
vendor/

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ env:
1919
- GH_USER_NAME: "Matthew Weier O'Phinney"
2020
- GH_USER_EMAIL: [email protected]
2121
- GH_REF: github.com/zendframework/zend-eventmanager.git
22-
- secure: ""
22+
- secure: "q6mC+KhLKsPYD22R9RI7lLhQGF5dSQ0QttmaFSQf/wtIntruVIFoyWt8ObR3zFsZ4xxra8MZFV2AjbMM9vqB28aHZ1jV5kbCbhTfSbdv0GT4nwqIHh84Ui7gCykJBqyyboWf/ekOv87cbuTg3EbqJcgdBh6/oyRGIVVB3HQayJJTTUCz+TQ/M4mpvOE+61FGpu6WLv465R8aKRi0ZLjk6qMtAY616cnGlPBOoNopyQM2+VTGyLOFgwnCUae3l4MSc8zsWgA4FLwttsYOzoVXit1ZXcqAt+XCAxUMntT3esIKVdeNejqQ7ZhMdMJpbdXTgfOD9kPt4fbNrcyg12Zkl0F3lHUNMb22PWNXb7tZ3+E4pR8B+6GtKXLRleEl9sPUKhxZ0CgwQErqOE8Osnw+BeNjueosNzJvrpxdHLX1a1+1v4VZIcikK+btW6YS+YLjZJgd80LI/4vQByUehgfFRuJnmjkMp+p9NN+PphdYHcQLfe2VU+qif114cR2WAyaiJ47zXMu2+vqp9sR20M2CfKZXrihiSO+CdbhSmep3sWaCuLWZtpsMx7u3rKl1o5doGLmkYAc+OaCEw5mZ/nVxzkH2ldNNcCeV2+ENKj4zlKoVXy1MB0KTT2U2rJ4pO5WhYLORbgBNNKeuD8r5nl65Dhn3gaIPXvlica/jIqay+/U="
2323

2424
matrix:
2525
fast_finish: true

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Build Status](https://secure.travis-ci.org/zendframework/zend-eventmanager.svg?branch=master)](https://secure.travis-ci.org/zendframework/zend-eventmanager)
44
[![Coverage Status](https://coveralls.io/repos/zendframework/zend-eventmanager/badge.svg?branch=master)](https://coveralls.io/r/zendframework/zend-eventmanager?branch=master)
55

6-
The `Zend\EventManager` is a component designed for the following use cases:
6+
zend-eventmanager is designed for the following use cases:
77

88
- Implementing simple subject/observer patterns.
99
- Implementing Aspect-Oriented designs.
@@ -14,10 +14,10 @@ both on a per-instance basis as well as via shared collections; trigger events;
1414
and interrupt execution of listeners.
1515

1616
- File issues at https://github.com/zendframework/zend-eventmanager/issues
17-
- Documentation is at http://zend-eventmanager.rtfd.org
17+
- Documentation is at https://zendframework.github.io/zend-eventmanager/
1818

1919
For migration from version 2 to version 3, please [read the migration
20-
documentation](http://zend-eventmanager.readthedocs.org/en/latest/migration/intro/).
20+
documentation](https://zendframework.github.io/zend-eventmanager/migration/intro/).
2121

2222
## Benchmarks
2323

doc/book/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ $events->triggerUntil(function ($result) {
114114
In the above example, the event loop will short-circuit after the second
115115
listener executes, resulting in the following output:
116116

117-
```
117+
```text
118118
Triggered first
119119
Triggered second
120120
```

doc/book/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ class CacheListener implements ListenerAggregateInterface
206206

207207
We can then attach the aggregate to an event manager instance.
208208

209-
```
209+
```php
210210
$value = new SomeValueObject();
211211
$cacheListener = new CacheListener($cache);
212212
$cacheListener->attach($value->getEventManager());

doc/book/index.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
33
<h1>zend-eventmanager</h1>
44

55
<p>
6-
Powerful event bus system for Zend Framework
6+
Implement events, signal slots, aspects, and observers!
77
</p>
88

99
<pre><code class="language-bash">$ composer require zendframework/zend-eventmanager</code></pre>
1010
</div>
11-
</div>
11+
</div>
12+

doc/book/tutorial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ $events->trigger('do', null, $params);
4444

4545
The above will result in the following:
4646

47-
```
47+
```text
4848
Handled event "do", with parameters {"foo":"bar","baz":"bat"}
4949
```
5050

@@ -176,7 +176,7 @@ $example->do('bar', 'bat');
176176

177177
and expect the following output:
178178

179-
```
179+
```text
180180
Handled event "do" on target "Example", with parameters {"foo":"bar","baz":"bat"}
181181
```
182182

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ pages:
55
- Intro: intro.md
66
- "Quick Start": quick-start.md
77
- Tutorial: tutorial.md
8+
- Examples: examples.md
89
- Reference:
910
- "Wildcard Listeners": wildcard-listeners.md
1011
- "Listener Aggregates": aggregates.md
@@ -13,14 +14,13 @@ pages:
1314
- LazyListener: lazy-listeners/lazy-listener.md
1415
- LazyEventListener: lazy-listeners/lazy-event-listener.md
1516
- LazyListenerAggregate: lazy-listeners/lazy-listener-aggregate.md
16-
- Examples: examples.md
1717
- "EventManager API": api.md
1818
- "Intercepting Filters": intercepting-filters.md
1919
- "Migration Guide":
2020
- Intro: migration/intro.md
2121
- "Removed Functionality": migration/removed.md
2222
- "Changed Functionality": migration/changed.md
2323
site_name: zend-eventmanager
24-
site_description: "zend-eventmanager: Powerful event bus system for Zend Framework"
24+
site_description: "zend-eventmanager: Implement events, signal slots, aspects, and observers!"
2525
repo_url: 'https://github.com/zendframework/zend-eventmanager'
2626
copyright: 'Copyright (c) 2016 <a href="http://www.zend.com/">Zend Technologies USA Inc.</a>'

0 commit comments

Comments
 (0)