islamdb/orchid-helper

Helper for orchid platform

Maintainers

Details

github.com/islamdb/orchid-helper

Source

Issues

Installs: 319

Dependents: 1

Suggesters: 0

Security: 0

Stars: 7

Watchers: 1

Forks: 1

Open Issues: 0

dev-master 2022-06-02 07:41 UTC

Requires

MIT 9acbb06d49d52f2d38d6795e0d79e1bcee71e749

  • islamdb <islamdbrnd.woop@gmail.com>

helperorchid

This package is auto-updated.

Last update: 2024-03-30 00:30:53 UTC

README

Orchid Helper has class and traits that will help you a lot in development

Installation

The manual assumes that you already have a copy of Laravel with Orchid

You can install the package using the Сomposer. Run this at the command line:

composer require islamdb/orchid-helper

This will update composer.json and install the package into the vendor/ directory.

Traits

ResourceDefaultAllowedSortsAndFilters

This trait will make the $allowedSorts and $allowedFilters filled. Depand on $fillable in your Model

Usage

use IslamDB\OrchidHelper\Resource\Traits\ResourceDefaultAllowedSortsAndFilters;

class YourModel extends Model
{
    use ResourceDefaultAllowedSortsAndFilters;
    
    ...
}

ResourceDefaultFilter

This trait will make default sorted in your resource

Usage

use IslamDB\OrchidHelper\Resource\Traits\ResourceDefaultFilter;

class YourResource extends Resource
{
    use ResourceDefaultFilter;
    
    ...
}

You can change $defaultSortedColumn and $defaultSortedOrder in construct

ResourceDefaultLabel

This trait will change the default label of your Resource name

Usage

use IslamDB\OrchidHelper\Resource\Traits\ResourceDefaultLabel;

class YourResource extends Resource
{
    use ResourceDefaultLabel;
    
    ...
}

This will change from "Your Resource" to "Your". But you can change static $labelToReplace value in construct

ResourceDefaultSortingByFilename

This trait will sort your resources by filename

Usage

use IslamDB\OrchidHelper\Resource\Traits\ResourceDefaultSortingByFilename;

class YourResource extends Resource
{
    use ResourceDefaultSortingByFilename;
    
    ...
}

ResourceDeleteAction

This trait will give default delete action

Usage

use IslamDB\OrchidHelper\Resource\Traits\ResourceDeleteAction;

class YourResource extends Resource
{
    use ResourceDeleteAction;
    
    ...
}

ResourceOnSave

This trait will help you to save your attachment and sluggable in resource

Usage

use IslamDB\OrchidHelper\Resource\Traits\ResourceOnSave;

class PostResource extends Resource
{
    use ResourceOnSave;
    
    public function onSave(ResourceRequest $request, Model $model)
    {
        $this->sluggable($request);

        $this->saveWithAttachment($request, $model);
    }
    
    ...
}

ResourceDefault

All traits before are in this trait

Usage

use IslamDB\OrchidHelper\Resource\Traits\ResourceDefault;

class YourResource extends Resource
{
    use ResourceDefault;
    
    ...
}

Field

This class is used by Orchid Setting package. You can visit islamdb/orchid-setting

Input Types

Field::INPUT_EMAIL // 'email'
Field::INPUT_FILE // 'file'
Field::INPUT_HIDDEN // 'hidden'
Field::INPUT_MONTH // 'month'
Field::INPUT_NUMBER // 'number'
Field::INPUT_PASSWORD // 'password'
Field::INPUT_RADIO // 'radio'
Field::INPUT_RANGE // 'range'
Field::INPUT_SEARCH // 'search'
Field::INPUT_TEL // 'tel'
Field::INPUT_TEXT // 'text'
Field::INPUT_TIME // 'time'
Field::INPUT_URL // 'url'
Field::INPUT_WEEK // 'week'

Required Methods

\IslamDB\OrchidHelper\Field::REQUIRED_METHODS

Value

[
    RadioButtons::class => [
        'options' => "['one' => 'One', 'two' => 'Two', 'three' => 'Three']"
    ], Range::class => [
        'min' => "1",
        'max' => "100",
        'step' => "1"
    ], Select::class => [
        'options' => "['one' => 'One', 'two' => 'Two', 'three' => 'Three']"
    ], Picture::class => [
        'targetId' => ''
    ]
]

With Meta

Returne meta fields with Field params

// function
public static function withMeta(array $fields)

// usage
\IslamDB\OrchidHelper\Field::withMeta([
    View::make('group'),
    View::make('slug'),
    Input::make('title'),
    View::make('body'),
    View::dateTime('published_at'),
    View::dateTime('expired_at')
])

Check File Field

Check wether type is file field or not

// function
public static function isFileField($type)

// usage
\IslamDB\OrchidHelper\Field::isFileField(\Orchid\Screen\Fields\Input::class) // false

Get All Fields

Get all available orchid fields

// function
public static function all(bool $withMethods = true, $typeClass = null)

// usage
\IslamDB\OrchidHelper\Field::all()

Find Field

Find field by class name and return methods etc

// function
public static function find($type, bool $withMethods = true)

// usage
\IslamDB\OrchidHelper\Field::find(\Orchid\Screen\Fields\Matrix::class)

