PurePhpGoogleAdsCsvGenerator::closeFile() - Code Metrics - jdrda/pure-php-google-ads-csv-generator - Measure and Improve Code Quality continuously with Scrutinizer

PurePhpGoogleAdsCsvGenerator::closeFile() A
last analyzed 2019-12-05 18:47 UTC

↳ Parent: PurePhpGoogleAdsCsvGenerator

Complexity

Conditions	2
Paths	2

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	2
c	1
b	0
f	0
nc	2
nop	0
dl	0
loc	3
rs	10

<?php
/**
 * Main file
 *
 * All functions for XML writing
 *
 * @category Controller
 * @package PurePhpXmlWriter
 * @author Jan Drda <[email protected]>
 * @copyright Jan Drda
 * @license https://opensource.org/licenses/MIT MIT
 *
 */

namespace PurePhpGoogleAdsCsvGenerator;


class PurePhpGoogleAdsCsvGenerator
{

    /**
     * XML file pointer
     *
     * @var resource
     */
    private $_filePointer;

    /**
     * XML file name
     *
     * @var string
     */
    private $_fileName;

    /**
     * XML file header
     *
     * @var array
     */
    private $_fileHeader = array(
        'Campaign',
        'Campaign type',
        'Campaign Daily Budget',
        'Networks',
        'Ad Schedule',
        'Location',
        'Excluded Webs',
        'Ad Group',
        'Max CPC',
        'Max CPT',
        'Keyword',
        'Criterion Type',
        'Sitelink Text',
        'Headline',
        'Description Line 1',
        'Description Line 2',
        'Headline 1',
        'Headline 2',
        'Headline 3',
        'Description',
        'Display URL',
        'Final URL',
        'Path 1',
        'Path 2',
        'Tracking Template',
        'Campaign Status',
        'Ad Group Status',
        'Creative Status',
        'Topics',
        'Website',
        'Gender',
        'Age',
        'Website Status',
        'Audience',
        'Id',
        'Status',
        'Product Group',
        'Product Set Label',
        'PLA shop',
        'Country of Sale',
        'Languages',
        'Bid Strategy Type',
        'Promotion',
        'Approval Status',
        'Short headline',
        'Long headline',
        'Business name',
        'Final mobile URL',
        'Image',
        'Square Image',
        'Logo',
        'Landscape logo',
        'Impression tracking template',
        'Impression tracking template 2',
        'Ad name',
        'Type',
        'Desktop Bid Modifier',
        'Mobile Bid Modifier',
        'Tablet Bid Modifier',
        'TV Screen Bid Modifier'
    );

    /**
     * Age groups
     *
     * @var array
     */
    private $_ageGroups = array(
        'Unknown',
        '18-24',
        '25-34',
        '35-44',
        '45-54',
        '55-64',
        '65 or more'
    );

    /**
     * Genders
     *
     * @var array
     */
    private $_genders = array(
        'Unknown',
        'Male',
        'Female'
    );

    /**
     * Prototype of blank row
     *
     * @var array
     */
    private $_blankRow;

    /**
     * Setter for file name
     *
     * @param $filename
     */
    public function setFileName($filename){
        $this->_fileName = $filename;
    }

    /**
     * Getter for file name
     *
     * @return string
     */
    public function getFileName(){
        return $this->_fileName;
    }

    /**
     * Constructor
     *
     * @param string $fileName
     */
    public function __construct($fileName = null)
    {

        /**
         * Generate filename if needed
         */
        if($fileName === null){
            $this->setFileName('ads.csv');
        }
        else{
            $this->setFileName($fileName);
        }

        /**
         * Autoopen file if needed
         */
        $this->openFile();

        /**
         * Generate blank row prototype
         */
        $this->_blankRow = $this->_generateBlankRow();
    }

    /**
     * Destructor
     *
     * Explicitly close the file to make a sure buffer has been written
     */
    public function __destruct()
    {
        $this->closeFile();
    }

    /**
     * Open CSV file
     */
    public function openFile(){
        try {
            $this->_filePointer = fopen($this->_fileName, "w");
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        }
        catch (\Exception $e){
            die('File cannot be opened: ' . $e->getMessage());

        }

        /**
         * Add header
         */
        $this->_writeRawRow($this->_fileHeader);
    }

    /**
     * Close CSV file if is opened
     */
    public function closeFile(){
        if(is_resource($this->_filePointer) === true){
            fclose($this->_filePointer);
        }
    }

