codeblog/feedrss-generate

Generate an Rss Feed of the website content

1.0.0 2021-01-29 16:53 UTC

Requires

• php: >=7.2
• ext-dom: *
• ext-json: *
• ext-mbstring: *

MIT

• Whallysson Avelino

• feed
• rss
• Google Merchant
• CodeBlog
• FeedRss
• Facebook ADS

README

FeedRss is a simple component that helps in creating rss feeds, where it generates an xml file for the engines. The same can also be used for Facebook Ads and Google Merchant.

FeedRss é um componente simples que auxilia na criação de feeds rss, onde gera um arquivo xml para os mecanismos. O mesmo também pode ser usado para Facebook Ads e Google Merchant.

Highlights

• Simple installation (Instalação simples)
• Simplified rss feed creation (Criação de feed rss simplificada)
• Can be used with Facebook ADS (Pode ser usada com o Facebook ADS)
• Can be used with Google Merchant (Pode ser usada com o Google Merchant)

Installation

FeedRss is available via Composer:

"codeblog/feedrss-generate": "^1.0"

or run

composer require codeblog/feedrss-generate

Documentation

For details on how to use, see a sample folder in the component directory. In it you will have an example of use for each class. It works like this:

Para mais detalhes sobre como usar, veja uma pasta de exemplo no diretório do componente. Nela terá um exemplo de uso para cada classe. Ele funciona assim:

Create FeedRss simple:

<?php

require 'vendor/autoload.php';

use CodeBlog\FeedRss\FeedRss;

$feed = new FeedRss();
$feed->setChannel(
    'CodeBlog - Fique sempre atualizado',
    'https://www.codeblog.com.br/',
    'Blog desenvolvido para passar informações sobre Tecnologia, Games, Programação e Entreterimento!'
);

$items = [
    [
        'title' => 'Mouse Gamer de última geração',
        'description' => 'Mouse Gamer de última geração',
        'publication' => '2020-12-31 23:10:21',
        'link' => 'https://meusite.com/prouto/mouse-top',
        'image' => [
            'url' => 'https://www.codeblog.com.br/themes/codeblog/assets/images/CodeBlogLogo.png',
            'title' => 'Mouse gamer de última geração com alta qualidade'
        ]
    ],
    [
        'title' => 'Teclado Gamer de última geração',
        'description' => 'Teclado Gamer de última geração',
        'publication' => '2020-12-27 13:10:00',
        'link' => 'https://meusite.com/prouto/teclado-top',
        'image' => [
            'url' => 'https://www.codeblog.com.br/themes/codeblog/assets/images/CodeBlogLogo.png',
            'title' => 'Teclado gamer mecânico de última geração'
        ]
    ]
];

$feed->renderRss($items);

Create FeedRss with Facebook Ads and Google Merchant:

You must pass the parameters "facebook_ads" and "google_merchant" as an array each.

Você deve passar os parametros "facebook_ads" e "google_merchant" como um array cada.

<?php

require 'vendor/autoload.php';

use CodeBlog\FeedRss\FeedRss;

$feed = new FeedRss(true, true);
$feed->setChannel(
    'CodeBlog - Fique sempre atualizado',
    'https://www.codeblog.com.br/',
    'Blog desenvolvido para passar informações sobre Tecnologia, Games, Programação e Entreterimento!'
);

$items = [
    [
        'title' => 'Mouse Gamer de última geração',
        'description' => 'Mouse Gamer de última geração',
        'publication' => '2020-12-31 23:10:59',
        'link' => 'https://meusite.com/prouto/mouse-top',
        'image' => [
            'url' => 'https://www.codeblog.com.br/themes/codeblog/assets/images/CodeBlogLogo.png',
            'title' => 'Mouse gamer de última geração com alta qualidade'
        ],

        // FACEBOOK ADS
        'facebook_ads' => [
            'id' => 'product_01',
            'image_link' => 'https://www.codeblog.com.br/themes/codeblog/assets/images/CodeBlogLogo.png',
            'condition' => 'new',
            'price' => '89.89',
            'availability' => 'in stock',
            'brand' => 'Gapto',
            'google_product_category' => '166',
            // other necessary parameters
        ],

        // GOOGLE MERCHANT
        'google_merchant' => [
            'gtin' => '3234567890126',
            // other necessary parameters
        ]
    ],

    [
        'title' => 'Teclado Gamer de última geração',
        'description' => 'Teclado Gamer de última geração',
        'publication' => '2020-12-27 13:10:00',
        'link' => 'https://meusite.com/prouto/teclado-top',
        'image' => [
            'url' => 'https://www.codeblog.com.br/themes/codeblog/assets/images/CodeBlogLogo.png',
            'title' => 'Teclado gamer mecânico de última geração'
        ],

        // FACEBOOK ADS
        'facebook_ads' => [
            'id' => 'product_02',
            'image_link' => 'https://www.codeblog.com.br/themes/codeblog/assets/images/CodeBlogLogo.png',
            'condition' => 'new',
            'price' => '154.35',
            'availability' => 'in stock',
            'brand' => 'Full Moll',
            'google_product_category' => '166',
            // other necessary parameters
        ],

        // GOOGLE MERCHANT
        'google_merchant' => [
            'gtin' => '3234567890888',
            // other necessary parameters
        ],
    ],
];

$feed->renderRss($items);

Contributing

Please see CONTRIBUTING for details.

Support

Security: If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Se você descobrir algum problema relacionado à segurança, envie um e-mail para [e-mail] em vez de usar o rastreador de problemas.

Thank you

Credits

• Whallysson Avelino (Developer)
• CodBlog (Team)
• All Contributors (This Rock)

License

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