cakephp-2.0 > View :: element()
A AbstractTransport AclBehavior AclComponent AclInterface AclNode AclShell Aco AcoAction ActionsAuthorize ApcEngine ApiShell App AppController AppController AppHelper AppHelper AppModel AppModel AppShell Aro AuthComponent B BadRequestException BakeShell BakeTask BaseAuthenticate BaseAuthorize BasicAuthenticate BasicAuthentication BehaviorCollection C Cache CacheEngine CacheException CacheHelper CacheSession CakeEmail CakeErrorController CakeException CakeLog CakeLogException CakeLogInterface CakePlugin CakeRequest CakeResponse CakeRoute CakeSchema CakeSession CakeSessionException CakeSessionHandlerInterface CakeSocket ClassRegistry CommandListShell Component ComponentCollection ConfigReaderInterface Configure ConfigureException ConnectionManager ConsoleErrorHandler ConsoleException ConsoleInput ConsoleInputArgument ConsoleInputOption ConsoleInputSubcommand ConsoleOptionParser ConsoleOutput ConsoleShell ContainableBehavior Controller ControllerAuthorize ControllerTask CookieComponent CrudAuthorize D DatabaseSession DataSource DbAcl DbAclSchema DbConfigTask DboSource Debugger DebugTransport DigestAuthenticate DigestAuthentication Dispatcher E EmailComponent ErrorHandler ExceptionRenderer ExtractTask F File FileEngine FileLog FixtureTask Folder ForbiddenException FormAuthenticate FormHelper H Helper HelperCollection HelpFormatter HtmlHelper HttpException HttpResponse HttpSocket I I18n I18nModel i18nSchema I18nShell Inflector IniReader InternalErrorException J JqueryEngineHelper JsBaseEngineHelper JsHelper L L10n M MailTransport MediaView MemcacheEngine MethodNotAllowedException MissingActionException MissingBehaviorException MissingComponentException MissingConnectionException MissingControllerException MissingDatabaseException MissingDatasourceConfigException MissingDatasourceException MissingHelperException MissingLayoutException MissingModelException MissingPluginException MissingShellException MissingShellMethodException MissingTableException MissingTaskException MissingTestLoaderException MissingViewException Model ModelBehavior ModelTask MootoolsEngineHelper Multibyte Mysql N NotFoundException NumberHelper O Object ObjectCollection P PagesController PagesController PaginatorComponent PaginatorHelper Permission PhpReader PluginShortRoute PluginTask Postgres PrivateActionException ProjectTask PrototypeEngineHelper R RedirectRoute RequestHandlerComponent Router RouterException RssHelper S Sanitize Scaffold ScaffoldView SchemaShell Security SecurityComponent SessionComponent SessionHelper SessionsSchema Set Shell ShellDispatcher SmtpTransport SocketException Sqlite Sqlserver String T TaskCollection TemplateTask TestsuiteShell TestTask TextHelper ThemeView TimeHelper TranslateBehavior TreeBehavior U UnauthorizedException UpgradeShell V Validation View ViewTask W WincacheEngine X XcacheEngine Xml XmlException

element

line:270 at /lib/Cake/View/View.php
Renders a piece of PHP with provided parameters and returns HTML, XML, or any other string.

Method

(string) public element ($name, $data = array(), $options = array())

Parameters

ParameterTypeCommentDefault
$name string required Name of template file in the/app/View/Elements/ folder
$data array optional Array of data to be made available to the rendered view (i.e. the Element) array()
$options array optional Array of options. Possible keys are: - `cache` - Can either be `true`, to enable caching using the config in View::$elementCache. Or an array If an array, the following keys can be used: - `config` - Used to store the cached element in a custom cache configuration. - `key` - Used to define the key used in the Cache::write(). It will be prefixed with `element_` - `plugin` - Load an element from a specific plugin. - `callbacks` - Set to true to fire beforeRender and afterRender helper callbacks for this element. Defaults to false. array()

Return

string

Comment

Renders a piece of PHP with provided parameters and returns HTML, XML, or any other string.

This realizes the concept of Elements, (or "partial layouts") and the $params array is used to send
data to be used in the element. Elements can be cached improving performance by using the `cache` option.

@param string $name Name of template file in the/app/View/Elements/ folder
@param array $data Array of data to be made available to the rendered view (i.e. the Element)
@param array $options Array of options. Possible keys are:
- `cache` - Can either be `true`, to enable caching using the config in View::$elementCache. Or an array
If an array, the following keys can be used:
- `config` - Used to store the cached element in a custom cache configuration.
- `key` - Used to define the key used in the Cache::write(). It will be prefixed with `element_`
- `plugin` - Load an element from a specific plugin.
- `callbacks` - Set to true to fire beforeRender and afterRender helper callbacks for this element.
Defaults to false.
@return string Rendered Element