---
layout: default
---
<section class="section">
  <p class="content">
    Yet Another PHP Enum (yape) is a type-safe, object-backed enum implementation in userland PHP. The functionality of
    yape is split into three different packages:
  </p>
  <div class="columns">
    <div class="column">
      <div class="card">
        <div class="card-header">
          <div class="card-header-title">
            cspray/yape
          </div>
        </div>
        <div class="card-content">
          <p class="content">
            The core package that provides the <code>Enum</code> interface and <code>EnumTrait</code> that provides the
            functionality powering your enum.
          </p>
        </div>
        <div class="card-footer">
          <a href="https://github.com/cspray/yape" class="card-footer-item">
            <span class="icon">
              <i class="fab fa-github"></i>
            </span>
            GitHub
          </a>
        </div>
      </div>
    </div>
    <div class="column">
      <div class="card">
        <div class="card-header">
          <div class="card-header-title">
            cspray/yape-cli
          </div>
        </div>
        <div class="card-content">
          <p class="content">
            A Symfony Console tool that allows you to easily generate yape <code>Enum</code> and Doctrine Types using a
            simple command-line interface.
          </p>
        </div>
        <div class="card-footer">
          <a href="https://github.com/cspray/yape-cli" class="card-footer-item">
            <span class="icon">
              <i class="fab fa-github"></i>
            </span>
            GitHub
          </a>
        </div>
      </div>
    </div>
    <div class="column">
      <div class="card">
        <div class="card-header">
          <div class="card-header-title">
            cspray/yape-dbal
          </div>
        </div>
        <div class="card-content">
          <p class="content">
            An extension of yape that allows you to create Doctrine Types that persist your `Enum` instances using Doctrine.
          </p>
        </div>
        <div class="card-footer">
          <a href="https://github.com/cspray/yape-dbal" class="card-footer-item">
            <span class="icon">
              <i class="fab fa-github"></i>
            </span>
            GitHub
          </a>
        </div>
      </div>
    </div>
  </div>

  <h2 id="installation" class="subtitle is-size-3">Installation</h2>
  <p class="content">
    We recommend using <a href="https://getcomposer.org">Composer</a> to install this library. We also <strong>highly recommend</strong>
    installing the CLI tool as a development requirement. If you need Doctrine support you should require yape-dbal.
  </p>
  <pre class="is-paddingless"><code class="language-shell">composer require cspray/yape
composer require --dev cspray/yape-cli
composer require cspray/yape-dbal  # if needed for Doctrine support</code></pre>
  <div class="message is-info cli-message">
    <p class="message-body">
      The rest of this guide will assume you have the yape-cli tool installed.
    </p>
  </div>

  <h2 class="subtitle is-size-3">Getting Started</h2>

  <div class="columns is-multiline">
    <div class="column">
      <div class="card docs-card">
        <div class="card-header">
          <div class="card-header-title">Tutorials</div>
        </div>
        <div class="card-content">
          Teaches you how to get started using the library without getting too far into details. Designed to get you up and
          running with the code generated by YAPE.
        </div>
        <div class="card-footer">
          <a class="card-footer-item" href="{{site.baseurl}}/tutorials">
            Learn More
          </a>
        </div>
      </div>
    </div>

    <div class="column">
      <div class="card docs-card">
        <div class="card-header">
          <div class="card-header-title">How To</div>
        </div>
        <div class="card-content">
          As your code changes you'll want to make changes to generated Enums as well. Learn about the most common
          ways to modify your enum after code generation.
        </div>
        <div class="card-footer">
          <a class="card-footer-item" href="{{site.baseurl}}/how-tos">
            Learn More
          </a>
        </div>
      </div>
    </div>
  </div>

  <h2 class="subtitle is-size-3">The Enum is <em>your</em> code</h2>
  <p class="content">
    Although yape aims to reduce the amount of boilerplate and code generation you need to deal with to start
    using type-safe enums it is important to remember... <em>the Enum is <strong>YOUR</strong> code.</em> You should look
    at the code after it is generated and you should modify the code as your needs may change over time.
  </p>
</section>