lumenpress/acf

There is no license information available for the latest version (v0.2.2) of this package.

v0.2.2 2017-11-06 12:50 UTC

Requires

• php: >=5.6.4
• lumenpress/nimble: ^0.2.0

Requires (Dev)

• advanced-custom-fields-pro/advanced-custom-fields-pro: ^5.6.2
• composer/installers: ^1.4
• kint-php/kint: ^2.1
• lumenpress/testing: ~0.2.0
• phpunit/phpunit: >=5.7
• vlucas/phpdotenv: ^2.4

Unknown License

README

• Installation
• Schema
  • Field Groups
    • Creating Field Groups
    • Renaming / Dropping Field Groups
  • Fields
    • Creating Fields
    • Modifying Fields
    • Dropping Fields
• Models
  • Inserts
  • Updates
  • Deletes
• Builders
  • Retrieving Results
  • Inserting Values
  • Updating Values
  • Deleting Values

Installation

composer require lumenpress/acf

Copy the config/acf.php file to your local config folder and register the configuration + Service Provider in bootstrap/app.php:

$app->configure('acf'); 
$app->register(LumenPress\ACF\ServiceProvider::class);

Schema

Field Groups

Creating Field Groups

use LumenPress\ACF\Schema;
use LumenPress\ACF\Models\FieldGroup;

Schema::create($groupKey, function (FieldGroup $group) {
    $group->title('Title'); // required
    $group->location('post_type', 'page'); // required
});

The $groupKey should be unique, usually have group_ as a prefix.

Schema::create('group_599d8daf5e131', function (FieldGroup $group) {
    $group->title('Title'); // required
    $group->location('post_type', 'page'); // required
});

If you do not start with group_, the key will be encrypted using md5.

Schema::create('home_page', function (FieldGroup $group) {
    $group->title('Home'); // required
    $group->location('post_type', 'page'); // required
});

// algorithm
echo 'group_'.substr(hash('md5', 'home_page'), 8, 16);
// group_3f239af6fe3db5c0

Available Field Group Settings

• $group->title('string') required
• $group->location($param, $operator, $value) required
• $group->position('normal')
• $group->style('default')
• $group->label_placement('top')
• $group->instruction_placement('label')
• $group->hide_on_screen('metabox')
• $group->description('string')
• $group->order(0)
• $group->active(true) true or false

Location

Parameters

• Post
  • post_type
  • post_template
  • post_status
  • post_format
  • post_category
  • post_taxonomy
  • post
• Page
  • page_template
  • page_type
  • page_parent
  • page
• User
  • current_user
  • current_user_role
  • user_form
  • user_role
• Forms
  • taxonomy
  • attachment
  • comment
  • widget
  • nav_menu
  • nav_menu_item
  • options_page

Operator

== or !=

$group->location($param, $value); // operator is '==';
$group->location($param, $operator, $value);

A and B

$group->location(
    [$param, $operator, $value], // A
    [$param, $operator, $value]  // B
);

// another
$group->location($param, $operator, $value)  // A
    ->location($param, $operator, $value);   // B

A or B

$group->location($param, $operator, $value)   // A
    ->orLocation($param, $operator, $value);  // B

(A and B) or (C and D)

$group->location(
        [$param, $operator, $value],  // A
        [$param, $operator, $value]   // B
    )->orLocation(
        [$param, $operator, $value],  // C
        [$param, $operator, $value]   // D
    );

// another
$group->location($param, $operator, $value)  // A
    ->location($param, $operator, $value);   // B
    ->orLocation($param, $operator, $value)  // C
    ->location($param, $operator, $value);   // D

Renaming / Dropping Field Groups

To rename an existing field group, use the rename method:

Schema::rename($oldKey, $newKey);

To drop an existing field group, you may use the drop methods:

Schema::drop($groupKey);

Fields

Creating Fields

