• 1st argument : path to direcotry searched
• 2nd argument : string or array of namespace
• 3rd argument : In the case of true, The namespace specified by $namespace is used. In the case of false, The searched subdirectory name is added to $namespace array one by one.
• 4th argument : In the case of true, $namespace is imploded by "_" (underscore). In the case of false, $namespace is imploded by "\"
• 5th argument : In the case of true, a directory is searched recursively. In the case of false, sub directories are not searched.

Foo class is created to path/to/classes/Foo.php.

<?php
/**
 * @S2Component('name' => 'foo')
 */
class Foo {}

Bar class is created to /path/to/classes/Bar.php.

<?php
/**
 * @S2Component('name' => 'bar', 'namespace' => 'example')
 */
class Bar {}

An execution script be as follows.

<?php
require_once('S2Container/S2Container.php');
seasar\container\S2ApplicationContext::import('/path/to/classes');

// genareting global s2container
$globalContainer = seasar\container\S2ApplicationContext::create();
$foo = $globalContainer->getComponent('Foo');
$bar = $globalContainer->getComponent('example.Bar');

// genarating example namespaced s2container
$exampleContainer = seasar\container\S2ApplicationContext::create('example');
$foo = $exampleContainer->getComponent('Foo');          // exception is throwed because Foo component does not exists.
$bar = $exampleContainer->getComponent('Bar');

• The 1nd argument : class name | ReflectionClass | ComponentInfoDef instance
• return : ComponentInfoDef instance

• The 1nd argument : Interceptor component name, Closure, or Expression
• The 2st argument : The regular expression string which carries out a pattern match at a component name or a component class name.
• The 3rd argument : Pointcut is specified by a regular expression character string.
• return : AspectInfoDef instance.

Method annotation of a parent class. 

By the default, method annotation of a parent class is disabled. You can set up it by the following method.

S2ApplicationContext::setReadParentAnnotation($val = true)

• The 1st argument : boolean, if setting true, method annotation of a parent class is enabled.

@S2Component annotation. 

@S2Component annotation sets up component information.

• Notation of annotation : @S2Component
• Arguments
  • name : name of component
  • instance : Instance Type
  • autoBinding : Binding Type
  • available : uses as component or not (boolean default true)
  • namespace : namespace used in S2Container
• Annotation point : class
• Example

    /**
     * @S2Component('name' => 'hoge')
     */
    class Hoge{} 
    
    /**
     * @S2Component('name' => 'huga',
     *              'instance' => 'singleton',
     *              'autoBinding' => 'auto',
     *              'available' => true,
     *              'namespace' => 'example.service')
     */
    class Huga{} 
  

@S2Binding annotation. 

@S2Binding annotation performs a manual injection setup.

• Notation of annotation : @S2Binding
• Arguments : The component name or PHP Expression
• Annotation point : pulbic property, setter method
• Example

  class IndexAction {
      /**
       * @S2Binding('new HogeService')
       */
      public $service;
   
      /**
       * @S2Binding('Hello World')
       */
      public funcion setHello($val) {
          $this->hello = $val;
      }
  }
  

@S2Aspect annotation. 

@S2Aspect annotation sets up aspect information.

• Notation of annotation : @S2Aspect
• Arguments
  • interceptor : Interceptor component name, or PHP Expression
  • pointcut : a pointcut is specified by a regular expression character string.
• Annotation point : class, method
• Example

    /**
     * @S2Aspect('interceptor' => 'traceInterceptor',
     *           'pointcut'    => '/.+Action/')
     */
    class CdController {
        public function indexAction(){
            . . .
        }
    }
  
    class DvdController {
        /**
         * @S2Aspect('interceptor' => 'new seasar\aop\interceptor\TraceInterceptor()')
         */
        public funcion indexAction() {
            . . .
        }
    }
  

@S2Meta annotation. 

@S2Meta annotation sets up meta information.

• Notation of annotation : @S2Meta
• Arguments
  • name : The discernment name of meta-information
  • value : value or PHP Expression
• Annotation point : class
• Example

    /**
     * @S2Meta('nameA' => 'valueA',
     *         'nameB' => 'valueB')
     */
    class CdController {
        public function indexAction(){
            ・・・
        }
    }
  

get method (getComponent method). 

S2ApplicationContext::get($key, $namespaces = array())
S2ApplicationContext::getComponent($key, $namespaces = array())

• The 1st argument : name of component
• the 2nd argument : namespace of S2Container

The get method is Alias of getComponent method. The component specified by the 1st argument is taken out. If Singleton S2Container of namespace specified by the 2nd argument has not been created, S2Continer is generated using S2ApplicationContext::create method. The s2get function is also defined as shortcut to the S2ApplicationContext::get method.

getComponentDef method. 

S2ApplicationContext::getComponentDef($key, $namespaces = array())

• The 1st argument : name of component
• the 2nd argument : namespace of S2Container

The component definition specified by the 1st argument is taken out. If Singleton S2Container of namespace specified by the 2nd argument has not been created, S2Continer is generated using S2ApplicationContext::create method.

Foo class is created to /path/to/classes/Foo.php.

<?php
/**
 * @S2Component('name' => 'foo')
 */
class Foo {}

Bar class is created to /path/to/classes/Bar.php.

<?php
/**
 * @S2Component('name' => 'bar', 'namespace' => 'example')
 */
class Bar {}

An execution script becomes the next.

<?php
require_once('S2Container/S2Container.php');
use seasar\container\S2ApplicationContext as s2app;
s2app::import('/path/to/classes');

// using global Singleton S2Container
$globalFoo = s2app::get('Foo');
$globalBar = s2app::get('example.Bar');

// using example namespace Singleton S2Container
$exampleFoo = s2app::get('Foo', 'example');          // Since a component does not exist, an exception is thrown.
$exampleBar = s2app::get('Bar', 'example');

var_dump($globalBar === $exampleBar);                // be false