Skip to content

Admin log

decorators#

excludes#

Excludes decorators added by the "common" option from the admin log controllers

controller/jobs/admin/log/decorators/excludes = Array
(
)
  • Default: Array
  • Type: array - List of decorator names
  • Since: 2015.09

Decorators extend the functionality of a class by adding new aspects (e.g. log what is currently done), executing the methods of the underlying class only in certain conditions (e.g. only for logged in users) or modify what is returned to the caller.

This option allows you to remove a decorator added via "controller/jobs/common/decorators/default" before they are wrapped around the job controller.

 controller/jobs/admin/log/decorators/excludes = array( 'decorator1' )

This would remove the decorator named "decorator1" from the list of common decorators ("\Aimeos\Controller\Jobs\Common\Decorator*") added via "controller/jobs/common/decorators/default" to this job controller.

See also:

  • controller/jobs/common/decorators/default
  • controller/jobs/admin/log/decorators/global
  • controller/jobs/admin/log/decorators/local

global#

Adds a list of globally available decorators only to the admin log controllers

controller/jobs/admin/log/decorators/global = Array
(
)
  • Default: Array
  • Type: array - List of decorator names
  • Since: 2015.09

Decorators extend the functionality of a class by adding new aspects (e.g. log what is currently done), executing the methods of the underlying class only in certain conditions (e.g. only for logged in users) or modify what is returned to the caller.

This option allows you to wrap global decorators ("\Aimeos\Controller\Jobs\Common\Decorator*") around the job controller.

 controller/jobs/admin/log/decorators/global = array( 'decorator1' )

This would add the decorator named "decorator1" defined by "\Aimeos\Controller\Jobs\Common\Decorator\Decorator1" only to this job controller.

See also:

  • controller/jobs/common/decorators/default
  • controller/jobs/admin/log/decorators/excludes
  • controller/jobs/admin/log/decorators/local

local#

Adds a list of local decorators only to the admin log controllers

controller/jobs/admin/log/decorators/local = Array
(
)
  • Default: Array
  • Type: array - List of decorator names
  • Since: 2015.09

Decorators extend the functionality of a class by adding new aspects (e.g. log what is currently done), executing the methods of the underlying class only in certain conditions (e.g. only for logged in users) or modify what is returned to the caller.

This option allows you to wrap local decorators ("\Aimeos\Controller\Jobs\Admin\Log\Decorator*") around this job controller.

 controller/jobs/admin/log/decorators/local = array( 'decorator2' )

This would add the decorator named "decorator2" defined by "\Aimeos\Controller\Jobs\Admin\Log\Decorator\Decorator2" only to this job controller.

See also:

  • controller/jobs/common/decorators/default
  • controller/jobs/admin/log/decorators/excludes
  • controller/jobs/admin/log/decorators/global

name#

Class name of the used admin log scheduler controller implementation

controller/jobs/admin/log/name = Standard
  • Default: Standard
  • Type: string - Last part of the class name
  • Since: 2014.09

Each default log controller can be replace by an alternative imlementation. To use this implementation, you have to set the last part of the class name as configuration value so the controller factory knows which class it has to instantiate.

For example, if the name of the default class is

 \Aimeos\Controller\Jobs\Admin\Log\Standard

and you want to replace it with your own version named

 \Aimeos\Controller\Jobs\Admin\Log\Mylog

then you have to set the this configuration option:

 controller/jobs/admin/log/name = Mylog

The value is the last part of your own class name and it's case sensitive, so take care that the configuration value is exactly named like the last part of the class name.

The allowed characters of the class name are A-Z, a-z and 0-9. No other characters are possible! You should always start the last part of the class name with an upper case character and continue only with lower case characters or numbers. Avoid chamel case names like "MyLog"!

standard#

container/format#

Format of the coupon code files to import

controller/jobs/admin/log/standard/container/format = CSV
  • Default: CSV
  • Type: string - Content file type
  • Since: 2014.09

The coupon codes are stored in one or more files or content objects. The format of that file or content object can be configured with this option but most formats are bound to a specific container type.

The formats that are supported by default are:

  • CSV (requires container type "Zip")

Extensions implement other container types like spread sheets, XMLs or more advanced ways of handling the exported data.

See also:

  • controller/jobs/admin/log/standard/path
  • controller/jobs/admin/log/standard/container/type
  • controller/jobs/admin/log/standard/container/options
  • controller/jobs/admin/log/standard/limit-days

container/options#

Options changing the expected format of the coupon codes to import

controller/jobs/admin/log/standard/container/options = Array
(
)
  • Default: Array
  • Type: array - Associative list of options with the name as key and its value
  • Since: 2014.09

Each content format may support some configuration options to change the output for that content type.

The options for the CSV content format are:

  • csv-separator, default ','
  • csv-enclosure, default '"'
  • csv-escape, default '"'
  • csv-lineend, default '\n'

For format options provided by other container types implemented by extensions, please have a look into the extension documentation.

See also:

  • controller/jobs/admin/log/standard/path
  • controller/jobs/admin/log/standard/container/type
  • controller/jobs/admin/log/standard/container/format
  • controller/jobs/admin/log/standard/limit-days

container/type#

Container file type storing all coupon code files to import

controller/jobs/admin/log/standard/container/type = Zip
  • Default: Zip
  • Type: string - Container file type
  • Since: 2014.09

All coupon code files or content objects must be put into one container file so editors don't have to upload one file for each coupon code file.

The container file types that are supported by default are:

  • Zip

Extensions implement other container types like spread sheets, XMLs or more advanced ways of handling the exported data.

See also:

  • controller/jobs/admin/log/standard/path
  • controller/jobs/admin/log/standard/container/format
  • controller/jobs/admin/log/standard/container/options
  • controller/jobs/admin/log/standard/limit-days

limit-days#

Only remove log entries that were created berore the configured number of days

controller/jobs/admin/log/standard/limit-days = 0
  • Default: 30
  • Type: integer - Number of days
  • Since: 2014.09

This option specifies the number of days log entries will be kept in the database. Afterwards, they will be removed and archived if a path for storing the archive files is configured.

See also:

  • controller/jobs/admin/log/standard/path
  • controller/jobs/admin/log/standard/container/type
  • controller/jobs/admin/log/standard/container/format
  • controller/jobs/admin/log/standard/container/options

path#

Path to a writable directory where the log archive files should be stored

controller/jobs/admin/log/standard/path = /var/www/aimeos/aimeos-core/ext/ai-controller-jobs/controller/jobs/tests/tmp
  • Default: /tmp
  • Type: string - Absolute file system path to a writable directory
  • Since: 2014.09

During normal operation, a lot of data can be logged, not only for errors that have occured. By default, these data is written into the log database and its size will grow if old log entries are not removed. There's a job controller available that can delete old log entries.

If an absolute path to a writeable directory in the file system is set via this configuration option, the job controller will save the old log entries to a file in this path. They can be analysed later if required.

The type and format of these files as well as the time frame after the log entries are removed from the log database can be configured too.

See also:

  • controller/jobs/admin/log/standard/container/type
  • controller/jobs/admin/log/standard/container/format
  • controller/jobs/admin/log/standard/container/options
  • controller/jobs/admin/log/standard/limit-days

Comments