Overview

Packages

  • akismet
  • None
  • PHP
  • Smarty
    • Cacher
    • Compiler
    • Config
    • Debug
    • plugins
    • PluginsBlock
    • PluginsFilter
    • PluginsFunction
    • PluginsInternal
    • PluginsModifier
    • PluginsModifierCompiler
    • PluginsShared
    • Security
    • Template
    • TemplateResources
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Signatures
    • Signed
    • Transport
  • wa-apps
    • blog
      • actions
        • backend
        • blog
        • comment
        • cron
        • design
        • frontend
        • page
        • plugin
        • post
      • api
        • v1
      • cli
      • layout
      • model
      • plugin
        • aksimet
        • category
        • emailsubscription
        • favorite
        • gravatar
        • import
        • markdown
        • myposts
        • tag
        • troll
      • settings
    • checklists
      • backend
      • json
    • contacts
      • backend
    • developer
    • dummy
    • guestbook
    • guestbook2
    • photos
      • album
      • api
        • v1
      • backend
      • design
      • dialog
      • frontend
      • page
      • photo
      • plugin
        • comment
        • imageeffects
        • import
        • publicgallery
        • watermark
      • search
      • settings
      • stack
      • tag
      • upload
    • site
      • backend
      • blocks
      • config
      • design
      • domains
      • files
      • frontend
      • helper
      • layout
      • pages
      • routing
      • setting
    • stickies
      • api
        • v1
      • sheet
      • stiky
  • wa-plugin
    • payment
    • shipping
    • sms
  • wa-plugins
    • shipping
      • usps
  • wa-system
    • API
    • Auth
      • Adapters
    • Autoload
    • Cache
      • Adapter
    • Captcha
    • Config
    • Contact
    • controller
    • currency
    • database
    • datetime
    • design
    • event
    • exception
    • files
    • image
    • layout
    • locale
    • log
    • mail
    • page
      • action
      • model
    • payment
    • plugin
    • request
    • response
    • routing
    • shipping
    • sms
    • storage
    • user
    • util
    • validator
    • view
    • webasyst
      • api
      • backend
      • cli
      • config
      • layout
      • login
      • model
      • password
      • payment
      • profile
      • settings
      • shipment
    • widget
    • workflow
  • waPlugins
    • Payment
  • webasyst
    • wa-system
      • helper

Classes

  • contactsConfig
  • waAppConfig
  • waConfig
  • waRightConfig
  • waSitemapConfig
  • waSystemConfig
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class waAppConfig

This file is part of Webasyst framework.

Licensed under the terms of the GNU Lesser General Public License (LGPL). http://www.webasyst.com/framework/license/

SystemConfig
Extended by waAppConfig

Direct known subclasses

blogConfig, contactsConfig, dummyConfig, photosConfig, siteConfig, stickiesConfig, webasystConfig
Package: wa-system\Config
Copyright: 2011 Webasyst LLC
License: LGPL
Author: Webasyst LLC
See: http://www.webasyst.ru/developers/docs/basics/classes/waAppConfig/
Link: http://www.webasyst.com/
Located at wa-system/config/waAppConfig.class.php
Methods summary
public
# __construct( mixed $environment, mixed $root_path, mixed $application = null, mixed $locale = null )
public string
# getApplication( )

Returns app's id.

Returns app's id.

Returns

string

See

http://www.webasyst.ru/developers/docs/basics/classes/waAppConfig/#method-getApplication
public
# getCache( mixed $type = 'default' )
public
# getLogActions( mixed $full = false, mixed $ignore_system = false )
public
# getSystemLogActions( )
protected
# configure( )
public mixed
# getOption( string $name = null )

Returns app configuration parameter values.

Returns app configuration parameter values.

Parameters

$name
string
$name The name of configuration parameter whose value must be returned.

Returns

mixed

See

http://www.webasyst.ru/developers/docs/basics/classes/waAppConfig/#method-getOption
public
# init( )
public
# checkUpdates( )
private
# includeUpdate( mixed $file )
public
# install( )
public static
# executeSQL( string $file_sql, integer $type = 0 )

Execute sql from file

Execute sql from file

Parameters

