Skip to content

Commit

Permalink
First README commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
Marc committed Nov 24, 2011
1 parent 5dcd9be commit 73790c1
Showing 1 changed file with 74 additions and 1 deletion.
75 changes: 74 additions & 1 deletion README
Original file line number Diff line number Diff line change
@@ -1 +1,74 @@
This Bundle is not tested yet.

<style type="text/css">
.wp_syntax{-moz-border-radius:8px;-webkit-border-radius:8px;-o-border-radius:8px;-ms-border-radius:8px;-khtml-border-radius:8px;border-radius:8px;background-color:#232125;border:1px solid #666666;color:#100;overflow:auto;overflow-x:auto;overflow-y:hidden;width:100%;margin:1em auto;padding:1em;}.wp_syntax table{border-collapse:collapse;}.wp_syntax div,.wp_syntax td{vertical-align:top;padding:2px 4px;}.wp_syntax .line_numbers{background-color:#DEF;color:gray;overflow:visible;text-align:right;}.wp_syntax .code{background-color:#232125 !important;}.wp_syntax pre{color:#ccc;font-family:Consolas, Lucida Console, Monaco, monospace;background-color:#232125;clear:none;float:none;font-size:15px;line-height:1.333;overflow:visible;white-space:nowrap;width:auto;margin:0;padding:0;}.de1{color:#ddd;}.de2{color:#bbb;}.kw1{color:#FF8400;background-color:#222;}.kw2{color:#FF8400;font-weight:400;background-color:#222;}.kw3{color:#fd6;background-color:#222;}.kw4{color:#F83;font-weight:400;}.co0{color:#6d6;font-style:italic;}.co2{color:#8d8;font-style:italic;}.co3{color:#9d9;font-style:italic;}.coMULTI{color:#bdb;font-style:italic;}.es0{color:#e3e;}.es_h{color:#909;}.sy0{color:#E0882F;}.sy1{color:#aff;background-color:#039;}.nu0{color:#e66;}.nu8{color:#cc6;}.nu12{color:#6cc;}.nu19{color:#c6c;}.me1{color:#FFF;font-weight:400;}.me2{color:#ccb;}.re0{color:#fff;font-weight:400;}.re1{color:#ccc;font-weight:700;}a{text-decoration:none;}.diff .kw1{color:#aaa;font-style:italic;}.diff .re0{color:#408;}.diff .re1{color:#f33;}.diff .re2{color:#00b000;}.diff .re3{color:#f96;}.diff .re4{color:#9f9;}.diff .re5{color:#01d;}.diff .re6{color:#96f;}.diff .re7{color:#f66;}.diff .re8{color:#5f5;}.diff .re9{color:#882;}.one-column #page{max-width:none;}.wp_syntax td{border-width:0;}.entry-content .wp_syntax table,.wp_syntax .comment-content table{border-bottom:none !important;margin:0;}.co1,.co4{color:#B729D9;font-style:italic;}.st0,.st_h{color:#56DB3A;}.br0,.re2,.re3,.re4,.re5,.re6,.re7,.re8,.re9{color:#fff;}.mm0{font-size:12px;margin-bottom:15px;display:block;}
pre{border:none;}
</style>

<h1>README</h1>
<h2>What is GearmanBundle?</h2>
<p>GearmanBundle is a bundle for symfony2 intended provide a easy way support developers who need use job queues.</p>
<p>It uses annotations to define Jobs and Workers' options.</p>

<h2>Requirements</h2>
<p>To work with GearmanBundle needed, PHP 5.3, Gearman and Symfony2</p>

<h2>Installation</h2>
<p>You have two options to install in its Framework Gearman2 by Vendor or by repository. The two options are based on the same basis but one requires a little configuration.</p>
<p>On the one hand we can set ourselves the repository as follows</p>
<div class="wp_syntax">
<div class="code">
<pre class="php">
<span class="br0">~/path/to/your/bundles<span class="kw2">[master]</span>: git clone git://github.com/mmoreramerino/GearmanBundle.git</span>
</pre>
</div>
</div>
<p>Moreover, you can include this repository in the list of vendors and reinstall again. You must edit your deps file in your project root</p>
<div class="wp_syntax">
<div class="code">
<pre class="php">
<span class="mm0">~/path/to/your/project/deps</span>
<span class="kw2">[AsseticBundle]</span><br />
&nbsp;&nbsp;&nbsp;&nbsp;<span class="br0">git=http://github.com/mmoreramerino/GearmanBundle.git</span><br />
&nbsp;&nbsp;&nbsp;&nbsp;<span class="br0">target=/bundles/Mmoreramerino/GearmanBundle</span>
</pre>
</div>
</div>
<p>When you have registered the bundle and you're in your project, you just need to instantiate your bundle and add a linia in the autoload.</p>
<div class="wp_syntax">
<div class="code">
<pre class="php">
<span class="mm0">~/path/to/your/project/app/AppKernel.php</span>
<span class="kw2">&lt;?php</span><br /><br />
<span class="re0">$bundles</span> <span class="sy0">=</span> <span class="kw3">array</span><span class="br0">(</span><br />
&nbsp;&nbsp;&nbsp;&nbsp;<span class="kw2">new</span> Symfony\Bundle\FrameworkBundle\FrameworkBundle()<span class="sy0">,</span><br />
&nbsp;&nbsp;&nbsp;&nbsp;<span class="kw2">new</span> Symfony\Bundle\TwigBundle\TwigBundle()<span class="sy0">,</span><br />
&nbsp;&nbsp;&nbsp;&nbsp;<span class="kw2">new</span> Symfony\Bundle\MonologBundle\MonologBundle()<span class="sy0">,</span><br />
&nbsp;&nbsp;&nbsp;&nbsp;<span class="kw2">new</span> Symfony\Bundle\SwiftmailerBundle\SwiftmailerBundle()<span class="sy0">,</span><br /><br />
&nbsp;&nbsp;&nbsp;&nbsp;...<br /><br />
&nbsp;&nbsp;&nbsp;&nbsp;<span class="kw2">new</span> Mmoreramerino\GearmanBundle\MmoreramerinoGearmanBundle()<span class="sy0">,</span><br />
<span class="br0">)</span><span class="sy0">;</span>
</pre>
</div>
</div>
<div class="wp_syntax">
<div class="code">
<pre class="php">
<span class="mm0">~/path/to/your/project/app/autoload.php</span>
<span class="kw2">&lt;?php</span><br /><br />
<span class="re0">$loader</span><span class="sy0">-></span><span class="re0">registerNamespaces</span><span class="br0">(</span><span class="kw3">array</span><span class="br0">(</span><br />
&nbsp;&nbsp;&nbsp;&nbsp;<span class="st_h">'Sensio'</span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="sy0">=&gt;</span> <span class="kw3">__DIR__</span> <span class="sy0">.</span> <span class="st_h">'/../vendor/bundles'</span><span class="sy0">,</span><br />
&nbsp;&nbsp;&nbsp;&nbsp;<span class="st_h">'JMS'</span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="sy0">=&gt;</span> <span class="kw3">__DIR__</span> <span class="sy0">.</span> <span class="st_h">'/../vendor/bundles'</span><span class="sy0">,</span><br />
&nbsp;&nbsp;&nbsp;&nbsp;<span class="st_h">'Doctrine\\Common'</span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="sy0">=&gt;</span> <span class="kw3">__DIR__</span> <span class="sy0">.</span> <span class="st_h">'/../vendor/doctrine-common/lib'</span><span class="sy0">,</span><br />
&nbsp;&nbsp;&nbsp;&nbsp;...<br /><br />
&nbsp;&nbsp;&nbsp;&nbsp;<span class="st_h">'Mmoreramerino'</span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="sy0">=&gt;</span> <span class="kw3">__DIR__</span> <span class="sy0">.</span> <span class="st_h">'/../vendor/bundles'</span><span class="sy0">,</span><br />
<span class="br0">))</span><span class="sy0">;</span>
</pre>
</div>
</div>


<h2>Documentation</h2>
<p>This code is still on development status. Documentation will be available soon.

<h2>Contributing</h2>
<p>GearmanBundle is an open source project. Contributions are welcome</p>

0 comments on commit 73790c1

Please sign in to comment.