Generate Field

Generate field by class name with options (Orchid Setting)

public static function make($type, string $name = 'value', array $options = [])

Column

Usage

use IslamDB\OrchidHelper\Column;

Make

This function will help you to make column with default title, sorting and filter

public static function make($name, $title = null, bool $sorting = true, $filter = TD::FILTER_TEXT)

Example

Column::make('full_name')

Output

(column with "Full Name" column name and filter)

URL

Use this function to generate url table column

public static function url(string $name, string $title = null, $target = '_blank')

Example

Column::url('social_media_url', null, null)
Column::url('social_media_url', null, '_blank')

Output

1. (clickable and go to address in current tab)
2. (clickable and go to address in new tab)

HTML

This function will help you to print html

public static function html(string $name, string $title = null)

Example

Column::html('body')

Output

Bold Text

<b><i>Bold Text</i></b>

Relation

This function will help you to print out the relation fields

public static function relation(string $name, string $title = null, $columns = 'name', string $glue = ', ', string $glueColumn = ' ')

Example

Assume that you want to get users with their roles and roles are (super admin and administrator)

Column::relation('roles', null, ['name', 'slug'], ', ', ' - ')

Output

Super Admin - super-admin, Administrator - administrator

Boolean

This function will help you to print out the boolean value

public static function boolean($name, $title = null, array $labels = null)

Example

Column::boolean('enabled', 'Is Active', [true => 'Yes', false => 'No'])

Output

Yes/No (depand on your value)

Date Time

This function will help you to print out datetime/timestamp

public static function dateTime($name, $title = null, string $locale = 'id', $withTime = true, $withDayName = true)

Example

Column::dateTime('updated_at', 'Last Edit', 'en', true, true)

Output

Tuesday, August 31st 2021, 09:05:38 (depand on your value)

Money/Numeric

This function will help you to print numeric/money value

public static function money($name, $title = null, $decimals = 2, $zeroTrail = true, $decimalSeparator = '.', $thousandSeparator = ',')

Example

1. Column::make('total', null, 4, true)
2. Column::make('total', null, 4, false)

Output

1. 250,000.23
2. 250,000.2300

Shortcut

This function will help you to view/edit resource

public static function shortcut($name, $title = null, string $route = 'platform.resource.view', int $deep = 2)

Example

1. Column::shortcut('name', null, 'platform.resource.view')
2. Column::shortcut('name', null, 'platform.resource.edit')

Output

1. (clickable, and go to view page)
2. (clickable, and go to edit page)

View

Usage

use IslamDB\OrchidHelper\View;

Make

This function will help you to make sight with default title

public static function make(string $name, string $title = null)

Example

View::make('full_name')

Output

(view with "Full Name")

URL

Use this function to generate url in view page

public static function url(string $name, string $title = null, string $target = '_blank')

Example

1. View::url('social_media_url', null, null)
2. View::url('social_media_url', null, '_blank')

Output

1. (clickable and go to address in current tab)
2. (clickable and go to address in new tab)

HTML

This function will help you to print html

public static function html(string $name, string $title = null)

Example

View::html('body')

Output

Bold Text

<b><i>Bold Text</i></b>

Relation

This function will help you to print out the relation fields

public static function relation(string $name, string $title = null, $columns = 'name', string $glue = ', ', string $glueColumn = ' ')

Example

View::relation('roles', null, ['name', 'slug'], ', ', ' - ')

Output

Super Admin - super-admin, Administrator - administrator

Boolean

This function will help you to print out the boolean value

public static function boolean($name, $title = null, array $labels = null)

Example

View::boolean('enabled', 'Is Active', [true => 'Yes', false => 'No'])

Output

Yes/No (depand on your value)

Date Time

This function will help you to print out datetime/timestamp

public static function dateTime($name, $title = null, string $locale = 'id', $withTime = true, $withDayName = true)

Example

View::dateTime('updated_at', 'Last Edit', 'en', true, true)

Output

Tuesday, August 31st 2021, 09:05:38 (depand on your value)

Money/Numeric

This function will help you to print numeric/money value

public static function money($name, $title = null, int $decimals = 2, bool $zeroTrail = true, string $decimalSeparator = '.', string $thousandSeparator = ',')

Example

Assume total = 250000.23

1. View::make('total', null, 4, true)
2. View::make('total', null, 4, false)

Output

1. 250,000.23
2. 250,000.2300

Meta View

Return meta sights

public static function meta(): array
{
    return [
        static::make('meta_title'),
        static::make('meta_keywords'),
        static::make('meta_description')
    ];
}

Timestamps View

Return timestamp sights

public static function timestamps(): array
{
    return [
        static::dateTime('created_at'),
        static::dateTime('updated_at')
    ];
}

With Meta View

Return meta sights with array sight params

public static function withMeta(array $views): array
{
    return array_merge($views, static::meta());
}

With Timestamps

Return timestamp sights with array sight params

public static function withTimestamps(array $views): array
{
    return array_merge($views, static::timestamps());
}

With Meta & Timestamps

Return meta timestamp sights with array sight params

public static function withMetaAndTimestamps(array $view): array
{
    return array_merge($view, static::meta(), static::timestamps());
}