Graphite_GraphBuilder Manual :: Element Index

Packages:

Index of All Elements

Package Indexes

• Graphite

[ a ] [ b ] [ c ] [ e ] [ f ] [ g ] [ i ] [ l ] [ m ] [ n ] [ o ] [ p ] [ q ] [ r ] [ s ] [ t ] [ u ] [ _ ]

Letter 'a'

$aliases

in file Functions.php, variable Graphite_Graph_Functions::$aliases
    Function name aliases.

$aliases

in file Params.php, variable Graphite_Graph_Params::$aliases
    Mapping from property names to Graphite parameter names.

$aliases

in file Generators.php, variable Graphite_Graph_Generators::$aliases
    Function name aliases.

argHasMods

in file CallSpec.php, method Graphite_Graph_CallSpec::argHasMods()
    Does the given argument have modifiers?

argIsOptional

in file CallSpec.php, method Graphite_Graph_CallSpec::argIsOptional()
    Is the given argument optional?

argIsString

in file CallSpec.php, method Graphite_Graph_CallSpec::argIsString()
    Is the given argument optional?

argIsWildcard

in file CallSpec.php, method Graphite_Graph_CallSpec::argIsWildcard()
    Is the given argument a wildcard?

asMetric

in file Series.php, method Graphite_Graph_Series::asMetric()
    Get the description of this series as an array suitable for use with a call to Graphite_GraphBuilder::metric().

asString

in file CallSpec.php, method Graphite_Graph_CallSpec::asString()
    Format the call for use as a target.

autoload.php

procedural page autoload.php

Letter 'b'

$builder

in file IniHelper.php, variable Graphite_Graph_IniHelper::$builder
    Paired Graphite_GraphBuilder

build

in file Series.php, method Graphite_Graph_Series::build()
    Build this series.

build

in file GraphBuilder.php, method Graphite_GraphBuilder::build()
    Generate a graphite graph description query string.

builder

in file GraphBuilder.php, method Graphite_GraphBuilder::builder()
    Builder factory.

builder

in file Series.php, method Graphite_Graph_Series::builder()
    Builder factory.

buildSeries

in file GraphBuilder.php, method Graphite_GraphBuilder::buildSeries()
    Add a data series to the graph using the Graphite_Graph_Series fluent builder DSL.

Letter 'c'

$conf

in file Series.php, variable Graphite_Graph_Series::$conf
    Series configuration data.

callSpec

in file Functions.php, method Graphite_Graph_Functions::callSpec()
    Get the call specification for a function.

callSpec

in file Generators.php, method Graphite_Graph_Generators::callSpec()
    Get the call specification for a generator.

canonicalName

in file Generators.php, method Graphite_Graph_Generators::canonicalName()
    Find the canonical name for a generator.

canonicalName

in file Params.php, method Graphite_Graph_Params::canonicalName()
    Find the canonical name for a parameter.

canonicalName

in file Functions.php, method Graphite_Graph_Functions::canonicalName()
    Find the canonical name for a function.

cmp

in file Functions.php, method Graphite_Graph_Functions::cmp()
    Compare two function names for sort ordering based on priority.

cmp

in file CallSpec.php, method Graphite_Graph_CallSpec::cmp()
    Compare two CallSpecs for sort ordering.

configureGraph

in file IniHelper.php, method Graphite_Graph_IniHelper::configureGraph()
    Configure a Graphite_GraphBuilder using our internal state.

currentPrefix

in file GraphBuilder.php, method Graphite_GraphBuilder::currentPrefix()
    Get the current target prefix.

ConfigurationException.php

procedural page ConfigurationException.php

CallSpec.php

procedural page CallSpec.php

Letter 'e'

endPrefix

in file GraphBuilder.php, method Graphite_GraphBuilder::endPrefix()
    End prefix block.

extendSeries

in file IniHelper.php, method Graphite_Graph_IniHelper::extendSeries()
    Inherit series configuration.

E_USER_DEPRECATED

in file IniHelper.php, constant E_USER_DEPRECATED

Letter 'f'

$functions

in file Functions.php, variable Graphite_Graph_Functions::$functions
    Metric manipulation function specifications.

findSeries