Schema::create($groupKey, function (FieldGroup $group) {
    $group->title('Demo'); // required
    $group->location('post_type', 'post'); // required
    $group->fields(function($field) {
        $field->text('uniqid_name')->label('Label');
    });
});

Available Field Types

// Basic
$field->text('text')->label('Text');
$field->textarea('textarea')->label('Textarea');
$field->number('number')->label('Number');
$field->email('email')->label('Email');
$field->url('url')->label('URL');
$field->password('password')->label('Password');

// Content
$field->wysiwyg('wysiwyg');
$field->oembed('oembed');
$field->image('image');
$field->file('file');
$field->gallery('gallery');

// Choice
$field->true_false('true_false');
$field->checkbox('checkbox')->choices(['value1', 'value2']);
$field->radio('radio')->choices(['value1', 'value2']);;
$field->select('select')->choices(['value1', 'value2']);;

// Relational
$field->link('link');
$field->page_link('page_link');
$field->post_object('post_object');
$field->relationship('relationship');
$field->taxonomy('taxonomy');
$field->user('user');

// JQuery
$field->google_map('google_map');
$field->date_picker('date_picker');
$field->date_time_picker('date_time_picker');
$field->time_picker('time_picker');
$field->color_picker('color_picker');

// Layout

$field->tab('tab');
$field->message('Message')->content('Content');

$field->group('group')->fields(function($field) {
    $field->text('text');
    $field->image('image');
});

$field->repeater('repeater')->fields(function($field) {
    $field->text('text')->label('Text');
    $field->image('image');
});

$field->flexible('flexible')->layouts(function($flexible) {
    $flexible->layout('layout1')->label('Layout 1')->fields(function($field) {
        $field->textarea('textarea')->label('Textarea');
    });
    $flexible->layout('layout2')->label('Layout 2')->fields(function($field) {
        $field->text('text')->label('Text');
    });
});

// friendly
$field->clone('clone')->fields('group');
$field->clone('clone')->fields('group.text');
$field->clone('clone')->fields('group.text', 'group.textarea');

// strict
$field->clone('clone')->fields('group_1b8797f52e1e7731');
$field->clone('clone')->fields('field_599ec2068e143');
$field->clone('clone')->fields('field_599ec2068e143', 'field_599ec6186b36b');

Modifying Fields

Updating Field Attributes

Schema::group($groupKey, function (FieldGroup $group) {
    $group->fields(function($field) {
        $field->text('text')->label('Text2');
    });
});

Renaming Fields

Schema::group($groupKey, function (FieldGroup $group) {
    $group->fields(function($field) {
        $field->rename('oldname', 'newname');
    });
});

Dropping Fields

Schema::group($groupKey, function (FieldGroup $group) {
    $group->fields(function($field) {
        // single field
        $field->drop('text');
        // multiple fields
        $field->drop('text', 'textarea');
        // all
        $field->dropAll();
    });
});

Models

use LumenPress\ACF\Concerns\HasFields;

class Post extends \LumenPress\Nimble\Models\Post
{
    use HasFields;
}

Inserts

$post = new Post;

$post->title = 'Title1';
$post->type = 'post';

$post->acf->schema('home_fields');

$post->acf->text = 'Text';
$post->acf->textarea = 'Textarea';

$post->save();

Updates

$post = Post::find(2);

$post->acf->text = 'Text2';
$post->acf->textarea = 'Textarea2';

$post->save();

Deletes

$post = Post::find(2);

unset($post->acf->text);
unset($post->acf->textarea);

$post->save();

Builders

$post = Post::find(2);
$builder = $post->acf();

Retrieving Results

$post->acf('abc')->value();
$post->acf()->text('abc')->value();

Inserting Values

$post->acf()->text('abc')->insertValue('Value 1');

Updating Values

$post->acf()->text('abc')->updateValue('Value 2');

Deleting Values

$post->acf('abc')->delete();
$post->acf()->text('abc')->delete();