[ Index ]

PHP Cross Reference of Drupal 6 (yi-drupal)

title

Body

[close]

/sites/all/modules/ctools/includes/ -> export.inc (summary)

(no description)

File Size: 1014 lines (32 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 26 functions

  ctools_export_crud_new()
  ctools_export_crud_load()
  ctools_export_crud_load_all()
  ctools_export_crud_save()
  ctools_export_crud_delete()
  ctools_export_crud_export()
  ctools_export_crud_import()
  ctools_export_load_object()
  ctools_export_load_object_reset()
  ctools_get_default_object()
  _ctools_export_get_defaults()
  _ctools_export_unpack_object()
  ctools_export_unpack_object()
  ctools_var_export()
  ctools_export_object()
  ctools_export_get_schema()
  ctools_export_get_schemas()
  _ctools_export_filter_export_tables()
  ctools_export_get_schemas_by_module()
  ctools_export_set_status()
  ctools_export_set_object_status()
  ctools_export_form()
  ctools_export_new_object()
  ctools_export_to_hook_code()
  ctools_export_default_to_hook_code()
  ctools_export_default_list()

Functions
Functions that are not part of a class:

ctools_export_crud_new($table, $set_defaults = TRUE)   X-Ref
Create a new object for the given $table.

param: $table
param: $set_defaults
return:

ctools_export_crud_load($table, $name)   X-Ref
Load a single exportable object.

param: $table
param: $name
return:

ctools_export_crud_load_all($table, $reset = FALSE)   X-Ref
Load all exportable objects of a given type.

param: $table
param: $reset
return:

ctools_export_crud_save($table, &$object)   X-Ref
Save a single exportable object.

param: $table
param: $object
return:

ctools_export_crud_delete($table, $object)   X-Ref
Delete a single exportable object.

This only deletes from the database, which means that if an item is in
code, then this is actually a revert.

param: $table
param: $object

ctools_export_crud_export($table, $object, $indent = '')   X-Ref
Get the exported code of a single exportable object.

param: $table
param: $object
param: $indent
return:

ctools_export_crud_import($table, $code)   X-Ref
Turn exported code into an object.

Note: If the code is poorly formed, this could crash and there is no
way to prevent this.

param: $table
param: $code
return:

ctools_export_load_object($table, $type = 'all', $args = array()   X-Ref
Load some number of exportable objects.

This function will cache the objects, load subsidiary objects if necessary,
check default objects in code and properly set them up. It will cache
the results so that multiple calls to load the same objects
will not cause problems.

It attempts to reduce, as much as possible, the number of queries
involved.

param: $table
param: $type
param: $args

ctools_export_load_object_reset($table = NULL)   X-Ref
Reset all static caches in ctools_export_load_object() or static caches for
a given table in ctools_export_load_object().

param: $table

ctools_get_default_object($table, $name)   X-Ref
Get the default version of an object, if it exists.

This function doesn't care if an object is in the database or not and
does not check. This means that export_type could appear to be incorrect,
because a version could exist in the database. However, it's not
incorrect for this function as it is *only* used for the default
in code version.

_ctools_export_get_defaults($table, $export)   X-Ref
Call the hook to get all default objects of the given type from the
export. If configured properly, this could include loading up an API
to get default objects.


_ctools_export_unpack_object($schema, $data, $object = 'stdClass')   X-Ref
Unpack data loaded from the database onto an object.

param: $schema
param: $data
param: $object

ctools_export_unpack_object($table, $data)   X-Ref
Unpack data loaded from the database onto an object.

param: $table
param: $data

ctools_var_export($var, $prefix = '')   X-Ref
Export a field.

This is a replacement for var_export(), allowing us to more nicely
format exports. It will recurse down into arrays and will try to
properly export bools when it can, though PHP has a hard time with
this since they often end up as strings or ints.

ctools_export_object($table, $object, $indent = '', $identifier = NULL, $additions = array()   X-Ref
Export an object into code.


ctools_export_get_schema($table)   X-Ref
Get the schema for a given table.

This looks for data the export subsystem needs and applies defaults so
that it's easily available.

ctools_export_get_schemas($for_export = FALSE)   X-Ref
Gets the schemas for all tables with ctools object metadata.


_ctools_export_filter_export_tables($schema)   X-Ref
No description

ctools_export_get_schemas_by_module($modules = array()   X-Ref
No description

ctools_export_set_status($table, $name, $new_status = TRUE)   X-Ref
Set the status of a default $object as a variable.

The status, in this case, is whether or not it is 'disabled'.
This function does not check to make sure $object actually
exists.

ctools_export_set_object_status($object, $new_status = TRUE)   X-Ref
Set the status of a default $object as a variable.

This is more efficient than ctools_export_set_status because it
will actually unset the variable entirely if it's not necessary,
this saving a bit of space.

ctools_export_form(&$form_state, $code, $title = '')   X-Ref
Provide a form for displaying an export.

This is a simple form that should be invoked like this:

ctools_export_new_object($table, $set_defaults = TRUE)   X-Ref
Create a new object based upon schema values.

Because 'default' has ambiguous meaning on some fields, we will actually
use 'object default' to fill in default values if default is not set
That's a little safer to use as it won't cause weird database default
situations.

ctools_export_to_hook_code(&$code, $table, $names = array()   X-Ref
Convert a group of objects to code based upon input and return this as a larger
export.


ctools_export_default_to_hook_code($schema, $table, $names, $name)   X-Ref
Default function to export objects to code.

Note that if your module provides a 'to hook code callback' then it will
receive only $names and $name as arguments. Your module is presumed to
already know the rest.

ctools_export_default_list($table, $schema)   X-Ref
Default function for listing bulk exportable objects.




Generated: Mon Jul 9 18:01:44 2012 Cross-referenced by PHPXref 0.7