in file IniHelper.php, method Graphite_Graph_IniHelper::findSeries()
    Find an existing series configuration.

FMT_FORMAT_ARG

in file CallSpec.php, class constant Graphite_Graph_CallSpec::FMT_FORMAT_ARG
    Sprintf format string for creating a lambda function to format a list of arguments.

forecast

in file GraphBuilder.php, method Graphite_GraphBuilder::forecast()
    Add forecast, confidence bands, aberrations and base series using the Holt-Winters Confidence Band prediction model.

format

in file CallSpec.php, method Graphite_Graph_CallSpec::format()
    Format an argument as a specified type.

format

in file Params.php, method Graphite_Graph_Params::format()
    Format a parameter value.

Functions.php

procedural page Functions.php

Letter 'g'

$generators

in file Generators.php, variable Graphite_Graph_Generators::$generators
    Data generation functions.

$global

in file IniHelper.php, variable Graphite_Graph_IniHelper::$global
    Global graph configuration.

$graph

in file Series.php, variable Graphite_Graph_Series::$graph
    Paired graph builder.

generate

in file Series.php, method Graphite_Graph_Series::generate()
    Generate the target parameter for a given configuration.

getArg

in file CallSpec.php, method Graphite_Graph_CallSpec::getArg()
    Get the Nth argument spec.

getMeta

in file GraphBuilder.php, method Graphite_GraphBuilder::getMeta()
    Get metadata by type and name.

Graphite_ConfigurationException

in file ConfigurationException.php, class Graphite_ConfigurationException

Graphite_GraphBuilder

in file GraphBuilder.php, class Graphite_GraphBuilder
    Graphite graph query string generator.

graphite_graph_autoload

in file autoload.php, function graphite_graph_autoload()
    Simple autoloader that converts underscore and backslash to directories.

Graphite_Graph_CallSpec

in file CallSpec.php, class Graphite_Graph_CallSpec
    Description of the call specification for a Graphite function.

Graphite_Graph_Functions

in file Functions.php, class Graphite_Graph_Functions
    Utility for target functions.

Graphite_Graph_Generators

in file Generators.php, class Graphite_Graph_Generators
    Utility for target generators.

Graphite_Graph_IniHelper

in file IniHelper.php, class Graphite_Graph_IniHelper
    Helper object for processing ini file configurations in Graphite_GraphBuilder.

Graphite_Graph_Params

in file Params.php, class Graphite_Graph_Params
    Utility for graph level parameters.

Graphite_Graph_Series

in file Series.php, class Graphite_Graph_Series
    DSL for building Graphite series to display on a graph.

Graphite_IniParser

in file IniParser.php, class Graphite_IniParser
    Ini file parser.

Generators.php

procedural page Generators.php

GraphBuilder.php

procedural page GraphBuilder.php

Letter 'i'

$isAlias

in file CallSpec.php, variable Graphite_Graph_CallSpec::$isAlias
    Does this function provide an alias for the series?

ini

in file GraphBuilder.php, method Graphite_GraphBuilder::ini()
    Load a graph description file.

isAlias

in file CallSpec.php, method Graphite_Graph_CallSpec::isAlias()
    Does this function provide an alias for the series?

IniHelper.php

procedural page IniHelper.php

IniParser.php

procedural page IniParser.php

Letter 'l'

line

in file GraphBuilder.php, method Graphite_GraphBuilder::line()
    Draws a straight line on the graph.

loadIniData

in file IniHelper.php, method Graphite_Graph_IniHelper::loadIniData()
    Load configuration data from the provided array into this instance.

lookupPrefix

in file GraphBuilder.php, method Graphite_GraphBuilder::lookupPrefix()
    Lookup a prefix in this graph's metadata.

Letter 'm'

$meta

in file GraphBuilder.php, variable Graphite_GraphBuilder::$meta
    Configuration metadata.

maxArgs

in file CallSpec.php, method Graphite_Graph_CallSpec::maxArgs()
    How many args are possible for this function?

metric

in file GraphBuilder.php, method Graphite_GraphBuilder::metric()
    Add a data series to the graph.

Letter 'n'

$name

