Download the PHP package govtnz/silverstripe-externallinks without Composer

On this page you can find all versions of the php package govtnz/silverstripe-externallinks. 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?

Informations about the package silverstripe-externallinks

External links

Introduction

Core module

The external links module is a task and ModelAdmin to track and to report on broken external links. It is maintained by Kirk Mayo at Silverstripe.

This fork

This is a fork which removes a core piece of the module's functionality. With this fork installed, the module will no longer write the ss-broken css class to broken URLs. The reason for this change is that saving the modified record to the database changes the publication date of versioned content, pushing it back to the top of RSS feeds and Recently Edited Pages.

The new config.yml file contains a boolean value that can be used to turn the "add class" functionality on and off.

Apart from the Maintainer contact in the next section, the remainder of this README is the original document by Kirk Mayo.

Maintainer Contact

* Leigh Harrison: leigh (dot) harrison (at) dia (dot) govt (dot) nz

Requirements

* SilverStripe 3.1 +

Features

Installation

  1. If you have composer you can use composer require silverstripe/externallinks:*. Otherwise, download the module from GitHub and extract to the 'externallinks' folder. Place this directory in your sites root directory. This is the one with framework and cms in it.
  2. Run in your browser - /dev/build to rebuild the database.
  3. Run the following task http://path.to.silverstripe/dev/tasks/CheckExternalLinks to check for broken external links

Report

A new report is added called 'External Broken links report'. When viewing this report, a user may press the "Create new report" button which will trigger an ajax request to initiate a report run.

In this initial ajax request this module will do one of two things, depending on which modules are included:

In either case, the background task will loop over every page in the system, inspecting all external urls and checking the status code returned by requesting each one. If a URL returns a response code that is considered "broken" (defined as < 200 or > 302) then the ss-broken css class will be assigned to that url, and a line item will be added to the report. If a previously broken link has been corrected or fixed, then this class is removed.

In the actual report generated the user can click on any broken link item to either view the link in their browser, or edit the containing page in the CMS.

While a report is running the current status of this report will be displayed on the report details page, along with the status. The user may leave this page and return to it later to view the ongoing status of this report.

Any subsequent report may not be generated until a prior report has completed.

Dev task

Run the following task http://path.to.silverstripe/dev/tasks/CheckExternalLinks to check your site for external broken links.

Queued job

If you have the queuedjobs module installed you can set the task to be run every so ofter Add the following yml config to config.yml in mysite/_config have the the task run once every day (86400 seconds)

CheckExternalLinks:
  Delay: 86400

Whitelisting codes

If you want to ignore or whitelist certain http codes this can be setup via IgnoreCodes in the config.yml file in mysite/_config

CheckExternalLinks:
  Delay: 60
  IgnoreCodes:
    - 401
    - 403
    - 501

All versions of silverstripe-externallinks with dependencies

PHP Build Version
Package Version
Requires silverstripe/framework Version ~3.1
silverstripe/cms Version ~3.1
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 govtnz/silverstripe-externallinks contains the following files

Loading the files please wait ....