/Sugar/Stdlib.php

Description
Description | Functions

Sugar template function standard library.

These are all of the built-in standard template functions that ship with Sugar. Note that the functions are not documented in phpdoc, as the functions are of little interest to PHP developers; the important information is related to how they are called from Sugar, and a custom documentation parser has been written for generating that documentation.

PHP version 5

LICENSE:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Functions
Description | Functions
sugar_function_array (line 404)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_array (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_basename (line 527)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_basename (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_checked (line 259)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_checked (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_count (line 221)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_count (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_cycle (line 482)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_cycle (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_date (line 154)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_date (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_default (line 204)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_default (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_disabled (line 277)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_disabled (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_eval (line 85)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_eval (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_explode (line 598)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_explode ( $s,  $p, Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
  • $s
  • $p
sugar_function_implode (line 572)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_implode ( $s,  $p, Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
  • $s
  • $p
sugar_function_include (line 62)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_include (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_isset (line 497)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_isset (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_join (line 566)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_join (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_json (line 141)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_json (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_ldelim (line 691)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_ldelim (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_merge (line 542)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_merge (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_nl2br (line 464)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_nl2br (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_printf (line 171)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_printf (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_psplit (line 617)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_psplit (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_rdelim (line 701)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_rdelim (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_select (line 298)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_select (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_selected (line 240)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_selected (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_split (line 588)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_split (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_sprintf (line 180)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_sprintf ( $s,  $p, Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
  • $s
  • $p
sugar_function_strtolower (line 416)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_strtolower (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_strtoupper (line 428)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_strtoupper (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_substr (line 449)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_substr (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_time (line 515)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_time (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_truncate (line 323)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_truncate (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_urlencode (line 103)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_urlencode (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_function_var (line 389)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_function_var (Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
sugar_modifier_default (line 678)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_modifier_default ( $value, Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
  • $value
sugar_modifier_escape (line 354)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_modifier_escape ( $value, Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
  • $value
sugar_modifier_int (line 634)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_modifier_int ( $value, Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
  • $value
sugar_modifier_json (line 127)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_modifier_json ( $value, Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
  • $value
sugar_modifier_lower (line 662)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_modifier_lower ( $value, Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
  • $value
sugar_modifier_upper (line 648)

Standard library function

Sugar template functions. Please view the Sugar reference manual for documentation on the behavior and use of these functions from within templates.

mixed sugar_modifier_upper ( $value, Sugar $sugar, array $params)
  • Sugar $sugar: Sugar object.
  • array $params: Template parameters.
  • $value

Documentation generated on Sat, 18 Sep 2010 05:27:01 +0000 by phpDocumentor 1.4.3