in file CallSpec.php, variable Graphite_Graph_CallSpec::$name
    Canonical name of the function.

Letter 'o'

$order

in file CallSpec.php, variable Graphite_Graph_CallSpec::$order
    Sort order.

Letter 'p'

$params

in file Params.php, variable Graphite_Graph_Params::$params
    Valid graph URI parameters.

$prefixStack

in file GraphBuilder.php, variable Graphite_GraphBuilder::$prefixStack
    Series prefix stack.

parse

in file IniParser.php, method Graphite_IniParser::parse()
    Parse an ini file and return an array of it's contents.

pop

in file IniHelper.php, method Graphite_Graph_IniHelper::pop()
    Remove and return a named value from an array.

prefix

in file IniHelper.php, method Graphite_Graph_IniHelper::prefix()
    Get a prefix by name.

prefix

in file GraphBuilder.php, method Graphite_GraphBuilder::prefix()
    Set a prefix to add to subsequent series.

process

in file IniHelper.php, method Graphite_Graph_IniHelper::process()
    Process an ini configuration.

Params.php

procedural page Params.php

Letter 'q'

qs

in file GraphBuilder.php, method Graphite_GraphBuilder::qs()
    Alias for build().

qsEncode

in file GraphBuilder.php, method Graphite_GraphBuilder::qsEncode()
    Query string specific uri encoding.

Letter 'r'

requiredArgs

in file CallSpec.php, method Graphite_Graph_CallSpec::requiredArgs()
    How many args are required for this function?

reset

in file GraphBuilder.php, method Graphite_GraphBuilder::reset()
    Reset builder to empty state.

resolvePrefix

in file GraphBuilder.php, method Graphite_GraphBuilder::resolvePrefix()
    Resolve a prefix.

RE_PARSE

in file IniParser.php, class constant Graphite_IniParser::RE_PARSE
    Regular expression used to find substituion tokens in the ini file.

Letter 's'

$series

in file IniHelper.php, variable Graphite_Graph_IniHelper::$series
    Global graph configuration.

$settings

in file GraphBuilder.php, variable Graphite_GraphBuilder::$settings
    Graph settings.

$signature

in file CallSpec.php, variable Graphite_Graph_CallSpec::$signature
    Description of function arguments.

series

in file GraphBuilder.php, method Graphite_GraphBuilder::series()
    Add a data series to the graph.

Series.php

procedural page Series.php

storeMeta

in file GraphBuilder.php, method Graphite_GraphBuilder::storeMeta()
    Add new metadata.

substitute

in file IniParser.php, method Graphite_IniParser::substitute()
    Substitute a match with data found in our variables.

Letter 't'

$targets

in file GraphBuilder.php, variable Graphite_GraphBuilder::$targets
    Configuration for each target that will be rendered or retrieved.

takesArgs

in file CallSpec.php, method Graphite_Graph_CallSpec::takesArgs()
    Does this function require arguments other than a series?

Letter 'u'

$usesSeries

in file CallSpec.php, variable Graphite_Graph_CallSpec::$usesSeries
    Does this function wrap a series?

url

in file GraphBuilder.php, method Graphite_GraphBuilder::url()
    Alias for build().

Letter '_'

__call

in file Series.php, method Graphite_Graph_Series::__call()
    Handle attempts to call non-existant methods.

__call

in file GraphBuilder.php, method Graphite_GraphBuilder::__call()
    Handle attempts to call non-existant methods.

__construct

in file GraphBuilder.php, method Graphite_GraphBuilder::__construct()
    Constructor.

__construct

in file CallSpec.php, method Graphite_Graph_CallSpec::__construct()
    Constructor.

__construct

in file Series.php, method Graphite_Graph_Series::__construct()
    Constructor.

__construct

in file IniHelper.php, method Graphite_Graph_IniHelper::__construct()
    Constructor.

__get

in file GraphBuilder.php, method Graphite_GraphBuilder::__get()
    Handle attempts to read from non-existant members.

__set

in file GraphBuilder.php, method Graphite_GraphBuilder::__set()
    Handle attempts to write to non-existant members.

__toString

in file GraphBuilder.php, method Graphite_GraphBuilder::__toString()
    Convert to string.