atans/atans-common

AtansCommon for Zend Framework 2

0.1.4 2013-12-19 03:32 UTC

Requires

• php: >=5.3.3
• zendframework/zend-http: >=2.1
• zendframework/zend-json: >=2.1
• zendframework/zend-mvc: >=2.1
• zendframework/zend-view: >=2.1

MIT

• Atans Chiu

• zf2
• module

README

Master:

The Atans library

• 0.1.1 (2013-8-4)
• 0.1.2 (2013-11-12)
• 0.1.3 Add two controller plugins (2013-12-16)
• 0.1.4 Update bootstrap alert (2013-12-19)

Contoller plugin

Ajax plugin

    public function textAction()
    {
        // Text
        return $this->ajax()->html('<strong>html</strong>');
        // Content-Type: text/html
        // Output: <strong>html</strong>
    }

    public function textAction()
    {
        // Text
        return $this->ajax()->text('text');
        // Content-Type: text/plain
        // Output: text
    }

    public fucntion statusTestAction()
    {
        return $this->ajax()->status('ok', 'Ok message');
        // Content-Type: application/json
        // Output : {"status" : "ok", "message" : "Ok message"}

        return $this->ajax()->status('ok', 'Ok message', array('data' => 'Returns data'));
        // Output : {"status" : "ok", "message" : "Ok message", "data" => "Retruns data"}

        return $this->ajax()->status('ok', array('data' => 'Returns data'));
        // Output : {"status" : "ok", "data" => "Retruns data"}
    }

    public fucntion successTestAction()
    {
        return $this->ajax()->success(true, 'Ok message', array('data' => 'Returns data'));
        // Content-Type: application/json
        // output : {"success" : true, "message" : "Ok message", "data" => "Retruns data"}

        return $this->ajax()->success(false, 'False message');
        // Output : {"success" : false, "message" : "False message"}

        return $this->ajax()->success(true, array('data' => 'Returns data'));
        // Output : {"success" : true, "data" => "Retruns data"}
    }

ObjectManager plugin

    public function indexAction()
    {
        $id = (int) $this->params()->formRoute('id', 0);

        // Default object manager is doctrine.entitymanager.orm_default
        $entity = $this->objectManager()->find('Application/Entity/EntityName', $id);
        // or
        $entity = $this->objectManager('doctrine.entitymanager.orm_other')->find('Application/Entity/EntityName', $id);
    }

Translate plugin

    public function indexAction()
    {
        $message = $this->translate('This is a message');

        // Same as
        $translator = $this->getServiceLocator()->get('Translate');
        $message    = $translator->translate('This is a message');
    }

String library

    echo \AtansCommon\Text\String::cut('This is a longer text', 6);
    // output : This i...

View widgets

Flash messenger Alert

Controller:

    public function indexAction()
    {
        $this->flashMessenger()
             ->setNamespace('application-index')
             ->addSuccessMessage('Message text');

        ...

        return array();
    }

View:

    //application/index/index.phtml
    <?php echo $this->render('alert/bootstrap', array('namespace' => 'application-index')) ?>
    ...

Html output:

    <div class="alert alert-success">
      <button type="button" class="close" data-dismiss="alert" aria-hidden="true">&times;</button>
      message text
    </div>
    ...

Boostrap navbar

    // application/layout/layout.phtml
    <nav class="navbar navbar-inverse navbar-fixed-top" role="navigation">
        <div class="container">
            <div class="navbar-header">
            ...
            <div class="collapse navbar-collapse">
                <?php echo $this->navigation('navigation')->menu()->setPartial(array('navigation/bootstrap', 'default'))->render() ?>
            </div>
        </div>
    </nav>

Bootstrap pagination

php

    // user/user/index.phtml
    <?php
        echo $this->paginationControl(
            $this->paginator,
            'Sliding',
            'pagination/query',
            array(
                'route' => 'user',
                'options' => array(
                    'query' => array(
                        'keyword' => $keyword,
                    ),
                ),
            )
        );
    ?>

html output:

<ul class="pagination">
  <li class="disabled"><a href="#">&laquo;</a></li>
  <li><a href="/user?page=1&keyword=test">1</a></li>
  <li><a href="/user?page=2&keyword=test">2</a></li>
  <li><a href="/user?page=3&keyword=test">3</a></li>
  <li><a href="/user?page=2&keyword=test">&raquo;</a></li>
</ul>