Download the PHP package esign/laravel-linkable without Composer

On this page you can find all versions of the php package esign/laravel-linkable. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of esign/laravel-linkable

Informations about the package laravel-linkable

Dynamically link Laravel models

Latest Version on Packagist Total Downloads GitHub Actions

This package allows you to add a dynamic link to a Laravel model. This dynamic link may be a reference to another model or could also be an external URL. In essence, this package is just a Laravel relationship with some extra utility methods.

Installation

You can install the package via composer:

Usage

Preparing your model

To make a model have a dynamic link you may add the HasDynamicLink trait.

Your database structure should look like the following:

Internal links

In case you set the dynamic_link_type as internal the dynamic_link_linkable_model field will be used. In order to know where a internal dynamic link should direct to you may implement LinkableUrlContract on the related model:

External links

In case you set the dynamic_link_type as external the dynamic_link_url field will be used. The value of this field should be a valid URL, e.g. https://www.example.com.

Storing linkables

Instead of using a regular MorphTo relation, this package ships with a SingleColumnMorphTo relation. Some CMS, including our own, do not allow for morphable relations based on two columns, e.g. dynamic_link_linkable_type and dynamic_link_linkable_id. The SingleColumnMorphTo combines both the type and id fields into a single column, e.g. dynamic_link_linkable_model. The value for this single column is stored in the {model}:{id} format, e.g. post:1. You're able to use both a fully qualified class name or a value from your application's morph map, just like a regular morphTo relation.

Note This approach is not ideal and more complex queries using this relationship may not work as expected. In case you're able to you may overwrite the dynamicLinkLinkable relation to use Laravel's default MorphTo relationship.

Linkables overview

To create an overview of all possible linkables you can create a MySQL view that creates a union of all possible models that can be linked to:

This would create the following output: id linkable_type linkable_id label
post:1 post 1 My First Post
comment:1 comment 1 My First Comment

Rendering dynamic links

This package ships with a view component that will help you render both internal and external links:

The view component will render an <a> tag, when a model of the type external is given, the target="_blank" and rel="noopener" attributes will be applied.

Extending this package

Creating your own dynamic link types

This Laravel package offers built-in support for external links by default. However, in certain scenarios, you might want to introduce custom link types, such as referencing an anchor tag. To achieve this, you can extend the package's functionality.

  1. Extend the HasDynamicLink Trait

  2. Create Your Own View Component

Next, you need to create your own view component that extends the DynamicLink component provided by the package. Here's how you can do that:

  1. Use Your Custom View Component

With your custom view component in place, you can now use it in your Blade templates instead of the one provided by the package:

Testing

License

The MIT License (MIT). Please see License File for more information.

All versions of laravel-linkable with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
illuminate/database Version ^8.0|^9.0|^10.0|^11.0
illuminate/support Version ^8.0|^9.0|^10.0|^11.0
illuminate/view Version ^8.0|^9.0|^10.0|^11.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package esign/laravel-linkable contains the following files

Loading the files please wait ....