phossa/phossa-shared

The shared package for other phossa packages

phossa-shared

, _(*1)

Introduction

Phossa-shared is the shared package required by other phossa packages., _(*2)

Installation

Install via the composer utility., _(*3)

composer require "phossa/phossa-shared=1.*"

or add the following lines to your composer.json, _(*4)

{
    "require": {
       "phossa/phossa-shared": "^1.0.9"
    }
}

Features

• Exception, _(*5)

  All phossa exceptions implement Phossa\Shared\Exception\ExceptionInterface. To extend phossa exceptions,, _(*6)

  <?php
  namespace Phossa\Cache\Exception;
  
  class BadMethodCallException extends
    \Phossa\Shared\Exception\BadMethodCallException
  {
  }
  
  

• Message, _(*7)

  MessageAbstract class is the base class for all Message classes in all phossa packages., _(*8)

  • Define package related Message class

  Message class is used to convert message code into human-readable messages, and MUST define its own property $messages., _(*9)

  <?php
  namespace Phossa\Cache\Message;
  
  use Phossa\Shared\Message\MessageAbstract;
  
  class Message extends MessageAbstract
  {
      // use current year_month_date_hour_minute
      const CACHE_MESSAGE     = 1512220901;
  
      // driver failed
      const CACHE_DRIVER_FAIL = 1512220902;
  
      protected static $messages = [
          self::CACHE_MESSAGE      => 'cache %s',
          self::CACHE_DRIVER_FAILT => 'cache driver %s failed',
      ];
  }
  

  • Message class usage

  Usually only Message::get() and Message::CONST_VALUE are used., _(*10)

  use Phossa\Cache\Message\Message;
  ...
  // throw exception
  throw new Exception\RuntimeException(
      Message::get(Message::CACHE_DRIVER_FAIL, get_class($driver)),
      Message::CACHE_DRIVER_FAIL
  );
  

  • Message loader

  Used for loading different code to message mapping such as language files., _(*11)

  namespace Phossa\Cache;
  
  use Phossa\Shared\Message\Loader\LanguageLoader;
  
  // set language to 'zh_CN'
  $langLoader = new LanguageLoader('zh_CN');
  
  // will load local `Message\Message.zh_CN.php` language file
  Message\Message::setLoader($langLoader);
  
  // print message in chinese
  echo Message\Message::get(
      Message::CACHE_MESSAGE, get_class($object)
  );
  

  • Message formatter

  Used for formatting messages for different devices such as HTML page., _(*12)

  namespace Phossa\Cache;
  
  use Phossa\Shared\Message\Formatter\HtmlFormatter;
  
  // format message as HTML
  $formatter = new HtmlFormatter();
  
  Message\Message::setFormatter($formatter);
  
  // print as HTML
  echo Message\Message::get(
      Message::CACHE_MESSAGE, get_class($object)
  );
  

• Pattern, _(*13)

  Commonly used patterns in Interface or Trait, _(*14)

  • StaticTrait

  Used to be included in a static class which can not extends StaticAbstract, _(*15)

  <?php
  namespace Phossa\MyPackage;
  
  class MyStaticClass extends SomeClass
  {
      use \Phossa\Shared\Pattern\StaticTrait;
      ...
  }
  

  • StaticAbstract

  Used to be extended by other classes., _(*16)

  <?php
  namespace Phossa\MyPackage;
  
  class MyStaticClass extends \Phossa\Shared\Pattern\StaticAbstract
  {
      ...
  }
  

  • SingletonInterface and SingletonTrait

  Used to be included in a singleton class., _(*17)

  <?php
  namespace Phossa\MyPackage;
  
  class MySingletonClass extends SomeClass
  {
      use \Phossa\Shared\Pattern\SingletonTrait;
      ...
  }
  

  Usage,, _(*18)

  $obj =  MySingletonClass::getInstance();
  

  This singleton implementation has a feature which allows singleton class to extended., _(*19)

  <?php
  namespace Phossa\MyPackage;
  
  class MyNewSingletonClass extends MySingletonClass
  {
      ...
  }
  

  • ShareableInterface and ShareableTrait

  Multiple instances are allowed for Shareable, but only one global copy. Such as global event manager and lots of local event managers., _(*20)

  <?php
  namespace Phossa\Event;
  
  use Phossa\Shared\Pattern\ShareableInterface;
  
  class EventManager implements ShareableInterface
  {
      use \Phossa\Shared\Pattern\ShareableTrait;
      ...
  }
  

  Usage,, _(*21)

  // global event manager instance
  $globalEM = EventManager::getShareable();
  
  // local event manager
  $localEM  = new EventManager();
  
  // this EM global ?
  if ($globalEM->isShareable()) {
      ...
  } else {
      ...
  }
  

• Taggable, _(*22)

  Added TaggableInterface and TaggableTrait., _(*23)

• Support PHP 5.4+, PHP 7.0+, HHVM, _(*24)

• PHP7 ready for return type declarations and argument type declarations., _(*25)

• PSR-1, PSR-2, PSR-4 compliant., _(*26)

• Decoupled packages can be used seperately without the framework., _(*27)

Dependencies

PHP >= 5.4.0, _(*28)

License

MIT License, _(*29)