    /**
     * Write Raw SV row
     */
    private function _writeRawRow($array, $delimiter = "\t", $enclosure = null){
        if($enclosure == null){
            $enclosure = chr(0);
        }
        fputcsv($this->_filePointer, $array, $delimiter, $enclosure);
    }

    /**
     * Generate prototype of blank row
     *
     * @return array
     */
    private function _generateBlankRow(){

        $blankRow = array();
        foreach ($this->_fileHeader as $value){

            $blankRow[strtolower(str_replace(' ', '-', $value))] = '';
        }

        return $blankRow;
    }

    /**
     * Prepare row for write
     *
     * @param $array
     * @return array
     */
    private function _prepareRow($array){
       return array_merge($this->_blankRow, $array);
    }

    /**
     * Prepare and write row
     *
     * @param $array
     */
    private function _writeRow($array, $delimiter = "\t", $enclosure = null){
        $this->_writeRawRow($this->_prepareRow($array), $delimiter, $enclosure);
    }

    /**
     * Write campaign data
     * @param array $config
     */
    public function writeCampaign( $data = array (
        'campaign' => 'Campaign',
        'campaign-type' => 'Search',
        'campaign-daily-budget' => '100.00',
        'networks' => 'Search;Google Search;Search Partners',
        'campaign-status' => 'active'
    )){

        $this->_writeRow($data);
    }

    /**
     * Write Ad group
     *
     * @param array $data
     */
    public function writeAdGroup( $data = array (
        'campaign' => 'Campaign',
        'ad-group' => 'Ad Group',
        'max-cpc' => '1',
        'max-cpt' => '1',
        'ad-group-status' => 'Active'
    ))
    {

        $this->_writeRow($data);
    }

    /**
     * Write keyword
     *
     * @param array $data
     */
    public function writeKeyword( $data = array (
        'campaign' => 'Campaign',
        'ad-group' => 'Ad Group',
        'keyword' => 'Keyword',
        'criterion-type' => 'Phrase',
        'status' => 'Active',
    ))
    {

        $this->_writeRow($data);
    }

    /**
     * Write ad
     *
     * @param array $data
     */
    public function writeAd( $data = array (
        'campaign' => 'Campaign',
        'ad-group' => 'Ad Group',
        'description-line-1' => 'Description line 1',
        'description-line-2' => 'Description line 2',
        'headline-1' => 'Headline 1',
        'headline-2' => 'Headline 2',
        'headline-3' => 'Headline 3',
        'final-url' => 'https://www.final.com/',
        'status' => 'Active',
    ))
    {

        $this->_writeRow($data);
    }

    /**
     * Write age
     *
     * @param array $data
     */
    public function writeAge( $data = array (
        'campaign' => 'Campaign',
        'ad-group' => 'Ad Group',
        'age' => 'Unknown',
        'status' => 'Active',
    ))
    {

        $this->_writeRow($data);
    }

    /**
     * Write age
     *
     * @param array $data
     */
    public function writeGender( $data = array (
        'campaign' => 'Campaign',
        'ad-group' => 'Ad Group',
        'gender' => 'Unknown',
        'status' => 'Active',
    ))
    {

        $this->_writeRow($data);
    }

    /**
     * Write all age groups
     *
     * @param array $data
     */
    public function writeAllAges( $data = array (
        'campaign' => 'Campaign',
        'ad-group' => 'Ad Group',
        'status' => 'Active',
    ))
    {
        foreach ($this->_ageGroups as $ageGroup) {
            $data['age'] = $ageGroup;
            $this->_writeRow($data);
        }
    }

    /**
     * Write all genders
     *
     * @param array $data
     */
    public function writeAllGenders( $data = array (
        'campaign' => 'Campaign',
        'ad-group' => 'Ad Group',
        'status' => 'Active',
    ))
    {
        foreach ($this->_genders as $gender) {
            $data['gender'] = $gender;
            $this->_writeRow($data);
        }
    }
}

