phpab.github.io/docs/getting-started.html at master · phpab/phpab.github.io

History

262 lines (241 loc) · 13.6 KB

Raw

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

<!DOCTYPE html>

<!--[if lt IE 7]>

<!--[if IE 7]>

<!--[if IE 8]>

<head>

<title>Getting started - The A/B testing framework for PHP.</title>

content="PhpAb is a A/B testing framework which can be used to perform multivariate testing.">

integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" crossorigin="anonymous">

integrity="sha256-a23g1Nt4dtEYOj7bR+vTu7+T8VP13humZFBJNIYoEJo=" crossorigin="anonymous"></script>

integrity="sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS"

crossorigin="anonymous"></script>

$(function () {

hljs.initHighlightingOnLoad();

});

</script>

(function (i, s, o, g, r, a, m) {

i['GoogleAnalyticsObject'] = r;

i[r] = i[r] || function () {

(i[r].q = i[r].q || []).push(arguments)

}, i[r].l = 1 * new Date();

a = s.createElement(o),

m = s.getElementsByTagName(o)[0];

a.async = 1;

a.src = g;

m.parentNode.insertBefore(a, m)

})(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga');

ga('create', 'UA-76115045-1', 'auto');

ga('send', 'pageview');

</script>

</head>

<body>

<button type="button" class="navbar-toggle collapsed" data-toggle="collapse"

data-target="#bs-example-navbar-collapse-1" aria-expanded="false">

<span class="sr-only">Toggle navigation</span>

</button>

<a class="navbar-brand" href="https://phpab.github.io/"><strong>PhpAb</strong></a>

</div>

<li><a href="https://phpab.github.io/docs/index.html">Documentation</a></li>

</ul>

</div>

</nav>

<strong>Introduction</strong>

<ul>

Getting started

</a>

</li>

Library layout

</a>

</li>

</ul>

<strong>Components</strong>

<ul>

Analytics

</a>

</li>

Events

</a>

</li>

Participation

</a>

</li>

Storage

</a>

</li>

Variants

</a>

</li>

</ul>

<strong>Frameworks Integrations</strong>

<ul>

Symfony 2

</a>

</li>

Wordpress

</a>

</li>

Zend Framework 2

</a>

</li>

</ul>

</div>

<a href="https://github.com/phpab/phpab.github.io/blob/source/source/docs/getting-started.md"

class="btn btn-default btn-sm">

Edit this page on GitHub

</a>

</div>

<h1 id="getting-started-with-phpab">Getting started with PhpAb</h1>

<p>Hello world! This guide will help you get started with using php in your project.</p>

<p>Before you start using phpab/phpab, you need to know what A/B testing is. If you are new to

A/B testing we recommend you read the documentation index where we explain the basics of A/B testing

especially for you: <a href="index.html">Understanding A/B testing</a>.</p>

<h2 id="installation">Installation</h2>

<p>The recommended way of installing phpab/phpab is via <a href="http://getcomposer.org/doc/00-intro.html">Composer</a>.</p>

<pre><code>composer require phpab/phpab</code></pre>

<h2 id="basic-usage">Basic usage</h2>

<h3 id="1-participation-and-storage">1. Participation and Storage</h3>

<p>It's common to only run tests for a selected group of people. This can be done using a participation

manager. When tests are activated, we need to store the choice that has been made for the user. This

is done using a storage type. In this case we use cookies.</p>

<pre><code class="language-php">$storage = new \PhpAb\Storage\Cookie('phpab');

$participationManager = new \PhpAb\Participation\Manager($storage);</code></pre>

<p>We have implemented several storage types, you can read more about them <a href="storage.html">here</a>.</p>

<h3 id="2-analytics-collecting">2. Analytics Collecting</h3>

<p>It makes no sense to run tests without analyzing the results. A common way is to use Google Analytics to

meassure what tests are used. Phpab makes used of data collectors to collect the started tests.</p>

<pre><code class="language-php">$analyticsData = new \PhpAb\Analytics\Google\DataCollector();</code></pre>

<h3 id="3-events">3. Events</h3>

<p>An event dispatcher must be created which is used later on. This event dispatcher can be used to hook

into the API and listen to tests. The analytics data collector should be attached to the event dispatcher

so that it registers statistics about the tests.</p>

<pre><code class="language-php">$dispatcher = new \PhpAb\Event\Dispatcher();

$dispatcher->addSubscriber($analyticsData);</code></pre>

<h3 id="4-engine">4. Engine</h3>

<p>The engine is used to run tests. You can pass along a default variant chooser and participation filter

here as well. More about that later on.</p>

<pre><code class="language-php">$filter = new \PhpAb\Participation\PercentageFilter(50);

$chooser = new \PhpAb\Variant\RandomChooser();

$engine = new PhpAb\Engine\Engine($participationManager, $dispatcher, $filter, $chooser);</code></pre>

<h3 id="5-adding-tests">5. Adding Tests</h3>

<p>Adding a test is simple,</p>

<pre><code class="language-php">$test = new \PhpAb\Test\Test('foo_test');

$test->addVariant(new \PhpAb\Variant\SimpleVariant('_control'));

$test->addVariant(new \PhpAb\Variant\CallbackVariant('v1', function () {

echo 'v1';

}));

$test->addVariant(new \PhpAb\Variant\CallbackVariant('v2', function () {

echo 'v2';

}));

$test->addVariant(new \PhpAb\Variant\CallbackVariant('v3', function () {

echo 'v3';

}));

$engine->addTest($test);</code></pre>

<h3 id="6-start-your-engines">6. Start your engines</h3>

<p>The last step is to start the engine and render the Google Analytics script.</p>

<pre><code class="language-php">$engine->start();</code></pre>

<pre><code class="language-php">$analytics = new \PhpAb\Analytics\Renderer\GoogleUniversalAnalytics($analyticsData->getTestsData());

echo $analytics->getScript();</code></pre>

</article>

</div>

<p>

For questions, bugs or if you want to let us know how much you appreciate this library,

please <a href="https://github.com/phpab/phpab/issues/new">create an issue</a>

or chat with us on <a href="https://gitter.im/phpab">Gitter</a>.

</p>

<p>

</p>

<p>

Created by

<a href="http://waltertamboer.nl/">Walter Tamboer</a>,

<a href="https://github.com/pachico">Mariano Benítez Mulet</a>,

<a href="https://github.com/psren">Patrick Heller</a>

and all <a href="https://github.com/phpab/phpab/graphs/contributors">contributors</a>

</p>

<p>

Website generated with <a href="http://couscous.io">Couscous</a> | Design is heavily inspired by

</p>

</div>

</footer>

((window.gitter = {}).chat = {}).options = {

room: 'phpab'

};

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

getting-started.html

Latest commit

History

getting-started.html

File metadata and controls