$file_sql
string
$file_sql
$type
integer
$type 0 - execute all queries, 1 - ignore drop table, 2 - execute only drop table
public
# uninstall( )
public
# setLocale( mixed $locale, mixed $bind = true )
public
# getClasses( )
protected
# getPHPFiles( mixed $path )
protected
# isIgnoreFile( mixed $f )
protected
# getClassByFilename( mixed $filename )
public string
# getAppPath( unknown_type $path = null )

Returns path to app's source files directory.

Returns path to app's source files directory.

Parameters

$path
unknown_type
$path Optional path to a subdirectory inside app's lib/ directory

Returns

string

See

http://www.webasyst.ru/developers/docs/basics/classes/waAppConfig/#method-getAppPath
public string
# getAppConfigPath( string $name )

Returns path to specified configuration file of current app, located in its lib/config/ directory.

Returns path to specified configuration file of current app, located in its lib/config/ directory.

Parameters

$name
string
$name Name of configuration file without extension

Returns

string

See

http://www.webasyst.ru/developers/docs/basics/classes/waAppConfig/#method-getAppConfigPath
public string
# getConfigPath( string $name, boolean $user_config = true, string $app = null )

Returns path to app's configuration file with specified name.

Returns path to app's configuration file with specified name.

Parameters

$name
string
$name Name of the configuration file whose path must be returned
$user_config
boolean
$user_config Whether path to a file located in wa-config/apps/[app_id]/ directory must be returned, which is used for storing custom user configuration. If false is specified, method returns path to a file located in wa-apps/[app_id]/lib/config/.
$app
string
$app Optional app id, defaults to current app's id

Returns

string

See

http://www.webasyst.ru/developers/docs/basics/classes/waAppConfig/#method-getConfigPath
waSystemConfig::getConfigPath()
public
# getRouting( mixed $route = array() )
public
# getPrefix( )
public string
# getName( )

Returns app's name from its configuration file lib/config/app.php.

Returns app's name from its configuration file lib/config/app.php.

Returns

string

See

http://www.webasyst.ru/developers/docs/basics/classes/waAppConfig/#method-getName
public string|array
# getInfo( string $name = null )

Returns information from app's configuration file lib/config/app.php.

Returns information from app's configuration file lib/config/app.php.

Parameters

$name
string
$name Name of parameter whose value must be returned. If not specified, method returns associative array of all parameters contained in configuration file.

Returns

string|array

See

http://www.webasyst.ru/developers/docs/basics/classes/waAppConfig/#method-getInfo
public string
# getPluginPath( string $plugin_id )

Returns path to the source files of an app's plugin.

Returns path to the source files of an app's plugin.

Parameters

$plugin_id
string
$plugin_id Plugin id

Returns

string

See

http://www.webasyst.ru/developers/docs/basics/classes/waAppConfig/#method-getPluginPath
public array
# getPluginInfo( string $plugin_id )

Returns information about app's plugin.

Returns information about app's plugin.

Parameters

$plugin_id
string
$plugin_id Plugin id

Returns

array

See

http://www.webasyst.ru/developers/docs/basics/classes/waAppConfig/#method-getPluginInfo
public array
# getPlugins( )

Returns information about all app's installed plugins as an associative array.

Returns information about all app's installed plugins as an associative array.

Returns

array

See

http://www.webasyst.ru/developers/docs/basics/classes/waAppConfig/#method-getPlugins
public
# setPluginSort( string $plugin, integer $sort )

Update general plugin sort

Parameters

$plugin
string
$plugin plugin id
$sort
integer
$sort 0 is first
public
# checkRights( mixed $module, mixed $action )
public
# onCount( )
public
# setCount( mixed $n = null )

Sets or clears the value of app's indicator displayed next to its icon in main backend menu.

Sets or clears the value of app's indicator displayed next to its icon in main backend menu.

Parameters

$n
mixed
Indicator value. If empty value is specified, indicator value is cleared.

See

http://www.webasyst.ru/developers/docs/basics/classes/waAppConfig/#method-setCount
Properties summary
protected string $application null
#

Строковое ID приложения.

Строковое ID приложения.

protected array $info array()
#
protected mixed $log_actions null
#
protected mixed $system_log_actions null
#
protected mixed $prefix
#
protected mixed $plugins null
#
protected mixed $themes null
#
protected array $options array()
#
protected mixed $routes null
#
protected mixed $loaded_locale null
#
protected mixed $cache null
#
My fork of Webasyst Framework API documentation generated by ApiGen 2.8.0