Warning: PyroCMS v2 is very old, these docs are provided free of charge, use at your own risk.
Streams API Fields Driver
The fields driver is used to create and manipulate fields. Fields are instances of field types that contain the name/slug of the field and values for their preferences.
You can call the fields driver like this:
$this->load->driver('Streams');
$this->streams->fields->function();
The following functions are available in the Streams API fields driver:
add_field($field)
Creates a field. The function takes a single array which can have the following data:
Parameters
| name | The full name of the field. |
| slug | The field slug. |
| namespace | A namespace for your field. This should be the namespace of the stream or streams you plan to assign this field to. |
| type | The field type for this field. |
| extra | Optional. Extra data required or optional for the field type you choose. Please see the field types documentation to see what values are available. |
| assign | Optional. Allows you to automatically assign field to a stream. This value is the stream slug of the stream you'd like to assign this field to. The stream needs to be in the same namespace as the field. |
Example:
$field = array(
'name' => 'Question',
'slug' => 'question',
'namespace' => 'faq',
'type' => 'text',
'extra' => array('max_length' => 200),
'assign' => 'faqs',
'title_column' => true,
'required' => true,
'unique' => true
)
$this->streams->fields->add_field($field);
add_fields($fields)
Allows you to add an array of fields in the same format of add_field() above.
Example:
$fields = array(
array(
'name' => 'Question',
'slug' => 'question',
'namespace' => 'faq',
'type' => 'text',
'extra' => array('max_length' => 200),
'assign' => 'faqs',
'title_column' => true,
'required' => true,
'unique' => true
),
array(
'name' => 'Answer',
'slug' => 'answer',
'namespace' => 'faq',
'type' => 'textarea',
'assign' => 'faqs',
'required' => true
)
);
$this->streams->fields->add_fields($fields);
assign_field($namespace, $stream_slug, $field_slug, $assign_data = array())
Assigns a field to a stream. These must both be in the same namespace. The last parameter, assign_data is an array that can have the follow values:
| required | Boolean. Whether or not this field should be required. Defaults to FALSE. |
| unique | Boolean. Whether or not this field should be unique in the stream. Defaults to FALSE. |
| title_column | Boolean. Whether or not this field should be the title column. |
| instructions | String. Instructions that will appear on the entry form next to this field. |
Example
$this->streams->fields->assign_field('faq', 'faqs', 'question', array('required' => true));
deassign_field($namespace, $stream_slug, $field_slug)
Deassigns a field from a stream. This will not only remove the assignment, but also the actual column from the stream table, so all data for the field in the stream will be lost.
Example:
$this->streams->fields->deassign_field('faq', 'faqs', 'question');
delete_field($field_slug, $namespace)
Deletes a field and all field assignments for the field.
Example:
$this->streams->fields->delete_field('question', 'faq');
get_field_assignments($field_slug, $namespace)
Get the assignments for a given field.
Example:
$this->streams->fields->get_field_assignments('question', 'faq');
Returns:
Array
(
[0] => stdClass Object
(
[id] => 10
[stream_name] => FAQs
[stream_slug] => faqs
[stream_namespace] => faq
[stream_prefix] => faq_
[about] =>
[view_options] =>
[title_column] => question
[sorting] => title
[stream_view_options] => a:2:{i:0;s:2:"id";i:1;s:7:"created";}
[stream_id] => 18
[field_id] => 10
[field_name] => Question
[field_slug] => question
[field_namespace] => faq
[field_type] => text
[field_data] => a:1:{s:10:"max_length";i:200;}
[field_view_options] =>
)
)