1			<?php
2			/**
3			* Main file
4			*
5			* All functions for XML writing
6			*
7			* @category Controller
8			* @package PurePhpXmlWriter
9			* @author Jan Drda <[email protected]>
10			* @copyright Jan Drda
11			* @license https://opensource.org/licenses/MIT MIT
12			*
13			*/
14
15			namespace PurePhpGoogleAdsCsvGenerator;
16
17
18			class PurePhpGoogleAdsCsvGenerator
19			{
20
21			/**
22			* XML file pointer
23			*
24			* @var resource
25			*/
26			private $_filePointer;
27
28			/**
29			* XML file name
30			*
31			* @var string
32			*/
33			private $_fileName;
34
35			/**
36			* XML file header
37			*
38			* @var array
39			*/
40			private $_fileHeader = array(
41			'Campaign',
42			'Campaign type',
43			'Campaign Daily Budget',
44			'Networks',
45			'Ad Schedule',
46			'Location',
47			'Excluded Webs',
48			'Ad Group',
49			'Max CPC',
50			'Max CPT',
51			'Keyword',
52			'Criterion Type',
53			'Sitelink Text',
54			'Headline',
55			'Description Line 1',
56			'Description Line 2',
57			'Headline 1',
58			'Headline 2',
59			'Headline 3',
60			'Description',
61			'Display URL',
62			'Final URL',
63			'Path 1',
64			'Path 2',
65			'Tracking Template',
66			'Campaign Status',
67			'Ad Group Status',
68			'Creative Status',
69			'Topics',
70			'Website',
71			'Gender',
72			'Age',
73			'Website Status',
74			'Audience',
75			'Id',
76			'Status',
77			'Product Group',
78			'Product Set Label',
79			'PLA shop',
80			'Country of Sale',
81			'Languages',
82			'Bid Strategy Type',
83			'Promotion',
84			'Approval Status',
85			'Short headline',
86			'Long headline',
87			'Business name',
88			'Final mobile URL',
89			'Image',
90			'Square Image',
91			'Logo',
92			'Landscape logo',
93			'Impression tracking template',
94			'Impression tracking template 2',
95			'Ad name',
96			'Type',
97			'Desktop Bid Modifier',
98			'Mobile Bid Modifier',
99			'Tablet Bid Modifier',
100			'TV Screen Bid Modifier'
101			);
102
103			/**
104			* Age groups
105			*
106			* @var array
107			*/
108			private $_ageGroups = array(
109			'Unknown',
110			'18-24',
111			'25-34',
112			'35-44',
113			'45-54',
114			'55-64',
115			'65 or more'
116			);
117
118			/**
119			* Genders
120			*
121			* @var array
122			*/
123			private $_genders = array(
124			'Unknown',
125			'Male',
126			'Female'
127			);
128
129			/**
130			* Prototype of blank row
131			*
132			* @var array
133			*/
134			private $_blankRow;
135
136			/**
137			* Setter for file name
138			*
139			* @param $filename
140			*/
141			public function setFileName($filename){
142			$this->_fileName = $filename;
143			}
144
145			/**
146			* Getter for file name
147			*
148			* @return string
149			*/
150			public function getFileName(){
151			return $this->_fileName;
152			}
153
154			/**
155			* Constructor
156			*
157			* @param string $fileName
158			*/
159			public function __construct($fileName = null)
160			{
161
162			/**
163			* Generate filename if needed
164			*/
165			if($fileName === null){
166			$this->setFileName('ads.csv');
167			}
168			else{
169			$this->setFileName($fileName);
170			}
171
172			/**
173			* Autoopen file if needed
174			*/
175			$this->openFile();
176
177			/**
178			* Generate blank row prototype
179			*/
180			$this->_blankRow = $this->_generateBlankRow();
181			}
182
183			/**
184			* Destructor
185			*
186			* Explicitly close the file to make a sure buffer has been written
187			*/
188			public function __destruct()
189			{
190			$this->closeFile();
191			}
192
193			/**
194			* Open CSV file
195			*/
196			public function openFile(){
197			try {
198			$this->_filePointer = fopen($this->_fileName, "w");
			0 ignored issues – show Documentation Bug introduced 2019-12-05 18:47 UTC by Report Bug Copy Issue Report It seems like `fopen($this->_fileName, 'w')` can also be of type `false`. However, the property `$_filePointer` is declared as type `resource`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
199			}
200			catch (\Exception $e){
201			die('File cannot be opened: ' . $e->getMessage());
			0 ignored issues – show Best Practice introduced 2019-12-05 18:47 UTC by Report Bug Copy Issue Report Using `exit` here is not recommended. In general, usage of exit should be done with care and only when running in a scripting context like a CLI script. Loading history...
202			}
203
204			/**
205			* Add header
206			*/
207			$this->_writeRawRow($this->_fileHeader);
208			}
209
210			/**
211			* Close CSV file if is opened
212			*/
213			public function closeFile(){
214			if(is_resource($this->_filePointer) === true){
215			fclose($this->_filePointer);
216			}
217			}
218
219			/**
220			* Write Raw SV row
221			*/
222			private function _writeRawRow($array, $delimiter = "\t", $enclosure = null){
223			if($enclosure == null){
224			$enclosure = chr(0);
225			}
226			fputcsv($this->_filePointer, $array, $delimiter, $enclosure);
227			}
228
229			/**
230			* Generate prototype of blank row
231			*
232			* @return array
233			*/
234			private function _generateBlankRow(){
235
236			$blankRow = array();
237			foreach ($this->_fileHeader as $value){
238
239			$blankRow[strtolower(str_replace(' ', '-', $value))] = '';
240			}
241
242			return $blankRow;
243			}
244
245			/**
246			* Prepare row for write
247			*
248			* @param $array
249			* @return array
250			*/
251			private function _prepareRow($array){
252			return array_merge($this->_blankRow, $array);
253			}
254
255			/**
256			* Prepare and write row
257			*
258			* @param $array
259			*/
260			private function _writeRow($array, $delimiter = "\t", $enclosure = null){
261			$this->_writeRawRow($this->_prepareRow($array), $delimiter, $enclosure);
262			}
263
264			/**
265			* Write campaign data
266			* @param array $config
267			*/
268			public function writeCampaign( $data = array (
269			'campaign' => 'Campaign',
270			'campaign-type' => 'Search',
271			'campaign-daily-budget' => '100.00',
272			'networks' => 'Search;Google Search;Search Partners',
273			'campaign-status' => 'active'
274			)){
275
276			$this->_writeRow($data);
277			}
278
279			/**
280			* Write Ad group
281			*
282			* @param array $data
283			*/
284			public function writeAdGroup( $data = array (
285			'campaign' => 'Campaign',
286			'ad-group' => 'Ad Group',
287			'max-cpc' => '1',
288			'max-cpt' => '1',
289			'ad-group-status' => 'Active'
290			))
291			{
292
293			$this->_writeRow($data);
294			}
295
296			/**
297			* Write keyword
298			*
299			* @param array $data
300			*/
301			public function writeKeyword( $data = array (
302			'campaign' => 'Campaign',
303			'ad-group' => 'Ad Group',
304			'keyword' => 'Keyword',
305			'criterion-type' => 'Phrase',
306			'status' => 'Active',
307			))
308			{
309
310			$this->_writeRow($data);
311			}
312
313			/**
314			* Write ad
315			*
316			* @param array $data
317			*/
318			public function writeAd( $data = array (
319			'campaign' => 'Campaign',
320			'ad-group' => 'Ad Group',
321			'description-line-1' => 'Description line 1',
322			'description-line-2' => 'Description line 2',
323			'headline-1' => 'Headline 1',
324			'headline-2' => 'Headline 2',
325			'headline-3' => 'Headline 3',
326			'final-url' => 'https://www.final.com/',
327			'status' => 'Active',
328			))
329			{
330
331			$this->_writeRow($data);
332			}
333
334			/**
335			* Write age
336			*
337			* @param array $data
338			*/
339			public function writeAge( $data = array (
340			'campaign' => 'Campaign',
341			'ad-group' => 'Ad Group',
342			'age' => 'Unknown',
343			'status' => 'Active',
344			))
345			{
346
347			$this->_writeRow($data);
348			}
349
350			/**
351			* Write age
352			*
353			* @param array $data
354			*/
355			public function writeGender( $data = array (
356			'campaign' => 'Campaign',
357			'ad-group' => 'Ad Group',
358			'gender' => 'Unknown',
359			'status' => 'Active',
360			))
361			{
362
363			$this->_writeRow($data);
364			}
365
366			/**
367			* Write all age groups
368			*
369			* @param array $data
370			*/
371			public function writeAllAges( $data = array (
372			'campaign' => 'Campaign',
373			'ad-group' => 'Ad Group',
374			'status' => 'Active',
375			))
376			{
377			foreach ($this->_ageGroups as $ageGroup) {
378			$data['age'] = $ageGroup;
379			$this->_writeRow($data);
380			}
381			}
382
383			/**
384			* Write all genders
385			*
386			* @param array $data
387			*/
388			public function writeAllGenders( $data = array (
389			'campaign' => 'Campaign',
390			'ad-group' => 'Ad Group',
391			'status' => 'Active',
392			))
393			{
394			foreach ($this->_genders as $gender) {
395			$data['gender'] = $gender;
396			$this->_writeRow($data);
397			}
398			}
399			}

jdrda / pure-php-google-ads-csv-generator

PurePhpGoogleAdsCsvGenerator::closeFile() A last analyzed 2019-12-05 18:47 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

PurePhpGoogleAdsCsvGenerator::closeFile() A
last analyzed 2019-12-05 18:47 UTC