Maslosoft Addendum API

Name: Addendum
Brand: Maslosoft

Class Addendum

Maslosoft\Addendum\Addendum implements Psr\Log\LoggerAwareInterface

Namespace: Maslosoft\Addendum
Located at Addendum.php

Methods summary

`public`	# `__construct( string $instanceId = self::DefaultInstanceId )` Parameters `$instanceId`
`public static Maslosoft\Addendum\Addendum`	# `fly( string $instanceId = self::DefaultInstanceId )` Get flyweight addendum instance of `Addendum`. Only one instance will be created for each `$instanceId` Get flyweight addendum instance of `Addendum`. Only one instance will be created for each `$instanceId` Parameters `$instanceId` Returns `Maslosoft\Addendum\Addendum`
`public`	# `getInstanceId( )`
`public string`	# `getVersion( )` Get current addendum version. Get current addendum version. Returns string
`public Maslosoft\Addendum\Addendum`	# `init( )` Initialize addendum and store configuration. This should be called upon first intstance creation. Initialize addendum and store configuration. This should be called upon first intstance creation. Returns `Maslosoft\Addendum\Addendum`
`public boolean`	# `hasAnnotations( string\|object $class )` Check if class could have annotations. NOTE: This does not check check if class have annotations. It only checks if it implements `AnnotatedInterface` Check if class could have annotations. NOTE: This does not check check if class have annotations. It only checks if it implements `AnnotatedInterface` Parameters `$class` Returns boolean
`public Maslosoft\Addendum\Reflection\ReflectionAnnotatedMethod\|Maslosoft\Addendum\Reflection\ReflectionAnnotatedProperty\|Maslosoft\Addendum\Reflection\ReflectionAnnotatedClass`	# `annotate( string\|object $class )` Use $class name or object to annotate class Use $class name or object to annotate class Parameters `$class` Returns `Maslosoft\Addendum\Reflection\ReflectionAnnotatedMethod`\|`Maslosoft\Addendum\Reflection\ReflectionAnnotatedProperty`\|`Maslosoft\Addendum\Reflection\ReflectionAnnotatedClass`
`public Maslosoft\Addendum\Addendum`	# `setLogger( Psr\Log\LoggerInterface $logger )` Set logger Set logger Parameters `$logger` Returns `Maslosoft\Addendum\Addendum`
`public Psr\Log\LoggerInterface`	# `getLogger( )` Get logger Get logger Returns Psr\Log\LoggerInterface logger
`public`	# `addNamespace( string $ns )` Add annotations namespace. Every added namespace will be included in annotation name resolving for current instance. Add annotations namespace. Every added namespace will be included in annotation name resolving for current instance. Parameters `$ns` Renturn Addendum
`public Maslosoft\Addendum\Addendum`	# `addNamespaces( string[] $nss )` Add many annotation namespaces. This is same as `addNamespace`, in that difference that many namespaces at once can be added. Add many annotation namespaces. This is same as `addNamespace`, in that difference that many namespaces at once can be added. It accepts array of namespaces as param: $nss = [ 'Maslosoft\Addendum\Annotations', 'Maslosoft\Mangan\Annotations' ]; Parameters `$nss` Returns `Maslosoft\Addendum\Addendum`
`public static`	# `cacheClear( )` Clear entire annotations cache. Clear entire annotations cache.
`public static mixed[]`	# `getDocComment( Reflector $reflection )` TODO This should not be static TODO This should not be static Parameters `$reflection` Returns mixed[]
`public static`	# `setRawMode( boolean $enabled = true )` This method has no effect This method has no effect Deprecated Since 4.0.4 this has no effect Parameters `$enabled`
`public static string`	# `resolveClassName( string\|boolean $class )` Resolve annotation class name to prefixed annotation class name Resolve annotation class name to prefixed annotation class name Parameters `$class` Returns string

Constants summary

`string`	`DefaultInstanceId`	# `'addendum'`

Properties summary

`public string`	`$runtimePath` Runtime path Runtime path	# `'runtime'`
`public boolean`	`$checkMTime` Whether to check modification time of file to invalidate cache. Set this to true for development, and false for production. Whether to check modification time of file to invalidate cache. Set this to true for development, and false for production.	# `false`
`public string[]`	`$namespaces` Namespaces to check for annotations. By default global and addendum namespace is included. Namespaces to check for annotations. By default global and addendum namespace is included.	# `[ '\\', TargetAnnotation::Ns ]`
`public string[]`	`$i18nAnnotations` Translatable annotations TODO This should be moved to `maslosoft/addendum-i18n-extractor` Translatable annotations TODO This should be moved to `maslosoft/addendum-i18n-extractor`	# `[ 'Label', 'Description' ]`
`public Maslosoft\Addendum\Collections\AddendumPlugins\|mixed[]`	`$plugins` Plugins collection Plugins collection	# `[ 'matcher' => [ ClassLiteralMatcher::class => [ SelfKeywordDecorator::class, UseResolverDecorator::class, [ 'class' => ClassErrorSilencer::class, 'classes' => [ 'PHPMD' ] ] ], StaticConstantMatcher::class => [ UseResolverDecorator::class, MagicConstantDecorator::class ], AnnotationsMatcher::class => [ DefencerDecorator::class ] ] ]`

API documentation generated by ApiGen

Maslosoft Addendum API

Namespaces

Classes

Class Addendum

Methods summary

Parameters

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Renturn

Parameters

Returns

Parameters

Returns

Deprecated

Parameters

Parameters

Returns

Constants summary

Properties summary

Contact us